ShuriZma
/
pokerogue
mirror of https://github.com/pagefaultgames/pokerogue.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
pokerogue/main/classes/game_mode.GameMode.html

60 lines
52 KiB
HTML
Raw Normal View History

[skip ci] Deploy docs
2024-06-07 21:53:00 +00:00
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>GameMode | pokemon-rogue-battle</title><meta name="description" content="Documentation for pokemon-rogue-battle"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">pokemon-rogue-battle</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">pokemon-rogue-battle</a></li><li><a href="../modules/game_mode.html">game-mode</a></li><li><a href="game_mode.GameMode.html">GameMode</a></li></ul><h1>Class GameMode</h1></div><section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">GameModeConfig</span></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/ece7c9f2d553cc20278bd1f54402eb70b818d0f2/src/game-mode.ts#L30">src/game-mode.ts:30</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="game_mode.GameMode.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
[skip ci] Deploy docs
2024-05-31 13:57:14 +00:00
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="game_mode.GameMode.html#hasFixedBattles" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>has<wbr/>Fixed<wbr/>Battles</span></a>
<a href="game_mode.GameMode.html#hasNoShop" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>has<wbr/>No<wbr/>Shop</span></a>
<a href="game_mode.GameMode.html#hasRandomBiomes" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>has<wbr/>Random<wbr/>Biomes</span></a>
<a href="game_mode.GameMode.html#hasRandomBosses" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>has<wbr/>Random<wbr/>Bosses</span></a>
<a href="game_mode.GameMode.html#hasShortBiomes" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>has<wbr/>Short<wbr/>Biomes</span></a>
<a href="game_mode.GameMode.html#hasTrainers" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>has<wbr/>Trainers</span></a>
<a href="game_mode.GameMode.html#isClassic" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Classic</span></a>
<a href="game_mode.GameMode.html#isDaily" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Daily</span></a>
<a href="game_mode.GameMode.html#isEndless" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Endless</span></a>
<a href="game_mode.GameMode.html#isSplicedOnly" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Spliced<wbr/>Only</span></a>
<a href="game_mode.GameMode.html#modeId" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>mode<wbr/>Id</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="game_mode.GameMode.html#getClearScoreBonus" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Clear<wbr/>Score<wbr/>Bonus</span></a>
<a href="game_mode.GameMode.html#getEnemyModifierChance" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Enemy<wbr/>Modifier<wbr/>Chance</span></a>
<a href="game_mode.GameMode.html#getName" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Name</span></a>
<a href="game_mode.GameMode.html#getOverrideSpecies" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Override<wbr/>Species</span></a>
<a href="game_mode.GameMode.html#getStartingBiome" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Starting<wbr/>Biome</span></a>
<a href="game_mode.GameMode.html#getStartingLevel" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Starting<wbr/>Level</span></a>
<a href="game_mode.GameMode.html#getStartingMoney" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Starting<wbr/>Money</span></a>
<a href="game_mode.GameMode.html#getWaveForDifficulty" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Wave<wbr/>For<wbr/>Difficulty</span></a>
<a href="game_mode.GameMode.html#isBoss" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Boss</span></a>
<a href="game_mode.GameMode.html#isEndlessBoss" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Endless<wbr/>Boss</span></a>
<a href="game_mode.GameMode.html#isEndlessMajorBoss" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Endless<wbr/>Major<wbr/>Boss</span></a>
<a href="game_mode.GameMode.html#isEndlessMinorBoss" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Endless<wbr/>Minor<wbr/>Boss</span></a>
<a href="game_mode.GameMode.html#isTrainerBoss" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Trainer<wbr/>Boss</span></a>
<a href="game_mode.GameMode.html#isWaveFinal" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Wave<wbr/>Final</span></a>
<a href="game_mode.GameMode.html#isWaveTrainer" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Wave<wbr/>Trainer</span></a>
[skip ci] Deploy docs
2024-06-07 21:53:00 +00:00
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_GameMode" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Game<wbr/>Mode</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">modeId</span>, <span class="tsd-kind-parameter">config</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="game_mode.GameMode.html" class="tsd-signature-type tsd-kind-class">GameMode</a><a href="#constructor.new_GameMode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">modeId</span>: <a href="../enums/game_mode.GameModes.html" class="tsd-signature-type tsd-kind-enum">GameModes</a></span></li><li><span><span class="tsd-kind-parameter">config</span>: <span class="tsd-signature-type">GameModeConfig</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="game_mode.GameMode.html" class="tsd-signature-type tsd-kind-class">GameMode</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/ece7c9f2d553cc20278bd1f54402eb70b818d0f2/src/game-mode.ts#L43">src/game-mode.ts:43</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="hasFixedBattles" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>has<wbr/>Fixed<wbr/>Battles</span><a href="#hasFixedBattles" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">has<wbr/>Fixed<wbr/>Battles</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Implementation of GameModeConfig.hasFixedBattles</p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/ece7c9f2d553cc20278bd1f54402eb70b818d0f2/src/game-mode.ts#L36">src/game-mode.ts:36</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="hasNoShop" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>has<wbr/>No<wbr/>Shop</span><a href="#hasNoShop" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">has<wbr/>No<wbr/>Shop</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Implementation of GameModeConfig.hasNoShop</p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/ece7c9f2d553cc20278bd1f54402eb70b818d0f2/src/game-mode.ts#L37">src/game-mode.ts:37</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="hasRandomBiomes" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>has<wbr/>Random<wbr/>Biomes</span><a href="#hasRandomBiomes" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">has<wbr/>Random<wbr/>Biomes</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Implementation of GameModeConfig.hasRandomBiomes</
[skip ci] Deploy docs
2024-05-31 13:57:14 +00:00
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../enums/data_enums_biome.Biome.html" class="tsd-signature-type tsd-kind-enum">Biome</a></h4><p>either:</p>
<ul>
<li>random biome for Daily mode</li>
<li>override from overrides.ts</li>
<li>Town</li>
</ul>
[skip ci] Deploy docs
2024-06-07 21:53:00 +00:00
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/ece7c9f2d553cc20278bd1f54402eb70b818d0f2/src/game-mode.ts#L82">src/game-mode.ts:82</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getStartingLevel" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Starting<wbr/>Level</span><a href="#getStartingLevel" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getStartingLevel.getStartingLevel-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Starting<wbr/>Level</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#getStartingLevel.getStartingLevel-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>either:</p>
[skip ci] Deploy docs
2024-05-31 13:57:14 +00:00
<ul>
<li>override from overrides.ts</li>
<li>20 for Daily Runs</li>
<li>5 for all other modes</li>
</ul>
[skip ci] Deploy docs
2024-06-07 21:53:00 +00:00
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/ece7c9f2d553cc20278bd1f54402eb70b818d0f2/src/game-mode.ts#L54">src/game-mode.ts:54</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getStartingMoney" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Starting<wbr/>Money</span><a href="#getStartingMoney" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getStartingMoney.getStartingMoney-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Starting<wbr/>Money</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#getStartingMoney.getStartingMoney-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>either:</p>
[skip ci] Deploy docs
2024-05-31 13:57:14 +00:00
<ul>
<li>override from overrides.ts</li>
<li>1000</li>
</ul>
[skip ci] Deploy docs
2024-06-07 21:53:00 +00:00
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/ece7c9f2d553cc20278bd1f54402eb70b818d0f2/src/game-mode.ts#L71">src/game-mode.ts:71</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getWaveForDifficulty" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Wave<wbr/>For<wbr/>Difficulty</span><a href="#getWaveForDifficulty" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getWaveForDifficulty.getWaveForDifficulty-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Wave<wbr/>For<wbr/>Difficulty</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">waveIndex</span>, <span class="tsd-kind-parameter">ignoreCurveChanges</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#getWaveForDifficulty.getWaveForDifficulty-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">waveIndex</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">ignoreCurveChanges</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/ece7c9f2d553cc20278bd1f54402eb70b818d0f2/src/game-mode.ts#L91">src/game-mode.ts:91</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="isBoss" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Boss</span><a href="#isBoss" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="isBoss.isBoss-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">is<wbr/>Boss</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">waveIndex</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#isBoss.isBoss-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Every 10 waves is a boss battle</p>
[skip ci] Deploy docs
2024-05-31 13:57:14 +00:00
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">waveIndex</span>: <span class="tsd-signature-type">number</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>true if waveIndex is a multiple of 10</p>
[skip ci] Deploy docs
2024-06-07 21:53:00 +00:00
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/ece7c9f2d553cc20278bd1f54402eb70b818d0f2/src/game-mode.ts#L177">src/game-mode.ts:177</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="isEndlessBoss" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Endless<wbr/>Boss</span><a href="#isEndlessBoss" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="isEndlessBoss.isEndlessBoss-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">is<wbr/>Endless<wbr/>Boss</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">waveIndex</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#isEndlessBoss.isEndlessBoss-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Every 50 waves of an Endless mode is a boss
[skip ci] Deploy docs
2024-05-31 13:57:14 +00:00
At this time it is paradox pokemon</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">waveIndex</span>: <span class="tsd-signature-type">number</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>true if waveIndex is a multiple of 50 in Endless</p>
[skip ci] Deploy docs
2024-06-07 21:53:00 +00:00
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/ece7c9f2d553cc20278bd1f54402eb70b818d0f2/src/game-mode.ts#L186">src/game-mode.ts:186</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="isEndlessMajorBoss" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Endless<wbr/>Major<wbr/>Boss</span><a href="#isEndlessMajorBoss" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="isEndlessMajorBoss.isEndlessMajorBoss-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">is<wbr/>Endless<wbr/>Major<wbr/>Boss</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">waveIndex</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#isEndlessMajorBoss.isEndlessMajorBoss-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Every 1000 waves of an Endless mode is a major boss
[skip ci] Deploy docs
2024-05-31 13:57:14 +00:00
At this time it is Eternamax Eternatus</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">waveIndex</span>: <span class="tsd-signature-type">number</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>true if waveIndex is a multiple of 1000 in Endless</p>
[skip ci] Deploy docs
2024-06-07 21:53:00 +00:00
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/ece7c9f2d553cc20278bd1f54402eb70b818d0f2/src/game-mode.ts#L206">src/game-mode.ts:206</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="isEndlessMinorBoss" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Endless<wbr/>Minor<wbr/>Boss</span><a href="#isEndlessMinorBoss" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="isEndlessMinorBoss.isEndlessMinorBoss-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">is<wbr/>Endless<wbr/>Minor<wbr/>Boss</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">waveIndex</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#isEndlessMinorBoss.isEndlessMinorBoss-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Every 250 waves of an Endless mode is a minor boss
[skip ci] Deploy docs
2024-05-31 13:57:14 +00:00
At this time it is Eternatus</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">waveIndex</span>: <span class="tsd-signature-type">number</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>true if waveIndex is a multiple of 250 in Endless</p>
[skip ci] Deploy docs
2024-06-07 21:53:00 +00:00
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/ece7c9f2d553cc20278bd1f54402eb70b818d0f2/src/game-mode.ts#L196">src/game-mode.ts:196</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="isTrainerBoss" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Trainer<wbr/>Boss</span><a href="#isTrainerBoss" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="isTrainerBoss.isTrainerBoss-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">is<wbr/>Trainer<wbr/>Boss</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">waveIndex</span>, <span class="tsd-kind-parameter">biomeType</span>, <span class="tsd-kind-parameter">offsetGym</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#isTrainerBoss.isTrainerBoss-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">waveIndex</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">biomeType</span>: <a href="../enums/data_enums_biome.Biome.html" class="tsd-signature-type tsd-kind-enum">Biome</a></span></li><li><span><span class="tsd-kind-parameter">offsetGym</span>: <span class="tsd-signature-type">boolean</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/ece7c9f2d553cc20278bd1f54402eb70b818d0f2/src/game-mode.ts#L136">src/game-mode.ts:136</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="isWaveFinal" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Wave<wbr/>Final</span><a href="#isWaveFinal" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="isWaveFinal.isWaveFinal-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">is<wbr/>Wave<wbr/>Final</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">waveIndex</span>, <span class="tsd-kind-parameter">modeId</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#isWaveFinal.isWaveFinal-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Checks if wave provided is the final for current or specified game mode</p>
[skip ci] Deploy docs
2024-05-31 13:57:14 +00:00
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">waveIndex</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">modeId</span>: <a href="../enums/game_mode.GameModes.html" class="tsd-signature-type tsd-kind-enum">GameModes</a><span class="tsd-signature-symbol"> = ...</span></span><div class="tsd-comment tsd-typography"><p>game mode</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>if the current wave is final for classic or daily OR a minor boss in endless</p>
[skip ci] Deploy docs
2024-06-07 21:53:00 +00:00
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/ece7c9f2d553cc20278bd1f54402eb70b818d0f2/src/game-mode.ts#L161">src/game-mode.ts:161</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="isWaveTrainer" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Wave<wbr/>Trainer</span><a href="#isWaveTrainer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="isWaveTrainer.isWaveTrainer-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">is<wbr/>Wave<wbr/>Trainer</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">waveIndex</span>, <span class="tsd-kind-parameter">arena</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#isWaveTrainer.isWaveTrainer-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">waveIndex</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">arena</span>: <a href="field_arena.Arena.html" class="tsd-signature-type tsd-kind-class">Arena</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/ece7c9f2d553cc20278bd1f54402eb70b818d0f2/src/game-mode.ts#L100">src/game-mode.ts:100</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" vie