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

62 lines
108 KiB
HTML
Raw Normal View History

[skip ci] Deploy docs
2024-09-16 09:58:30 +00:00
<!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/7ea608fb8aaa0769e6a9799cbb3b1c45d3dc9474/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>
[skip ci] Deploy docs
2024-05-31 13:57:14 +00:00
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="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>
[skip ci] Deploy docs
2024-05-31 22:53:23 +00:00
<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>
[skip ci] Deploy docs
2024-05-31 13:57:14 +00:00
<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#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>
[skip ci] Deploy docs
2024-09-01 22:17:02 +00:00
<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>
[skip ci] Deploy docs
2024-05-31 13:57:14 +00:00
<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>
[skip ci] Deploy docs
2024-07-27 23:48:18 +00:00
<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>
[skip ci] Deploy docs
2024-05-31 13:57:14 +00:00
<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>
[skip ci] Deploy docs
2024-09-01 22:17:02 +00:00
<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>
[skip ci] Deploy docs
2024-05-31 13:57:14 +00:00
<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>
[skip ci] Deploy docs
2024-09-16 09:58:30 +00:00
</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/7ea608fb8aaa0769e6a9799cbb3b1c45d3dc9474/src/field/arena.ts#L44">src/field/arena.ts:44</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/7ea608fb8aaa0769e6a9799cbb3b1c45d3dc9474/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/7ea608fb8aaa0769e6a9799cbb3b1c45d3dc9474/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 clas
[skip ci] Deploy docs
2024-07-08 14:35:09 +00:00
</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>
[skip ci] Deploy docs
2024-09-16 09:58:30 +00:00
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/7ea608fb8aaa0769e6a9799cbb3b1c45d3dc9474/src/field/arena.ts#L424">src/field/arena.ts:424</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=
</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/7ea608fb8aaa0769e6a9799cbb3b1c45d3dc9474/src/field/arena.ts#L683">src/field/arena.ts:683</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-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 class="tsd-signature-symbol"> = true</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/7ea608fb8aaa0769e6a9799cbb3b1c45d3dc9474/src/field/arena.ts#L572">src/field/arena.ts:572</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/7ea608fb8aaa0769e6a9799cbb3b1c45d3dc9474/src/field/arena.ts#L340">src/field/arena.ts:340</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/7ea608fb8aaa0769e6a9799cbb3b1c45d3dc9474/src/field/arena.ts#L355">src/field/arena.ts:355</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/7ea608fb8aaa0769e6a9799cbb3b1c45d3dc9474/src/field/arena.ts#L367">src/field/arena.ts:367</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>
[skip ci] Deploy docs
2024-07-27 23:48:18 +00:00
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">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 weather to set of type WeatherType</p>
[skip ci] Deploy docs
2024-05-31 13:57:14 +00:00
</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>is the new weather 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>
[skip ci] Deploy docs
2024-09-16 09:58:30 +00:00
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/7ea608fb8aaa0769e6a9799cbb3b1c45d3dc9474/src/field/arena.ts#L308">src/field/arena.ts:308</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>
[skip ci] Deploy docs
2024-07-27 23:48:18 +00:00
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">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 weather to set of type WeatherType</p>
[skip ci] Deploy docs
2024-05-31 13:57:14 +00:00
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>true to force trySetWeather to return true</p>
[skip ci] Deploy docs
2024-09-16 09:58:30 +00:00
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/7ea608fb8aaa0769e6a9799cbb3b1c45d3dc9474/src/field/arena.ts#L295">src/field/arena.ts:295</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/7ea608fb8aaa0769e6a9799cbb3b1c45d3dc9474/src/field/arena.ts#L68">src/field/arena.ts:68</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 clas