97 lines
118 KiB
HTML
97 lines
118 KiB
HTML
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Arena | 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/field_arena.html">field/arena</a></li><li><a href="field_arena.Arena.html">Arena</a></li></ul><h1>Class Arena</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/field/arena.ts#L28">src/field/arena.ts:28</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-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="field_arena.Arena.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>
|
||
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="field_arena.Arena.html#bgm" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>bgm</span></a>
|
||
<a href="field_arena.Arena.html#biomeType" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>biome<wbr/>Type</span></a>
|
||
<a href="field_arena.Arena.html#eventTarget" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>event<wbr/>Target</span></a>
|
||
<a href="field_arena.Arena.html#ignoreAbilities" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ignore<wbr/>Abilities</span></a>
|
||
<a href="field_arena.Arena.html#ignoringEffectSource" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ignoring<wbr/>Effect<wbr/>Source</span></a>
|
||
<a href="field_arena.Arena.html#scene" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>scene</span></a>
|
||
<a href="field_arena.Arena.html#tags" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tags</span></a>
|
||
<a href="field_arena.Arena.html#terrain" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>terrain</span></a>
|
||
<a href="field_arena.Arena.html#weather" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>weather</span></a>
|
||
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="field_arena.Arena.html#addTag" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Tag</span></a>
|
||
<a href="field_arena.Arena.html#applyTags" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>apply<wbr/>Tags</span></a>
|
||
<a href="field_arena.Arena.html#applyTagsForSide" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>apply<wbr/>Tags<wbr/>For<wbr/>Side</span></a>
|
||
<a href="field_arena.Arena.html#findTags" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>find<wbr/>Tags</span></a>
|
||
<a href="field_arena.Arena.html#findTagsOnSide" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>find<wbr/>Tags<wbr/>On<wbr/>Side</span></a>
|
||
<a href="field_arena.Arena.html#getAttackTypeMultiplier" 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/>Attack<wbr/>Type<wbr/>Multiplier</span></a>
|
||
<a href="field_arena.Arena.html#getBgTerrainColorRatioForBiome" 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/>Bg<wbr/>Terrain<wbr/>Color<wbr/>Ratio<wbr/>For<wbr/>Biome</span></a>
|
||
<a href="field_arena.Arena.html#getBgmLoopPoint" 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/>Bgm<wbr/>Loop<wbr/>Point</span></a>
|
||
<a href="field_arena.Arena.html#getDayTint" 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/>Day<wbr/>Tint</span></a>
|
||
<a href="field_arena.Arena.html#getDuskTint" 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/>Dusk<wbr/>Tint</span></a>
|
||
<a href="field_arena.Arena.html#getNightTint" 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/>Night<wbr/>Tint</span></a>
|
||
<a href="field_arena.Arena.html#getSpeciesFormIndex" 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/>Species<wbr/>Form<wbr/>Index</span></a>
|
||
<a href="field_arena.Arena.html#getTag" 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/>Tag</span></a>
|
||
<a href="field_arena.Arena.html#getTagOnSide" 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/>Tag<wbr/>On<wbr/>Side</span></a>
|
||
<a href="field_arena.Arena.html#getTerrainType" 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/>Terrain<wbr/>Type</span></a>
|
||
<a href="field_arena.Arena.html#getTimeOfDay" 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/>Time<wbr/>Of<wbr/>Day</span></a>
|
||
<a href="field_arena.Arena.html#getTrainerChance" 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/>Trainer<wbr/>Chance</span></a>
|
||
<a href="field_arena.Arena.html#getTypeForBiome" 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/>Type<wbr/>For<wbr/>Biome</span></a>
|
||
<a href="field_arena.Arena.html#hasTag" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>has<wbr/>Tag</span></a>
|
||
<a href="field_arena.Arena.html#init" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>init</span></a>
|
||
<a href="field_arena.Arena.html#isMoveTerrainCancelled" 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/>Move<wbr/>Terrain<wbr/>Cancelled</span></a>
|
||
<a href="field_arena.Arena.html#isMoveWeatherCancelled" 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/>Move<wbr/>Weather<wbr/>Cancelled</span></a>
|
||
<a href="field_arena.Arena.html#isOutside" 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/>Outside</span></a>
|
||
<a href="field_arena.Arena.html#lapseTags" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>lapse<wbr/>Tags</span></a>
|
||
<a href="field_arena.Arena.html#overrideTint" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>override<wbr/>Tint</span></a>
|
||
<a href="field_arena.Arena.html#preloadBgm" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>preload<wbr/>Bgm</span></a>
|
||
<a href="field_arena.Arena.html#randomSpecies" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>random<wbr/>Species</span></a>
|
||
<a href="field_arena.Arena.html#randomTrainerType" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>random<wbr/>Trainer<wbr/>Type</span></a>
|
||
<a href="field_arena.Arena.html#removeAllTags" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>All<wbr/>Tags</span></a>
|
||
<a href="field_arena.Arena.html#removeTag" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>Tag</span></a>
|
||
<a href="field_arena.Arena.html#removeTagOnSide" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>Tag<wbr/>On<wbr/>Side</span></a>
|
||
<a href="field_arena.Arena.html#resetArenaEffects" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>reset<wbr/>Arena<wbr/>Effects</span></a>
|
||
<a href="field_arena.Arena.html#setIgnoreAbilities" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Ignore<wbr/>Abilities</span></a>
|
||
<a href="field_arena.Arena.html#triggerWeatherBasedFormChanges" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>trigger<wbr/>Weather<wbr/>Based<wbr/>Form<wbr/>Changes</span></a>
|
||
<a href="field_arena.Arena.html#triggerWeatherBasedFormChangesToNormal" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>trigger<wbr/>Weather<wbr/>Based<wbr/>Form<wbr/>Changes<wbr/>To<wbr/>Normal</span></a>
|
||
<a href="field_arena.Arena.html#trySetTerrain" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>try<wbr/>Set<wbr/>Terrain</span></a>
|
||
<a href="field_arena.Arena.html#trySetWeather" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>try<wbr/>Set<wbr/>Weather</span></a>
|
||
<a href="field_arena.Arena.html#trySetWeatherOverride" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>try<wbr/>Set<wbr/>Weather<wbr/>Override</span></a>
|
||
<a href="field_arena.Arena.html#updatePoolsForTimeOfDay" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Pools<wbr/>For<wbr/>Time<wbr/>Of<wbr/>Day</span></a>
|
||
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Constructors</h2></summary><section><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_Arena" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Arena</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scene</span>, <span class="tsd-kind-parameter">biome</span>, <span class="tsd-kind-parameter">bgm</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="field_arena.Arena.html" class="tsd-signature-type tsd-kind-class">Arena</a><a href="#constructor.new_Arena" 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">scene</span>: <a href="battle_scene.default.html" class="tsd-signature-type tsd-kind-class">default</a></span></li><li><span><span class="tsd-kind-parameter">biome</span>: <a href="../enums/enums_biome.Biome.html" class="tsd-signature-type tsd-kind-enum">Biome</a></span></li><li><span><span class="tsd-kind-parameter">bgm</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="field_arena.Arena.html" class="tsd-signature-type tsd-kind-class">Arena</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/field/arena.ts#L45">src/field/arena.ts:45</a></li></ul></aside></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="bgm" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>bgm</span><a href="#bgm" 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">bgm</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/field/arena.ts#L34">src/field/arena.ts:34</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="biomeType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>biome<wbr/>Type</span><a href="#biomeType" 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">biome<wbr/>Type</span><span class="tsd-signature-symbol">:</span> <a href="../enums/enums_biome.Biome.html" class="tsd-signature-type tsd-kind-enum">Biome</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/field/arena.ts#L30">src/field/arena.ts:30</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="eventTarget" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Readonly</code><span>event<wbr/>Target</span><a href="#eventTarget" 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">event<wbr/>Target</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">EventTarget</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/field/arena.ts#L43">src/field/arena.ts:43</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="ignoreAbilities" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>ignore<wbr/>Abilities</span><a href="#ignoreAbilities" 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">ignore<wbr/>Abilities</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/field/arena.ts#L35">src/field/arena.ts:35</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="ignoringEffectSource" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>ignoring<wbr/>Effect<wbr/>Source</span><a href="#ignoringEffectSource" 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">ignoring<wbr/>Effect<wbr/>Source</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../enums/battle.BattlerIndex.html" class="tsd-signature-type tsd-kind-enum">BattlerIndex</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/field/arena.ts#L36">src/field/arena.ts:36</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="scene" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>scene</span><a href="#scene" 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">scene</span><span class="tsd-signature-symbol">:</span> <a href="battle_scene.default.html" class="tsd-signature-type tsd-kind-class">default</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/field/arena.ts#L29">src/field/arena.ts:29</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="tags" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>tags</span><a href="#tags" 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">tags</span><span class="tsd-signature-symbol">:</span> <a href="data_arena_tag.ArenaTag.html" class="tsd-signature-type tsd-kind-class">ArenaTag</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/field/arena.ts#L33">src/field/arena.ts:33</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="terrain" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>terrain</span><a href="#terrain" 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">terrain</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="data_terrain.Terrain.html" class="tsd-signature-type tsd-kind-class">Terrain</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/field/arena.ts#L32">src/field/arena.ts:32</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="weather" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>weather</span><a href="#weather" 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">weather</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="data_weather.Weather.html" class="tsd-signature-type tsd-kind-class">Weather</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/field/arena.ts#L31">src/field/arena.ts:31</a></li></ul></aside></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Methods</h2></summary><section><section class="tsd-panel tsd-member"><a id="addTag" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>add<wbr/>Tag</span><a href="#addTag" 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="addTag.addTag-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">add<wbr/>Tag</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">tagType</span>, <span class="tsd-kind-parameter">turnCount</span>, <span class="tsd-kind-parameter">sourceMove</span>, <span class="tsd-kind-parameter">sourceId</span>, <span class="tsd-kind-parameter">side</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">quiet</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">targetIndex</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="#addTag.addTag-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>Adds a new tag to the arena</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">tagType</span>: <a href="../enums/enums_arena_tag_type.ArenaTagType.html" class="tsd-signature-type tsd-kind-enum">ArenaTagType</a></span><div class="tsd-comment tsd-typography"><p><a href="../enums/enums_arena_tag_type.ArenaTagType.html" class="tsd-kind-enum"><code>ArenaTagType</code></a> the tag being added</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">turnCount</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>How many turns the tag lasts</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">sourceMove</span>: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../enums/enums_moves.Moves.html" class="tsd-signature-type tsd-kind-enum">Moves</a></span><div class="tsd-comment tsd-typography"><p><a href="../enums/enums_moves.Moves.html" class="tsd-kind-enum"><code>Moves</code></a> the move the tag came from, or <code>undefined</code> if not from a move</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">sourceId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The ID of the pokemon in play the tag came from (see <a href="battle_scene.default.html#getPokemonById" class="tsd-kind-method"><code>BattleScene.getPokemonById</code></a>)</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">side</span>: <a href="../enums/data_arena_tag.ArenaTagSide.html" class="tsd-signature-type tsd-kind-enum">ArenaTagSide</a><span class="tsd-signature-symbol"> = ArenaTagSide.BOTH</span></span><div class="tsd-comment tsd-typography"><p><a href="../enums/data_arena_tag.ArenaTagSide.html" class="tsd-kind-enum"><code>ArenaTagSide</code></a> which side(s) the tag applies to</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">quiet</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span><div class="tsd-comment tsd-typography"><p>If a message should be queued on screen to announce the tag being added</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">targetIndex</span>: <a href="../enums/battle.BattlerIndex.html" class="tsd-signature-type tsd-kind-enum">BattlerIndex</a></span><div class="tsd-comment tsd-typography"><p>The <a href="../enums/battle.BattlerIndex.html" class="tsd-kind-enum"><code>BattlerIndex</code></a> of the target pokemon</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><code>false</code> if there already exists a tag of this type in the Arena</p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/field/arena.ts#L617">src/field/arena.ts:617</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="applyTags" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>apply<wbr/>Tags</span><a href="#applyTags" 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="applyTags.applyTags-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">apply<wbr/>Tags</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">tagType</span>, <span class="tsd-kind-parameter">simulated</span>, <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#applyTags.applyTags-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>Applies the specified tag to both sides (ie: both user and trainer's tag that match the Tag specified)
|
||
by calling <a href="field_arena.Arena.html#applyTagsForSide" class="tsd-kind-method"><code>()</code></a></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">tagType</span>: <a href="../enums/enums_arena_tag_type.ArenaTagType.html" class="tsd-signature-type tsd-kind-enum">ArenaTagType</a><span class="tsd-signature-symbol"> | </span><a href="../types/utils.Constructor.html" class="tsd-signature-type tsd-kind-type-alias">Constructor</a><span class="tsd-signature-symbol"><</span><a href="data_arena_tag.ArenaTag.html" class="tsd-signature-type tsd-kind-class">ArenaTag</a><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>Either an <a href="../enums/enums_arena_tag_type.ArenaTagType.html" class="tsd-kind-enum"><code>ArenaTagType</code></a> string, or an actual <a href="data_arena_tag.ArenaTag.html" class="tsd-kind-class"><code>ArenaTag</code></a> class to filter which ones to apply</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">simulated</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>if <code>true</code>, this applies arena tags without changing game state</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Rest</code><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>array of parameters that the called upon tags may need</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/field/arena.ts#L602">src/field/arena.ts:602</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="applyTagsForSide" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>apply<wbr/>Tags<wbr/>For<wbr/>Side</span><a href="#applyTagsForSide" 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="applyTagsForSide.applyTagsForSide-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">apply<wbr/>Tags<wbr/>For<wbr/>Side</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">tagType</span>, <span class="tsd-kind-parameter">side</span>, <span class="tsd-kind-parameter">simulated</span>, <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#applyTagsForSide.applyTagsForSide-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>Applies each <code>ArenaTag</code> in this Arena, based on which side (self, enemy, or both) is passed in as a parameter</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">tagType</span>: <a href="../enums/enums_arena_tag_type.ArenaTagType.html" class="tsd-signature-type tsd-kind-enum">ArenaTagType</a><span class="tsd-signature-symbol"> | </span><a href="../types/utils.Constructor.html" class="tsd-signature-type tsd-kind-type-alias">Constructor</a><span class="tsd-signature-symbol"><</span><a href="data_arena_tag.ArenaTag.html" class="tsd-signature-type tsd-kind-class">ArenaTag</a><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>Either an <a href="../enums/enums_arena_tag_type.ArenaTagType.html" class="tsd-kind-enum"><code>ArenaTagType</code></a> string, or an actual <a href="data_arena_tag.ArenaTag.html" class="tsd-kind-class"><code>ArenaTag</code></a> class to filter which ones to apply</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">side</span>: <a href="../enums/data_arena_tag.ArenaTagSide.html" class="tsd-signature-type tsd-kind-enum">ArenaTagSide</a></span><div class="tsd-comment tsd-typography"><p><a href="../enums/data_arena_tag.ArenaTagSide.html" class="tsd-kind-enum"><code>ArenaTagSide</code></a> which side's arena tags to apply</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">simulated</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>if <code>true</code>, this applies arena tags without changing game state</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Rest</code><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>array of parameters that the called upon tags may need</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/field/arena.ts#L585">src/field/arena.ts:585</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="findTags" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>find<wbr/>Tags</span><a href="#findTags" 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="findTags.findTags-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">find<wbr/>Tags</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">tagPredicate</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="data_arena_tag.ArenaTag.html" class="tsd-signature-type tsd-kind-class">ArenaTag</a><span class="tsd-signature-symbol">[]</span><a href="#findTags.findTags-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>Uses <a href="field_arena.Arena.html#findTagsOnSide" class="tsd-kind-method"><code>findTagsOnSide</code></a> to filter (using the parameter function) for specific tags that apply to both sides</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">tagPredicate</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">t</span><span class="tsd-signature-symbol">: </span><a href="data_arena_tag.ArenaTag.html" class="tsd-signature-type tsd-kind-class">ArenaTag</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span></span><div class="tsd-comment tsd-typography"><p>a function mapping <a href="data_arena_tag.ArenaTag.html" class="tsd-kind-class"><code>ArenaTag</code></a>s to <code>boolean</code>s</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">t</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></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">t</span>: <a href="data_arena_tag.ArenaTag.html" class="tsd-signature-type tsd-kind-class">ArenaTag</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <a href="data_arena_tag.ArenaTag.html" class="tsd-signature-type tsd-kind-class">ArenaTag</a><span class="tsd-signature-symbol">[]</span></h4><p>array of <a href="data_arena_tag.ArenaTag.html" class="tsd-kind-class"><code>ArenaTag</code></a>s from which the Arena's tags return true and apply to both sides</p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/field/arena.ts#L676">src/field/arena.ts:676</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="findTagsOnSide" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>find<wbr/>Tags<wbr/>On<wbr/>Side</span><a href="#findTagsOnSide" 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="findTagsOnSide.findTagsOnSide-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">find<wbr/>Tags<wbr/>On<wbr/>Side</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">tagPredicate</span>, <span class="tsd-kind-parameter">side</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="data_arena_tag.ArenaTag.html" class="tsd-signature-type tsd-kind-class">ArenaTag</a><span class="tsd-signature-symbol">[]</span><a href="#findTagsOnSide.findTagsOnSide-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>Returns specific tags from the arena that pass the <code>tagPredicate</code> function passed in as a parameter, and apply to the given side</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">tagPredicate</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">t</span><span class="tsd-signature-symbol">: </span><a href="data_arena_tag.ArenaTag.html" class="tsd-signature-type tsd-kind-class">ArenaTag</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span></span><div class="tsd-comment tsd-typography"><p>a function mapping <a href="data_arena_tag.ArenaTag.html" class="tsd-kind-class"><code>ArenaTag</code></a>s to <code>boolean</code>s</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">t</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></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">t</span>: <a href="data_arena_tag.ArenaTag.html" class="tsd-signature-type tsd-kind-class">ArenaTag</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></li></ul></li><li><span><span class="tsd-kind-parameter">side</span>: <a href="../enums/data_arena_tag.ArenaTagSide.html" class="tsd-signature-type tsd-kind-enum">ArenaTagSide</a></span><div class="tsd-comment tsd-typography"><p>The <a href="../enums/data_arena_tag.ArenaTagSide.html" class="tsd-kind-enum"><code>ArenaTagSide</code></a> to look at</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="data_arena_tag.ArenaTag.html" class="tsd-signature-type tsd-kind-class">ArenaTag</a><span class="tsd-signature-symbol">[]</span></h4><p>array of <a href="data_arena_tag.ArenaTag.html" class="tsd-kind-class"><code>ArenaTag</code></a>s from which the Arena's tags return <code>true</code> and apply to the given side</p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/field/arena.ts#L686">src/field/arena.ts:686</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getAttackTypeMultiplier" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Attack<wbr/>Type<wbr/>Multiplier</span><a href="#getAttackTypeMultiplier" 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="getAttackTypeMultiplier.getAttackTypeMultiplier-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Attack<wbr/>Type<wbr/>Multiplier</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">attackType</span>, <span class="tsd-kind-parameter">grounded</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#getAttackTypeMultiplier.getAttackTypeMultiplier-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">attackType</span>: <a href="../enums/data_type.Type.html" class="tsd-signature-type tsd-kind-enum">Type</a></span></li><li><span><span class="tsd-kind-parameter">grounded</span>: <span class="tsd-signature-type">boolean</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/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/field/arena.ts#L407">src/field/arena.ts:407</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getBgTerrainColorRatioForBiome" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Bg<wbr/>Terrain<wbr/>Color<wbr/>Ratio<wbr/>For<wbr/>Biome</span><a href="#getBgTerrainColorRatioForBiome" 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="getBgTerrainColorRatioForBiome.getBgTerrainColorRatioForBiome-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Bg<wbr/>Terrain<wbr/>Color<wbr/>Ratio<wbr/>For<wbr/>Biome</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="#getBgTerrainColorRatioForBiome.getBgTerrainColorRatioForBiome-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><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/field/arena.ts#L280">src/field/arena.ts:280</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getBgmLoopPoint" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Bgm<wbr/>Loop<wbr/>Point</span><a href="#getBgmLoopPoint" 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="getBgmLoopPoint.getBgmLoopPoint-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Bgm<wbr/>Loop<wbr/>Point</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="#getBgmLoopPoint.getBgmLoopPoint-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><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/field/arena.ts#L748">src/field/arena.ts:748</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getDayTint" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Day<wbr/>Tint</span><a href="#getDayTint" 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="getDayTint.getDayTint-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Day<wbr/>Tint</span><span class="tsd-signature-symbol">(</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><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">]</span><a href="#getDayTint.getDayTint-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-symbol">[</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">]</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/field/arena.ts#L526">src/field/arena.ts:526</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getDuskTint" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Dusk<wbr/>Tint</span><a href="#getDuskTint" 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="getDuskTint.getDuskTint-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Dusk<wbr/>Tint</span><span class="tsd-signature-symbol">(</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><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">]</span><a href="#getDuskTint.getDuskTint-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-symbol">[</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">]</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/field/arena.ts#L538">src/field/arena.ts:538</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getNightTint" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Night<wbr/>Tint</span><a href="#getNightTint" 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="getNightTint.getNightTint-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Night<wbr/>Tint</span><span class="tsd-signature-symbol">(</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><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">]</span><a href="#getNightTint.getNightTint-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-symbol">[</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">]</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/field/arena.ts#L552">src/field/arena.ts:552</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getSpeciesFormIndex" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Species<wbr/>Form<wbr/>Index</span><a href="#getSpeciesFormIndex" 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="getSpeciesFormIndex.getSpeciesFormIndex-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Species<wbr/>Form<wbr/>Index</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">species</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#getSpeciesFormIndex.getSpeciesFormIndex-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">species</span>: <a href="data_pokemon_species.default.html" class="tsd-signature-type tsd-kind-class">default</a></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/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/field/arena.ts#L178">src/field/arena.ts:178</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getTag" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Tag</span><a href="#getTag" 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="getTag.getTag-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Tag</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">tagType</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="data_arena_tag.ArenaTag.html" class="tsd-signature-type tsd-kind-class">ArenaTag</a><a href="#getTag.getTag-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>Attempts to get a tag from the Arena via <a href="field_arena.Arena.html#getTagOnSide" class="tsd-kind-method"><code>getTagOnSide</code></a> that applies to both sides</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">tagType</span>: <a href="../enums/enums_arena_tag_type.ArenaTagType.html" class="tsd-signature-type tsd-kind-enum">ArenaTagType</a><span class="tsd-signature-symbol"> | </span><a href="../types/utils.Constructor.html" class="tsd-signature-type tsd-kind-type-alias">Constructor</a><span class="tsd-signature-symbol"><</span><a href="data_arena_tag.ArenaTag.html" class="tsd-signature-type tsd-kind-class">ArenaTag</a><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>The <a href="../enums/enums_arena_tag_type.ArenaTagType.html" class="tsd-kind-enum"><code>ArenaTagType</code></a> or <a href="data_arena_tag.ArenaTag.html" class="tsd-kind-class"><code>ArenaTag</code></a> to get</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="data_arena_tag.ArenaTag.html" class="tsd-signature-type tsd-kind-class">ArenaTag</a></h4><p>either the <a href="data_arena_tag.ArenaTag.html" class="tsd-kind-class"><code>ArenaTag</code></a>, or <code>undefined</code> if it isn't there</p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/field/arena.ts#L649">src/field/arena.ts:649</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getTagOnSide" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Tag<wbr/>On<wbr/>Side</span><a href="#getTagOnSide" 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="getTagOnSide.getTagOnSide-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Tag<wbr/>On<wbr/>Side</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">tagType</span>, <span class="tsd-kind-parameter">side</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="data_arena_tag.ArenaTag.html" class="tsd-signature-type tsd-kind-class">ArenaTag</a><a href="#getTagOnSide.getTagOnSide-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>Attempts to get a tag from the Arena from a specific side (the tag passed in has to either apply to both sides, or the specific side only)</p>
|
||
<p>eg: <code>MIST</code> only applies to the user's side, while <code>MUD_SPORT</code> applies to both user and enemy side</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">tagType</span>: <a href="../enums/enums_arena_tag_type.ArenaTagType.html" class="tsd-signature-type tsd-kind-enum">ArenaTagType</a><span class="tsd-signature-symbol"> | </span><a href="../types/utils.Constructor.html" class="tsd-signature-type tsd-kind-type-alias">Constructor</a><span class="tsd-signature-symbol"><</span><a href="data_arena_tag.ArenaTag.html" class="tsd-signature-type tsd-kind-class">ArenaTag</a><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>The <a href="../enums/enums_arena_tag_type.ArenaTagType.html" class="tsd-kind-enum"><code>ArenaTagType</code></a> or <a href="data_arena_tag.ArenaTag.html" class="tsd-kind-class"><code>ArenaTag</code></a> to get</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">side</span>: <a href="../enums/data_arena_tag.ArenaTagSide.html" class="tsd-signature-type tsd-kind-enum">ArenaTagSide</a></span><div class="tsd-comment tsd-typography"><p>The <a href="../enums/data_arena_tag.ArenaTagSide.html" class="tsd-kind-enum"><code>ArenaTagSide</code></a> to look at</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="data_arena_tag.ArenaTag.html" class="tsd-signature-type tsd-kind-class">ArenaTag</a></h4><p>either the <a href="data_arena_tag.ArenaTag.html" class="tsd-kind-class"><code>ArenaTag</code></a>, or <code>undefined</code> if it isn't there</p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/field/arena.ts#L665">src/field/arena.ts:665</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getTerrainType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Terrain<wbr/>Type</span><a href="#getTerrainType" 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="getTerrainType.getTerrainType-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Terrain<wbr/>Type</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../enums/data_terrain.TerrainType.html" class="tsd-signature-type tsd-kind-enum">TerrainType</a><a href="#getTerrainType.getTerrainType-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 <a href="../enums/data_terrain.TerrainType.html" class="tsd-signature-type tsd-kind-enum">TerrainType</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/field/arena.ts#L403">src/field/arena.ts:403</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getTimeOfDay" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Time<wbr/>Of<wbr/>Day</span><a href="#getTimeOfDay" 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="getTimeOfDay.getTimeOfDay-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Time<wbr/>Of<wbr/>Day</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../enums/enums_time_of_day.TimeOfDay.html" class="tsd-signature-type tsd-kind-enum">TimeOfDay</a><a href="#getTimeOfDay.getTimeOfDay-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 <a href="../enums/enums_time_of_day.TimeOfDay.html" class="tsd-signature-type tsd-kind-enum">TimeOfDay</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/field/arena.ts#L469">src/field/arena.ts:469</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getTrainerChance" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Trainer<wbr/>Chance</span><a href="#getTrainerChance" 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="getTrainerChance.getTrainerChance-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Trainer<wbr/>Chance</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="#getTrainerChance.getTrainerChance-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>Gets the denominator for the chance for a trainer spawn</p>
|
||
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>n where 1/n is the chance of a trainer battle</p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/field/arena.ts#L425">src/field/arena.ts:425</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getTypeForBiome" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Type<wbr/>For<wbr/>Biome</span><a href="#getTypeForBiome" 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="getTypeForBiome.getTypeForBiome-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Type<wbr/>For<wbr/>Biome</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../enums/data_type.Type.html#UNKNOWN" class="tsd-signature-type tsd-kind-enum-member">UNKNOWN</a><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../enums/data_type.Type.html#NORMAL" class="tsd-signature-type tsd-kind-enum-member">NORMAL</a><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../enums/data_type.Type.html#FIGHTING" class="tsd-signature-type tsd-kind-enum-member">FIGHTING</a><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../enums/data_type.Type.html#FLYING" class="tsd-signature-type tsd-kind-enum-member">FLYING</a><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../enums/data_type.Type.html#POISON" class="tsd-signature-type tsd-kind-enum-member">POISON</a><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../enums/data_type.Type.html#GROUND" class="tsd-signature-type tsd-kind-enum-member">GROUND</a><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../enums/data_type.Type.html#ROCK" class="tsd-signature-type tsd-kind-enum-member">ROCK</a><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../enums/data_type.Type.html#BUG" class="tsd-signature-type tsd-kind-enum-member">BUG</a><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../enums/data_type.Type.html#GHOST" class="tsd-signature-type tsd-kind-enum-member">GHOST</a><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../enums/data_type.Type.html#STEEL" class="tsd-signature-type tsd-kind-enum-member">STEEL</a><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../enums/data_type.Type.html#FIRE" class="tsd-signature-type tsd-kind-enum-member">FIRE</a><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../enums/data_type.Type.html#WATER" class="tsd-signature-type tsd-kind-enum-member">WATER</a><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../enums/data_type.Type.html#GRASS" class="tsd-signature-type tsd-kind-enum-member">GRASS</a><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../enums/data_type.Type.html#ELECTRIC" class="tsd-signature-type tsd-kind-enum-member">ELECTRIC</a><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../enums/data_type.Type.html#PSYCHIC" class="tsd-signature-type tsd-kind-enum-member">PSYCHIC</a><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../enums/data_type.Type.html#ICE" class="tsd-signature-type tsd-kind-enum-member">ICE</a><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../enums/data_type.Type.html#DRAGON" class="tsd-signature-type tsd-kind-enum-member">DRAGON</a><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../enums/data_type.Type.html#DARK" class="tsd-signature-type tsd-kind-enum-member">DARK</a><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../enums/data_type.Type.html#FAIRY" class="tsd-signature-type tsd-kind-enum-member">FAIRY</a><a href="#getTypeForBiome.getTypeForBiome-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 <br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../enums/data_type.Type.html#UNKNOWN" class="tsd-signature-type tsd-kind-enum-member">UNKNOWN</a><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../enums/data_type.Type.html#NORMAL" class="tsd-signature-type tsd-kind-enum-member">NORMAL</a><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../enums/data_type.Type.html#FIGHTING" class="tsd-signature-type tsd-kind-enum-member">FIGHTING</a><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../enums/data_type.Type.html#FLYING" class="tsd-signature-type tsd-kind-enum-member">FLYING</a><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../enums/data_type.Type.html#POISON" class="tsd-signature-type tsd-kind-enum-member">POISON</a><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../enums/data_type.Type.html#GROUND" class="tsd-signature-type tsd-kind-enum-member">GROUND</a><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../enums/data_type.Type.html#ROCK" class="tsd-signature-type tsd-kind-enum-member">ROCK</a><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../enums/data_type.Type.html#BUG" class="tsd-signature-type tsd-kind-enum-member">BUG</a><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../enums/data_type.Type.html#GHOST" class="tsd-signature-type tsd-kind-enum-member">GHOST</a><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../enums/data_type.Type.html#STEEL" class="tsd-signature-type tsd-kind-enum-member">STEEL</a><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../enums/data_type.Type.html#FIRE" class="tsd-signature-type tsd-kind-enum-member">FIRE</a><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../enums/data_type.Type.html#WATER" class="tsd-signature-type tsd-kind-enum-member">WATER</a><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../enums/data_type.Type.html#GRASS" class="tsd-signature-type tsd-kind-enum-member">GRASS</a><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../enums/data_type.Type.html#ELECTRIC" class="tsd-signature-type tsd-kind-enum-member">ELECTRIC</a><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../enums/data_type.Type.html#PSYCHIC" class="tsd-signature-type tsd-kind-enum-member">PSYCHIC</a><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../enums/data_type.Type.html#ICE" class="tsd-signature-type tsd-kind-enum-member">ICE</a><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../enums/data_type.Type.html#DRAGON" class="tsd-signature-type tsd-kind-enum-member">DRAGON</a><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../enums/data_type.Type.html#DARK" class="tsd-signature-type tsd-kind-enum-member">DARK</a><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../enums/data_type.Type.html#FAIRY" class="tsd-signature-type tsd-kind-enum-member">FAIRY</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/field/arena.ts#L220">src/field/arena.ts:220</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="hasTag" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>has<wbr/>Tag</span><a href="#hasTag" 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="hasTag.hasTag-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">has<wbr/>Tag</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">tagType</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#hasTag.hasTag-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">tagType</span>: <a href="../enums/enums_arena_tag_type.ArenaTagType.html" class="tsd-signature-type tsd-kind-enum">ArenaTagType</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/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/field/arena.ts#L653">src/field/arena.ts:653</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="init" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>init</span><a href="#init" 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="init.init-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">init</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#init.init-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">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/field/arena.ts#L54">src/field/arena.ts:54</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="isMoveTerrainCancelled" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Move<wbr/>Terrain<wbr/>Cancelled</span><a href="#isMoveTerrainCancelled" 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="isMoveTerrainCancelled.isMoveTerrainCancelled-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">is<wbr/>Move<wbr/>Terrain<wbr/>Cancelled</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">user</span>, <span class="tsd-kind-parameter">targets</span>, <span class="tsd-kind-parameter">move</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#isMoveTerrainCancelled.isMoveTerrainCancelled-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">user</span>: <a href="field_pokemon.default.html" class="tsd-signature-type tsd-kind-class">default</a></span></li><li><span><span class="tsd-kind-parameter">targets</span>: <a href="../enums/battle.BattlerIndex.html" class="tsd-signature-type tsd-kind-enum">BattlerIndex</a><span class="tsd-signature-symbol">[]</span></span></li><li><span><span class="tsd-kind-parameter">move</span>: <a href="data_move.default.html" class="tsd-signature-type tsd-kind-class">default</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/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/field/arena.ts#L399">src/field/arena.ts:399</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="isMoveWeatherCancelled" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Move<wbr/>Weather<wbr/>Cancelled</span><a href="#isMoveWeatherCancelled" 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="isMoveWeatherCancelled.isMoveWeatherCancelled-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">is<wbr/>Move<wbr/>Weather<wbr/>Cancelled</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">user</span>, <span class="tsd-kind-parameter">move</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#isMoveWeatherCancelled.isMoveWeatherCancelled-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">user</span>: <a href="field_pokemon.default.html" class="tsd-signature-type tsd-kind-class">default</a></span></li><li><span><span class="tsd-kind-parameter">move</span>: <a href="data_move.default.html" class="tsd-signature-type tsd-kind-class">default</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/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/field/arena.ts#L395">src/field/arena.ts:395</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="isOutside" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Outside</span><a href="#isOutside" 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="isOutside.isOutside-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">is<wbr/>Outside</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="#isOutside.isOutside-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">boolean</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/field/arena.ts#L492">src/field/arena.ts:492</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="lapseTags" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>lapse<wbr/>Tags</span><a href="#lapseTags" 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="lapseTags.lapseTags-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">lapse<wbr/>Tags</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#lapseTags.lapseTags-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">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/field/arena.ts#L690">src/field/arena.ts:690</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="overrideTint" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>override<wbr/>Tint</span><a href="#overrideTint" 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="overrideTint.overrideTint-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">override<wbr/>Tint</span><span class="tsd-signature-symbol">(</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><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">]</span><a href="#overrideTint.overrideTint-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-symbol">[</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">]</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/field/arena.ts#L510">src/field/arena.ts:510</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="preloadBgm" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>preload<wbr/>Bgm</span><a href="#preloadBgm" 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="preloadBgm.preloadBgm-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">preload<wbr/>Bgm</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#preloadBgm.preloadBgm-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">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/field/arena.ts#L744">src/field/arena.ts:744</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="randomSpecies" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>random<wbr/>Species</span><a href="#randomSpecies" 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="randomSpecies.randomSpecies-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">random<wbr/>Species</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">waveIndex</span>, <span class="tsd-kind-parameter">level</span>, <span class="tsd-kind-parameter">attempt</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">luckValue</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">isBoss</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="data_pokemon_species.default.html" class="tsd-signature-type tsd-kind-class">default</a><a href="#randomSpecies.randomSpecies-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">level</span>: <span class="tsd-signature-type">number</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">attempt</span>: <span class="tsd-signature-type">number</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">luckValue</span>: <span class="tsd-signature-type">number</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">isBoss</span>: <span class="tsd-signature-type">boolean</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="data_pokemon_species.default.html" class="tsd-signature-type tsd-kind-class">default</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/field/arena.ts#L80">src/field/arena.ts:80</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="randomTrainerType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>random<wbr/>Trainer<wbr/>Type</span><a href="#randomTrainerType" 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="randomTrainerType.randomTrainerType-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">random<wbr/>Trainer<wbr/>Type</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">waveIndex</span>, <span class="tsd-kind-parameter">isBoss</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../enums/enums_trainer_type.TrainerType.html" class="tsd-signature-type tsd-kind-enum">TrainerType</a><a href="#randomTrainerType.randomTrainerType-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">isBoss</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 <a href="../enums/enums_trainer_type.TrainerType.html" class="tsd-signature-type tsd-kind-enum">TrainerType</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/field/arena.ts#L161">src/field/arena.ts:161</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="removeAllTags" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>remove<wbr/>All<wbr/>Tags</span><a href="#removeAllTags" 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="removeAllTags.removeAllTags-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">remove<wbr/>All<wbr/>Tags</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#removeAllTags.removeAllTags-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">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/field/arena.ts#L723">src/field/arena.ts:723</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="removeTag" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>remove<wbr/>Tag</span><a href="#removeTag" 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="removeTag.removeTag-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">remove<wbr/>Tag</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">tagType</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#removeTag.removeTag-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">tagType</span>: <a href="../enums/enums_arena_tag_type.ArenaTagType.html" class="tsd-signature-type tsd-kind-enum">ArenaTagType</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/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/field/arena.ts#L699">src/field/arena.ts:699</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="removeTagOnSide" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>remove<wbr/>Tag<wbr/>On<wbr/>Side</span><a href="#removeTagOnSide" 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="removeTagOnSide.removeTagOnSide-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">remove<wbr/>Tag<wbr/>On<wbr/>Side</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">tagType</span>, <span class="tsd-kind-parameter">side</span>, <span class="tsd-kind-parameter">quiet</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="#removeTagOnSide.removeTagOnSide-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">tagType</span>: <a href="../enums/enums_arena_tag_type.ArenaTagType.html" class="tsd-signature-type tsd-kind-enum">ArenaTagType</a></span></li><li><span><span class="tsd-kind-parameter">side</span>: <a href="../enums/data_arena_tag.ArenaTagSide.html" class="tsd-signature-type tsd-kind-enum">ArenaTagSide</a></span></li><li><span><span class="tsd-kind-parameter">quiet</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">boolean</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/field/arena.ts#L711">src/field/arena.ts:711</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="resetArenaEffects" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>reset<wbr/>Arena<wbr/>Effects</span><a href="#resetArenaEffects" 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="resetArenaEffects.resetArenaEffects-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">reset<wbr/>Arena<wbr/>Effects</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#resetArenaEffects.resetArenaEffects-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>Clears weather, terrain and arena tags when entering new biome or trainer battle.</p>
|
||
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/field/arena.ts#L735">src/field/arena.ts:735</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="setIgnoreAbilities" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Ignore<wbr/>Abilities</span><a href="#setIgnoreAbilities" 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="setIgnoreAbilities.setIgnoreAbilities-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set<wbr/>Ignore<wbr/>Abilities</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">ignoreAbilities</span>, <span class="tsd-kind-parameter">ignoringEffectSource</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setIgnoreAbilities.setIgnoreAbilities-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">ignoreAbilities</span>: <span class="tsd-signature-type">boolean</span></span></li><li><span><span class="tsd-kind-parameter">ignoringEffectSource</span>: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../enums/battle.BattlerIndex.html" class="tsd-signature-type tsd-kind-enum">BattlerIndex</a><span class="tsd-signature-symbol"> = null</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/field/arena.ts#L573">src/field/arena.ts:573</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="triggerWeatherBasedFormChanges" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>trigger<wbr/>Weather<wbr/>Based<wbr/>Form<wbr/>Changes</span><a href="#triggerWeatherBasedFormChanges" 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="triggerWeatherBasedFormChanges.triggerWeatherBasedFormChanges-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">trigger<wbr/>Weather<wbr/>Based<wbr/>Form<wbr/>Changes</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#triggerWeatherBasedFormChanges.triggerWeatherBasedFormChanges-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>Function to trigger all weather based form changes</p>
|
||
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/field/arena.ts#L341">src/field/arena.ts:341</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="triggerWeatherBasedFormChangesToNormal" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>trigger<wbr/>Weather<wbr/>Based<wbr/>Form<wbr/>Changes<wbr/>To<wbr/>Normal</span><a href="#triggerWeatherBasedFormChangesToNormal" 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="triggerWeatherBasedFormChangesToNormal.triggerWeatherBasedFormChangesToNormal-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">trigger<wbr/>Weather<wbr/>Based<wbr/>Form<wbr/>Changes<wbr/>To<wbr/>Normal</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#triggerWeatherBasedFormChangesToNormal.triggerWeatherBasedFormChangesToNormal-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>Function to trigger all weather based form changes back into their normal forms</p>
|
||
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/field/arena.ts#L356">src/field/arena.ts:356</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="trySetTerrain" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>try<wbr/>Set<wbr/>Terrain</span><a href="#trySetTerrain" 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="trySetTerrain.trySetTerrain-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">try<wbr/>Set<wbr/>Terrain</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">terrain</span>, <span class="tsd-kind-parameter">hasPokemonSource</span>, <span class="tsd-kind-parameter">ignoreAnim</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="#trySetTerrain.trySetTerrain-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">terrain</span>: <a href="../enums/data_terrain.TerrainType.html" class="tsd-signature-type tsd-kind-enum">TerrainType</a></span></li><li><span><span class="tsd-kind-parameter">hasPokemonSource</span>: <span class="tsd-signature-type">boolean</span></span></li><li><span><span class="tsd-kind-parameter">ignoreAnim</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">boolean</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/field/arena.ts#L368">src/field/arena.ts:368</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="trySetWeather" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>try<wbr/>Set<wbr/>Weather</span><a href="#trySetWeather" 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="trySetWeather.trySetWeather-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">try<wbr/>Set<wbr/>Weather</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">weather</span>, <span class="tsd-kind-parameter">hasPokemonSource</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#trySetWeather.trySetWeather-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>Attempts to set a new weather to the battle</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">weather</span>: <a href="../enums/enums_weather_type.WeatherType.html" class="tsd-signature-type tsd-kind-enum">WeatherType</a></span><div class="tsd-comment tsd-typography"><p><a href="../enums/enums_weather_type.WeatherType.html" class="tsd-kind-enum"><code>WeatherType</code></a> new <a href="../enums/enums_weather_type.WeatherType.html" class="tsd-kind-enum"><code>WeatherType</code></a> to set</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">hasPokemonSource</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>boolean if the new weather is from a pokemon</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>true if new weather set, false if no weather provided or attempting to set the same weather as currently in use</p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/field/arena.ts#L309">src/field/arena.ts:309</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="trySetWeatherOverride" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>try<wbr/>Set<wbr/>Weather<wbr/>Override</span><a href="#trySetWeatherOverride" 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="trySetWeatherOverride.trySetWeatherOverride-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">try<wbr/>Set<wbr/>Weather<wbr/>Override</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">weather</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#trySetWeatherOverride.trySetWeatherOverride-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>Sets weather to the override specified in overrides.ts</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">weather</span>: <a href="../enums/enums_weather_type.WeatherType.html" class="tsd-signature-type tsd-kind-enum">WeatherType</a></span><div class="tsd-comment tsd-typography"><p>new <a href="../enums/enums_weather_type.WeatherType.html" class="tsd-kind-enum"><code>WeatherType</code></a> to set</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>true to force trySetWeather to return true</p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/field/arena.ts#L296">src/field/arena.ts:296</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="updatePoolsForTimeOfDay" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>update<wbr/>Pools<wbr/>For<wbr/>Time<wbr/>Of<wbr/>Day</span><a href="#updatePoolsForTimeOfDay" 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="updatePoolsForTimeOfDay.updatePoolsForTimeOfDay-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">update<wbr/>Pools<wbr/>For<wbr/>Time<wbr/>Of<wbr/>Day</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#updatePoolsForTimeOfDay.updatePoolsForTimeOfDay-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">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/field/arena.ts#L69">src/field/arena.ts:69</a></li></ul></aside></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-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"><span class="settings-label">Member Visibility</span><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-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" 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>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#bgm" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>bgm</span></a><a href="#biomeType" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>biome<wbr/>Type</span></a><a href="#eventTarget" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>event<wbr/>Target</span></a><a href="#ignoreAbilities" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ignore<wbr/>Abilities</span></a><a href="#ignoringEffectSource" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ignoring<wbr/>Effect<wbr/>Source</span></a><a href="#scene" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>scene</span></a><a href="#tags" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tags</span></a><a href="#terrain" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>terrain</span></a><a href="#weather" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>weather</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#addTag" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Tag</span></a><a href="#applyTags" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>apply<wbr/>Tags</span></a><a href="#applyTagsForSide" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>apply<wbr/>Tags<wbr/>For<wbr/>Side</span></a><a href="#findTags" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>find<wbr/>Tags</span></a><a href="#findTagsOnSide" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>find<wbr/>Tags<wbr/>On<wbr/>Side</span></a><a href="#getAttackTypeMultiplier" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Attack<wbr/>Type<wbr/>Multiplier</span></a><a href="#getBgTerrainColorRatioForBiome" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Bg<wbr/>Terrain<wbr/>Color<wbr/>Ratio<wbr/>For<wbr/>Biome</span></a><a href="#getBgmLoopPoint" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Bgm<wbr/>Loop<wbr/>Point</span></a><a href="#getDayTint" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Day<wbr/>Tint</span></a><a href="#getDuskTint" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Dusk<wbr/>Tint</span></a><a href="#getNightTint" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Night<wbr/>Tint</span></a><a href="#getSpeciesFormIndex" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Species<wbr/>Form<wbr/>Index</span></a><a href="#getTag" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Tag</span></a><a href="#getTagOnSide" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Tag<wbr/>On<wbr/>Side</span></a><a href="#getTerrainType" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Terrain<wbr/>Type</span></a><a href="#getTimeOfDay" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Time<wbr/>Of<wbr/>Day</span></a><a href="#getTrainerChance" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Trainer<wbr/>Chance</span></a><a href="#getTypeForBiome" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Type<wbr/>For<wbr/>Biome</span></a><a href="#hasTag" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>has<wbr/>Tag</span></a><a href="#init" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>init</span></a><a href="#isMoveTerrainCancelled" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Move<wbr/>Terrain<wbr/>Cancelled</span></a><a href="#isMoveWeatherCancelled" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Move<wbr/>Weather<wbr/>Cancelled</span></a><a href="#isOutside" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Outside</span></a><a href="#lapseTags" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>lapse<wbr/>Tags</span></a><a href="#overrideTint" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>override<wbr/>Tint</span></a><a href="#preloadBgm" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>preload<wbr/>Bgm</span></a><a href="#randomSpecies" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>random<wbr/>Species</span></a><a href="#randomTrainerType" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>random<wbr/>Trainer<wbr/>Type</span></a><a href="#removeAllTags" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>All<wbr/>Tags</span></a><a href="#removeTag" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>Tag</span></a><a href="#removeTagOnSide" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>Tag<wbr/>On<wbr/>Side</span></a><a href="#resetArenaEffects" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>reset<wbr/>Arena<wbr/>Effects</span></a><a href="#setIgnoreAbilities" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Ignore<wbr/>Abilities</span></a><a href="#triggerWeatherBasedFormChanges" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>trigger<wbr/>Weather<wbr/>Based<wbr/>Form<wbr/>Changes</span></a><a href="#triggerWeatherBasedFormChangesToNormal" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>trigger<wbr/>Weather<wbr/>Based<wbr/>Form<wbr/>Changes<wbr/>To<wbr/>Normal</span></a><a href="#trySetTerrain" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>try<wbr/>Set<wbr/>Terrain</span></a><a href="#trySetWeather" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>try<wbr/>Set<wbr/>Weather</span></a><a href="#trySetWeatherOverride" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>try<wbr/>Set<wbr/>Weather<wbr/>Override</span></a><a href="#updatePoolsForTimeOfDay" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Pools<wbr/>For<wbr/>Time<wbr/>Of<wbr/>Day</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>pokemon-rogue-battle</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|