</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">tagType</span>: <ahref="../enums/enums_arena_tag_type.ArenaTagType.html"class="tsd-signature-type tsd-kind-enum">ArenaTagType</a></span><divclass="tsd-comment tsd-typography"><p><ahref="../enums/enums_arena_tag_type.ArenaTagType.html"class="tsd-kind-enum"><code>ArenaTagType</code></a> the tag being added</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">turnCount</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>How many turns the tag lasts</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">sourceMove</span>: <spanclass="tsd-signature-type">undefined</span><spanclass="tsd-signature-symbol"> | </span><ahref="../enums/enums_moves.Moves.html"class="tsd-signature-type tsd-kind-enum">Moves</a></span><divclass="tsd-comment tsd-typography"><p><ahref="../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><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">sourceId</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>The ID of the pokemon in play the tag came from (see <ahref="battle_scene.default.html#getPokemonById"class="tsd-kind-method"><code>BattleScene.getPokemonById</code></a>)</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">side</span>: <ahref="../enums/data_arena_tag.ArenaTagSide.html"class="tsd-signature-type tsd-kind-enum">ArenaTagSide</a><spanclass="tsd-signature-symbol"> = ArenaTagSide.BOTH</span></span><divclass="tsd-comment tsd-typography"><p><ahref="../enums/data_arena_tag.ArenaTagSide.html"class="tsd-kind-enum"><code>ArenaTagSide</code></a> which side(s) the tag applies to</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">quiet</span>: <spanclass="tsd-signature-type">boolean</span><spanclass="tsd-signature-symbol"> = false</span></span><divclass="tsd-comment tsd-typography"><p>If a message should be queued on screen to announce the tag being added</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">targetIndex</span>: <ahref="../enums/battle.BattlerIndex.html"class="tsd-signature-type tsd-kind-enum">BattlerIndex</a></span><divclass="tsd-comment tsd-typography"><p>The <ahref="../enums/battle.BattlerIndex.html"class="tsd-kind-enum"><code>BattlerIndex</code></a> of the target pokemon</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">boolean</span></h4><p><code>false</code> if there already exists a tag of this type in the Arena</p>
<divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/8980513a83b257b4a6d0723dcc30d13cfc9b4c04/src/field/arena.ts#L615">src/field/arena.ts:615</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="applyTags"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>apply<wbr/>Tags</span><ahref="#applyTags"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass="tsd-signature tsd-anchor-link"><aid="applyTags.applyTags-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">apply<wbr/>Tags</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">tagType</span>, <spanclass="tsd-signature-symbol">...</span><spanclass="tsd-kind-parameter">args</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">void</span><ahref="#applyTags.applyTags-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="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 <ahref="field_arena.Arena.html#applyTagsForSide"class="tsd-kind-method"><code>()</code></a></p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">tagType</span>: <ahref="../enums/enums_arena_tag_type.ArenaTagType.html"class="tsd-signature-type tsd-kind-enum">ArenaTagType</a><spanclass="tsd-signature-symbol"> | </span><ahref="../types/utils.Constructor.html"class="tsd-signature-type tsd-kind-type-alias">Constructor</a><spanclass="tsd-signature-symbol"><</span><ahref="data_arena_tag.ArenaTag.html"class="tsd-signature-type tsd-kind-class">ArenaTag</a><spanclass="tsd-signature-symbol">></span></span><divclass="tsd-comment tsd-typography"><p>Either an <ahref="../enums/enums_arena_tag_type.ArenaTagType.html"class="tsd-kind-enum"><code>ArenaTagType</code></a> string, or an actual <ahref="data_arena_tag.ArenaTag.html"class="tsd-kind-class"><code>ArenaTag</code></a> class to filter which ones to apply</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag">Rest</code><spanclass="tsd-signature-symbol">...</span><spanclass="tsd-kind-parameter">args</span>: <spanclass="tsd-signature-type">unknown</span><spanclass="tsd-signature-symbol">[]</span></span><divclass="tsd-comment tsd-typography"><p>array of parameters that the called upon tags may need</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">void</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/8980513a83b257b4a6d0723dcc30d13cfc9b4c04/src/field/arena.ts#L600">src/field/arena.ts:600</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="applyTagsForSide"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>apply<wbr/>Tags<wbr/>For<wbr/>Side</span><ahref="#applyTagsForSide"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass="tsd-signature tsd-anchor-link"><aid="applyTagsForSide.applyTagsForSide-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">apply<wbr/>Tags<wbr/>For<wbr/>Side</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">tagType</span>, <spanclass="tsd-kind-parameter">side</span>, <spanclass="tsd-signature-symbol">...</span><spanclass="tsd-kind-parameter">args</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">void</span><ahref="#applyTagsForSide.applyTagsForSide-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="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><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">tagType</span>: <ahref="../enums/enums_arena_tag_type.ArenaTagType.html"class="tsd-signature-type tsd-kind-enum">ArenaTagType</a><spanclass="tsd-signature-symbol"> | </span><ahref="../types/utils.Constructor.html"class="tsd-signature-type tsd-kind-type-alias">Constructor</a><spanclass="tsd-signature-symbol"><</span><ahref="data_arena_tag.ArenaTag.html"class="tsd-signature-type tsd-kind-class">ArenaTag</a><spanclass="tsd-signature-symbol">></span></span><divclass="tsd-comment tsd-typography"><p>Either an <ahref="../enums/enums_arena_tag_type.ArenaTagType.html"class="tsd-kind-enum"><code>ArenaTagType</code></a> string, or an actual <ahref="data_arena_tag.ArenaTag.html"class="tsd-kind-class"><code>ArenaTag</code></a> class to filter which ones to apply</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">side</span>: <ahref="../enums/data_arena_tag.ArenaTagSide.html"class="tsd-signature-type tsd-kind-enum">ArenaTagSide</a></span><divclass="tsd-comment tsd-typography"><p><ahref="../enums/data_arena_tag.ArenaTagSide.html"class="tsd-kind-enum"><code>ArenaTagSide</code></a> which side's arena tags to apply</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag">Rest</code><spanclass="tsd-signature-symbol">...</span><spanclass="tsd-kind-parameter">args</span>: <spanclass="tsd-signature-type">unknown</span><spanclass="tsd-signature-symbol">[]</span></span><divclass="tsd-comment tsd-typography"><p>array of parameters that the called upon tags may need</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">void</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/8980513a83b257b4a6d0723dcc30d13cfc9b4c04/src/field/arena.ts#L584">src/field/arena.ts:584</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="findTags"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>find<wbr/>Tags</span><ahref="#findTags"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass="tsd-signature tsd-anchor-link"><aid="findTags.findTags-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">find<wbr/>Tags</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">tagPredicate</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><ahref="data_arena_tag.ArenaTag.html"class="tsd-signature-type tsd-kind-class">ArenaTag</a><spanclass="tsd-signature-symbol">[]</span><ahref="#findTags.findTags-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Uses <ahref="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><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">tagPredicate</span>: <spanclass="tsd-signature-symbol">(</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">t</span><spanclass="tsd-signature-symbol">: </span><ahref="data_arena_tag.ArenaTag.html"class="tsd-signature-type tsd-kind-class">ArenaTag</a><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol"> =></span><spanclass="tsd-signature-type">boolean</span><spanclass="tsd-signature-symbol">)</span></span><divclass="tsd-comment tsd-typography"><p>a function mapping <ahref="data_arena_tag.ArenaTag.html"class="tsd-kind-class"><code>ArenaTag</code></a>s to <code>boolean</code>s</p>
</div><divclass="tsd-comment tsd-typography"></div><ulclass="tsd-parameters"><liclass="tsd-parameter-signature"><ulclass="tsd-signatures"><liclass="tsd-signature"><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">t</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">boolean</span></li><liclass="tsd-description"><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">t</span>: <ahref="data_arena_tag.ArenaTag.html"class="tsd-signature-type tsd-kind-class">ArenaTag</a></span></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">boolean</span></h4></li></ul></li></ul></li></ul></div><h4class="tsd-returns-title">Returns <ahref="data_arena_tag.ArenaTag.html"class="tsd-signature-type tsd-kind-class">ArenaTag</a><spanclass="tsd-signature-symbol">[]</span></h4><p>array of <ahref="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>
<divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/8980513a83b257b4a6d0723dcc30d13cfc9b4c04/src/field/arena.ts#L674">src/field/arena.ts:674</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="findTagsOnSide"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>find<wbr/>Tags<wbr/>On<wbr/>Side</span><ahref="#findTagsOnSide"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass="tsd-signature tsd-anchor-link"><aid="findTagsOnSide.findTagsOnSide-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">find<wbr/>Tags<wbr/>On<wbr/>Side</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">tagPredicate</span>, <spanclass="tsd-kind-parameter">side</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><ahref="data_arena_tag.ArenaTag.html"class="tsd-signature-type tsd-kind-class">ArenaTag</a><spanclass="tsd-signature-symbol">[]</span><ahref="#findTagsOnSide.findTagsOnSide-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="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><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <ahref="data_arena_tag.ArenaTag.html"class="tsd-signature-type tsd-kind-class">ArenaTag</a><spanclass="tsd-signature-symbol">[]</span></h4><p>array of <ahref="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><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">tagType</span>: <ahref="../enums/enums_arena_tag_type.ArenaTagType.html"class="tsd-signature-type tsd-kind-enum">ArenaTagType</a><spanclass="tsd-signature-symbol"> | </span><ahref="../types/utils.Constructor.html"class="tsd-signature-type tsd-kind-type-alias">Constructor</a><spanclass="tsd-signature-symbol"><</span><ahref="data_arena_tag.ArenaTag.html"class="tsd-signature-type tsd-kind-class">ArenaTag</a><spanclass="tsd-signature-symbol">></span></span><divclass="tsd-comment tsd-typography"><p>The <ahref="../enums/enums_arena_tag_type.ArenaTagType.html"class="tsd-kind-enum"><code>ArenaTagType</code></a> or <ahref="data_arena_tag.ArenaTag.html"class="tsd-kind-class"><code>ArenaTag</code></a> to get</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">undefined</span><spanclass="tsd-signature-symbol"> | </span><ahref="data_arena_tag.ArenaTag.html"class="tsd-signature-type tsd-kind-class">ArenaTag</a></h4><p>either the <ahref="data_arena_tag.ArenaTag.html"class="tsd-kind-class"><code>ArenaTag</code></a>, or <code>undefined</code> if it isn't there</p>
<divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/8980513a83b257b4a6d0723dcc30d13cfc9b4c04/src/field/arena.ts#L647">src/field/arena.ts:647</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="getTagOnSide"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>get<wbr/>Tag<wbr/>On<wbr/>Side</span><ahref="#getTagOnSide"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass="tsd-signature tsd-anchor-link"><aid="getTagOnSide.getTagOnSide-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">get<wbr/>Tag<wbr/>On<wbr/>Side</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">tagType</span>, <spanclass="tsd-kind-parameter">side</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">undefined</span><spanclass="tsd-signature-symbol"> | </span><ahref="data_arena_tag.ArenaTag.html"class="tsd-signature-type tsd-kind-class">ArenaTag</a><ahref="#getTagOnSide.getTagOnSide-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="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><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">tagType</span>: <ahref="../enums/enums_arena_tag_type.ArenaTagType.html"class="tsd-signature-type tsd-kind-enum">ArenaTagType</a><spanclass="tsd-signature-symbol"> | </span><ahref="../types/utils.Constructor.html"class="tsd-signature-type tsd-kind-type-alias">Constructor</a><spanclass="tsd-signature-symbol"><</span><ahref="data_arena_tag.ArenaTag.html"class="tsd-signature-type tsd-kind-class">ArenaTag</a><spanclass="tsd-signature-symbol">></span></span><divclass="tsd-comment tsd-typography"><p>The <ahref="../enums/enums_arena_tag_type.ArenaTagType.html"class="tsd-kind-enum"><code>ArenaTagType</code></a> or <ahref="data_arena_tag.ArenaTag.html"class="tsd-kind-class"><code>ArenaTag</code></a> to get</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">side</span>: <ahref="../enums/data_arena_tag.ArenaTagSide.html"class="tsd-signature-type tsd-kind-enum">ArenaTagSide</a></span><divclass="tsd-comment tsd-typography"><p>The <ahref="../enums/data_arena_tag.ArenaTagSide.html"class="tsd-kind-enum"><code>ArenaTagSide</code></a> to look at</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">undefined</span><spanclass="tsd-signature-symbol"> | </span><ahref="data_arena_tag.ArenaTag.html"class="tsd-signature-type tsd-kind-class">ArenaTag</a></h4><p>either the <ahref="data_arena_tag.ArenaTag.html"class="tsd-kind-class"><code>ArenaTag</code></a>, or <code>undefined</code> if it isn't there</p>
</div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">void</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/8980513a83b257b4a6d0723dcc30d13cfc9b4c04/src/field/arena.ts#L733">src/field/arena.ts:733</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="setIgnoreAbilities"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>set<wbr/>Ignore<wbr/>Abilities</span><ahref="#setIgnoreAbilities"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass="tsd-signature tsd-anchor-link"><aid="setIgnoreAbilities.setIgnoreAbilities-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">set<wbr/>Ignore<wbr/>Abilities</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">ignoreAbilities</span>, <spanclass="tsd-kind-parameter">ignoringEffectSource</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">void</span><ahref="#setIgnoreAbilities.setIgnoreAbilities-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">ignoreAbilities</span>: <spanclass="tsd-signature-type">boolean</span></span></li><li><span><spanclass="tsd-kind-parameter">ignoringEffectSource</span>: <spanclass="tsd-signature-type">null</span><spanclass="tsd-signature-symbol"> | </span><ahref="../enums/battle.BattlerIndex.html"class="tsd-signature-type tsd-kind-enum">BattlerIndex</a><spanclass="tsd-signature-symbol"> = null</span></span></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">void</span></h4><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/8980513a83b257b4a6d0723dcc30d13cfc9b4c04/src/field/arena.ts#L573">src/field/arena.ts:573</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="triggerWeatherBasedFormChanges"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>trigger<wbr/>Weather<wbr/>Based<wbr/>Form<wbr/>Changes</span><ahref="#triggerWeatherBasedFormChanges"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass="tsd-signature tsd-anchor-link"><aid="triggerWeatherBasedFormChanges.triggerWeatherBasedFormChanges-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">trigger<wbr/>Weather<wbr/>Based<wbr/>Form<wbr/>Changes</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">void</span><ahref="#triggerWeatherBasedFormChanges.triggerWeatherBasedFormChanges-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Function to trigger all weather based form changes</p>
</div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">void</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/8980513a83b257b4a6d0723dcc30d13cfc9b4c04/src/field/arena.ts#L341">src/field/arena.ts:341</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="triggerWeatherBasedFormChangesToNormal"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>trigger<wbr/>Weather<wbr/>Based<wbr/>Form<wbr/>Changes<wbr/>To<wbr/>Normal</span><ahref="#triggerWeatherBasedFormChangesToNormal"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass="tsd-signature tsd-anchor-link"><aid="triggerWeatherBasedFormChangesToNormal.triggerWeatherBasedFormChangesToNormal-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">trigger<wbr/>Weather<wbr/>Based<wbr/>Form<wbr/>Changes<wbr/>To<wbr/>Normal</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">void</span><ahref="#triggerWeatherBasedFormChangesToNormal.triggerWeatherBasedFormChangesToNormal-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Function to trigger all weather based form changes back into their normal forms</p>
</div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">void</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/8980513a83b257b4a6d0723dcc30d13cfc9b4c04/src/field/arena.ts#L356">src/field/arena.ts:356</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="trySetTerrain"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>try<wbr/>Set<wbr/>Terrain</span><ahref="#trySetTerrain"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass="tsd-signature tsd-anchor-link"><aid="trySetTerrain.trySetTerrain-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">try<wbr/>Set<wbr/>Terrain</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">terrain</span>, <spanclass="tsd-kind-parameter">hasPokemonSource</span>, <spanclass="tsd-kind-parameter">ignoreAnim</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">boolean</span><ahref="#trySetTerrain.trySetTerrain-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">terrain</span>: <ahref="../enums/data_terrain.TerrainType.html"class="tsd-signature-type tsd-kind-enum">TerrainType</a></span></li><li><span><spanclass="tsd-kind-parameter">hasPokemonSource</span>: <spanclass="tsd-signature-type">boolean</span></span></li><li><span><spanclass="tsd-kind-parameter">ignoreAnim</span>: <spanclass="tsd-signature-type">boolean</span><spanclass="tsd-signature-symbol"> = false</span></span></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">boolean</span></h4><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/8980513a83b257b4a6d0723dcc30d13cfc9b4c04/src/field/arena.ts#L368">src/field/arena.ts:368</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="trySetWeather"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>try<wbr/>Set<wbr/>Weather</span><ahref="#trySetWeather"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass="tsd-signature tsd-anchor-link"><aid="trySetWeather.trySetWeather-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">try<wbr/>Set<wbr/>Weather</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">weather</span>, <spanclass="tsd-kind-parameter">hasPokemonSource</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">boolean</span><ahref="#trySetWeather.trySetWeather-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Attempts to set a new weather to the battle</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">weather</span>: <ahref="../enums/enums_weather_type.WeatherType.html"class="tsd-signature-type tsd-kind-enum">WeatherType</a></span><divclass="tsd-comment tsd-typography"><p><ahref="../enums/enums_weather_type.WeatherType.html"class="tsd-kind-enum"><code>WeatherType</code></a> new <ahref="../enums/enums_weather_type.WeatherType.html"class="tsd-kind-enum"><code>WeatherType</code></a> to set</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">hasPokemonSource</span>: <spanclass="tsd-signature-type">boolean</span></span><divclass="tsd-comment tsd-typography"><p>boolean if the new weather is from a pokemon</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="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><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">boolean</span></h4><p>true to force trySetWeather to return true</p>