<p>This property will only be available if defined in the Scene Injection Map.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from <ahref="scene_base.SceneBase.html">SceneBase</a>.<ahref="scene_base.SceneBase.html#add">add</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:101257</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="anims"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>anims</span><ahref="#anims"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">anims</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">AnimationManager</span></div><divclass="tsd-comment tsd-typography"><p>A reference to the global Animation Manager.</p>
<p>This property will only be available if defined in the Scene Injection Map.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/f460f9a0e868d7800d235267597c7de7c64e4059/src/battle-scene.ts#L207">src/battle-scene.ts:207</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><aid="bgmVolume"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>bgm<wbr/>Volume</span><ahref="#bgmVolume"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">bgm<wbr/>Volume</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">number</span><spanclass="tsd-signature-symbol"> = 1</span></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/f460f9a0e868d7800d235267597c7de7c64e4059/src/battle-scene.ts#L137">src/battle-scene.ts:137</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="cache"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>cache</span><ahref="#cache"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">cache</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">CacheManager</span></div><divclass="tsd-comment tsd-typography"><p>A reference to the global Cache.</p>
<p>This property will only be available if defined in the Scene Injection Map.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from <ahref="scene_base.SceneBase.html">SceneBase</a>.<ahref="scene_base.SceneBase.html#cache">cache</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:101215</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="cameras"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>cameras</span><ahref="#cameras"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">cameras</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">CameraManager</span></div><divclass="tsd-comment tsd-typography"><p>The Scene Camera Manager.</p>
<p>This property will only be available if defined in the Scene Injection Map.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from <ahref="scene_base.SceneBase.html">SceneBase</a>.<ahref="scene_base.SceneBase.html#cameras">cameras</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:101250</li></ul></aside></section><sectionclass="tsd-panel tsd-member"><aid="candyBar"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>candy<wbr/>Bar</span><ahref="#candyBar"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">candy<wbr/>Bar</span><spanclass="tsd-signature-symbol">:</span><ahref="ui_candy_bar.default.html"class="tsd-signature-type tsd-kind-class">default</a></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/f460f9a0e868d7800d235267597c7de7c64e4059/src/battle-scene.ts#L240">src/battle-scene.ts:240</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><aid="candyUpgradeDisplay"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>candy<wbr/>Upgrade<wbr/>Display</span><ahref="#candyUpgradeDisplay"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">candy<wbr/>Upgrade<wbr/>Display</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">number</span><spanclass="tsd-signature-symbol"> = 0</span></div><divclass="tsd-comment tsd-typography"><p>Determines what type of notification is used for Candy Upgrades</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/f460f9a0e868d7800d235267597c7de7c64e4059/src/battle-scene.ts#L166">src/battle-scene.ts:166</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><aid="candyUpgradeNotification"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>candy<wbr/>Upgrade<wbr/>Notification</span><ahref="#candyUpgradeNotification"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">candy<wbr/>Upgrade<wbr/>Notification</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">number</span><spanclass="tsd-signature-symbol"> = 0</span></div><divclass="tsd-comment tsd-typography"><p>Determines the condition for a notification should be shown for Candy Upgrades</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/f460f9a0e868d7800d235267597c7de7c64e4059/src/battle-scene.ts#L160">src/battle-scene.ts:160</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><aid="charSprite"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>char<wbr/>Sprite</span><ahref="#charSprite"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">char<wbr/>Sprite</span><spanclass="tsd-signature-symbol">:</span><ahref="ui_char_sprite.default.html"class="tsd-signature-type tsd-kind-class">default</a></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/f460f9a0e868d7800d235267597c7de7c64e4059/src/battle-scene.ts#L235">src/battle-scene.ts:235</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="children"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>children</span><ahref="#children"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">children</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">DisplayList</span></div><divclass="tsd-comment tsd-typography"><p>The Game Object Display List belonging to this Scene.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from <ahref="scene_base.SceneBase.html">SceneBase</a>.<ahref="scene_base.SceneBase.html#data">data</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:101294</li></ul></aside></section><sectionclass="tsd-panel tsd-member"><aid="disableMenu"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>disable<wbr/>Menu</span><ahref="#disableMenu"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">disable<wbr/>Menu</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">boolean</span><spanclass="tsd-signature-symbol"> = false</span></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/f460f9a0e868d7800d235267597c7de7c64e4059/src/battle-scene.ts#L216">src/battle-scene.ts:216</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><aid="eggSkipPreference"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>egg<wbr/>Skip<wbr/>Preference</span><ahref="#eggSkipPreference"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">egg<wbr/>Skip<wbr/>Preference</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">number</span><spanclass="tsd-signature-symbol"> = 0</span></div><divclass="tsd-comment tsd-typography"><p>Determines if the egg hatching animation should be skipped</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/f460f9a0e868d7800d235267597c7de7c64e4059/src/battle-scene.ts#L316">src/battle-scene.ts:316</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="events"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>events</span><ahref="#events"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">events</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">EventEmitter</span></div><divclass="tsd-comment tsd-typography"><p>A Scene specific Event Emitter.</p>
</div><divclass="tsd-comment tsd-typography"><h4class="tsd-anchor-link"><aid="Remarks"class="tsd-anchor"></a>Remarks<ahref="#Remarks"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The <code>expParty</code> can have several modes:</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from <ahref="scene_base.SceneBase.html">SceneBase</a>.<ahref="scene_base.SceneBase.html#input">input</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:101301</li></ul></aside></section><sectionclass="tsd-panel tsd-member"><aid="inputController"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>input<wbr/>Controller</span><ahref="#inputController"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">input<wbr/>Controller</span><spanclass="tsd-signature-symbol">:</span><ahref="inputs_controller.InputsController.html"class="tsd-signature-type tsd-kind-class">InputsController</a></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/f460f9a0e868d7800d235267597c7de7c64e4059/src/battle-scene.ts#L131">src/battle-scene.ts:131</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><aid="inputMethod"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>input<wbr/>Method</span><ahref="#inputMethod"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">input<wbr/>Method</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/f460f9a0e868d7800d235267597c7de7c64e4059/src/battle-scene.ts#L302">src/battle-scene.ts:302</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><aid="lastEnemyTrainer"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>last<wbr/>Enemy<wbr/>Trainer</span><ahref="#lastEnemyTrainer"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">last<wbr/>Enemy<wbr/>Trainer</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">null</span><spanclass="tsd-signature-symbol"> | </span><ahref="field_trainer.default.html"class="tsd-signature-type tsd-kind-class">default</a></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/f460f9a0e868d7800d235267597c7de7c64e4059/src/battle-scene.ts#L252">src/battle-scene.ts:252</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><aid="lastMysteryEncounter"class="tsd-anchor"></a><h3class="tsd-anchor-link"><codeclass="tsd-tag">Optional</code><span>last<wbr/>Mystery<wbr/>Encounter</span><ahref="#lastMysteryEncounter"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">last<wbr/>Mystery<wbr/>Encounter</span><spanclass="tsd-signature-symbol">?:</span><ahref="data_mystery_encounters_mystery_encounter.default.html"class="tsd-signature-type tsd-kind-class">default</a></div><divclass="tsd-comment tsd-typography"><p>If the previous wave was a MysteryEncounter, tracks the object with this variable. Mostly used for visual object cleanup</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/f460f9a0e868d7800d235267597c7de7c64e4059/src/battle-scene.ts#L261">src/battle-scene.ts:261</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><aid="lastSavePlayTime"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>last<wbr/>Save<wbr/>Play<wbr/>Time</span><ahref="#lastSavePlayTime"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">last<wbr/>Save<wbr/>Play<wbr/>Time</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">null</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">number</span><spanclass="tsd-signature-symbol"> = null</span></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/f460f9a0e868d7800d235267597c7de7c64e4059/src/battle-scene.ts#L135">src/battle-scene.ts:135</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="lights"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>lights</span><ahref="#lights"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">lights</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">LightsManager</span></div><divclass="tsd-comment tsd-typography"><p>The Scene Lights Manager Plugin.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from <ahref="scene_base.SceneBase.html">SceneBase</a>.<ahref="scene_base.SceneBase.html#load">load</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:101308</li></ul></aside></section><sectionclass="tsd-panel tsd-member"><aid="lockModifierTiers"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>lock<wbr/>Modifier<wbr/>Tiers</span><ahref="#lockModifierTiers"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">lock<wbr/>Modifier<wbr/>Tiers</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">boolean</span></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/f460f9a0e868d7800d235267597c7de7c64e4059/src/battle-scene.ts#L250">src/battle-scene.ts:250</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="make"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>make</span><ahref="#make"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">make</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">GameObjectCreator</span></div><divclass="tsd-comment tsd-typography"><p>The Scene Game Object Creator.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from <ahref="scene_base.SceneBase.html">SceneBase</a>.<ahref="scene_base.SceneBase.html#matter">matter</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:101336</li></ul></aside></section><sectionclass="tsd-panel tsd-member"><aid="modifiers"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>modifiers</span><ahref="#modifiers"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">modifiers</span><spanclass="tsd-signature-symbol">:</span><ahref="modifier_modifier.PersistentModifier.html"class="tsd-signature-type tsd-kind-class">PersistentModifier</a><spanclass="tsd-signature-symbol">[]</span></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/f460f9a0e868d7800d235267597c7de7c64e4059/src/battle-scene.ts#L277">src/battle-scene.ts:277</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><aid="money"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>money</span><ahref="#money"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">money</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">number</span></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/f460f9a0e868d7800d235267597c7de7c64e4059/src/battle-scene.ts#L255">src/battle-scene.ts:255</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><aid="moneyFormat"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>money<wbr/>Format</span><ahref="#moneyFormat"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">money<wbr/>Format</span><spanclass="tsd-signature-symbol">:</span><ahref="../enums/enums_money_format.MoneyFormat.html"class="tsd-signature-type tsd-kind-enum">MoneyFormat</a><spanclass="tsd-signature-symbol"> = MoneyFormat.NORMAL</span></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/f460f9a0e868d7800d235267597c7de7c64e4059/src/battle-scene.ts#L167">src/battle-scene.ts:167</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><aid="moveAnimations"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>move<wbr/>Animations</span><ahref="#moveAnimations"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">move<wbr/>Animations</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">boolean</span><spanclass="tsd-signature-symbol"> = true</span></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/f460f9a0e868d7800d235267597c7de7c64e4059/src/battle-scene.ts#L172">src/battle-scene.ts:172</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><aid="musicPreference"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>music<wbr/>Preference</span><ahref="#musicPreference"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">music<wbr/>Preference</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">number</span><spanclass="tsd-signature-symbol"> = 0</span></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/f460f9a0e868d7800d235267597c7de7c64e4059/src/battle-scene.ts#L171">src/battle-scene.ts:171</
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/f460f9a0e868d7800d235267597c7de7c64e4059/src/battle-scene.ts#L259">src/battle-scene.ts:259</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><aid="offsetGym"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>offset<wbr/>Gym</span><ahref="#offsetGym"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">offset<wbr/>Gym</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">boolean</span></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/f460f9a0e868d7800d235267597c7de7c64e4059/src/battle-scene.ts#L285">src/battle-scene.ts:285</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><aid="partyExpBar"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>party<wbr/>Exp<wbr/>Bar</span><ahref="#partyExpBar"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">party<wbr/>Exp<wbr/>Bar</span><spanclass="tsd-signature-symbol">:</span><ahref="ui_party_exp_bar.default.html"class="tsd-signature-type tsd-kind-class">default</a></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/f460f9a0e868d7800d235267597c7de7c64e4059/src/battle-scene.ts#L239">src/battle-scene.ts:239</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><aid="pbTray"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>pb<wbr/>Tray</span><ahref="#pbTray"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">pb<wbr/>Tray</span><spanclass="tsd-signature-symbol">:</span><ahref="ui_pokeball_tray.default.html"class="tsd-signature-type tsd-kind-class">default</a></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/f460f9a0e868d7800d235267597c7de7c64e4059/src/battle-scene.ts#L236">src/battle-scene.ts:236</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><aid="pbTrayEnemy"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>pb<wbr/>Tray<wbr/>Enemy</span><ahref="#pbTrayEnemy"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">pb<wbr/>Tray<wbr/>Enemy</span><spanclass="tsd-signature-symbol">:</span><ahref="ui_pokeball_tray.default.html"class="tsd-signature-type tsd-kind-class">default</a></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/f460f9a0e868d7800d235267597c7de7c64e4059/src/battle-scene.ts#L237">src/battle-scene.ts:237</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><aid="phaseQueue"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>phase<wbr/>Queue</span><ahref="#phaseQueue"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">phase<wbr/>Queue</span><spanclass="tsd-signature-symbol">:</span><ahref="phase.Phase.html"class="tsd-signature-type tsd-kind-class">Phase</a><spanclass="tsd-signature-symbol">[]</span></div><divclass="tsd-comment tsd-typography"><p>PhaseQueue: dequeue/remove the first element to get the next phase</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/f460f9a0e868d7800d235267597c7de7c64e4059/src/battle-scene.ts#L222">src/battle-scene.ts:222</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="physics"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>physics</span><ahref="#physics"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">physics</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">ArcadePhysics</span></div><divclass="tsd-comment tsd-typography"><p>The Scene Arcade Physics Plugin.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from <ahref="scene_base.SceneBase.html">SceneBase</a>.<ahref="scene_base.SceneBase.html#physics">physics</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:101329</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="plugins"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>plugins</span><ahref="#plugins"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">plugins</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">PluginManager</span></div><divclass="tsd-comment tsd-typography"><p>A reference to the global Plugin Manager.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from <ahref="scene_base.SceneBase.html">SceneBase</a>.<ahref="scene_base.SceneBase.html#plugins">plugins</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:101358</li></ul></aside></section><sectionclass="tsd-panel tsd-member"><aid="pokeballCounts"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>pokeball<wbr/>Counts</span><ahref="#pokeballCounts"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">pokeball<wbr/>Counts</span><spanclass="tsd-signature-symbol">:</span><ahref="../interfaces/battle_scene.PokeballCounts.html"class="tsd-signature-type tsd-kind-interface">PokeballCounts</a></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/f460f9a0e868d7800d235267597c7de7c64e4059/src/battle-scene.ts#L254">src/battle-scene.ts:254</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><aid="pokemonInfoContainer"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>pokemon<wbr/>Info<wbr/>Container</span><ahref="#pokemonInfoContainer"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">pokemon<wbr/>Info<wbr/>Container</span><spanclass="tsd-signature-symbol">:</span><ahref="ui_pokemon_info_container.default.html"class="tsd-signature-type tsd-kind-class">default</a></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/f460f9a0e868d7800d235267597c7de7c64e4059/src/battle-scene.ts#L256">src/battle-scene.ts:256</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="registry"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>registry</span><ahref="#registry"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">registry</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">DataManager</span></div><divclass="tsd-comment tsd-typography"><p>A reference to the global Data Manager.</p>
<p>This property will only be available if defined in the Scene Injection Map.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from <ahref="scene_base.SceneBase.html">SceneBase</a>.<ahref="scene_base.SceneBase.html#registry">registry</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:101222</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="renderer"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>renderer</span><ahref="#renderer"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">renderer</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">CanvasRenderer</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">WebGLRenderer</span></div><divclass="tsd-comment tsd-typography"><p>A reference to the renderer instance Phaser is using, either Canvas Renderer or WebGL Renderer.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from <ahref="scene_base.SceneBase.html">SceneBase</a>.<ahref="scene_base.SceneBase.html#scale">scale</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:101350</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited"><aid="scaledCanvas"class="tsd-anchor"></a><h3class="tsd-anchor-link"><codeclass="tsd-tag">Readonly</code><span>scaled<wbr/>Canvas</span><ahref="#scaledCanvas"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">scaled<wbr/>Canvas</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-symbol">{ </span><br/><span></span><spanclass="tsd-kind-property">height</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">number</span><spanclass="tsd-signature-symbol">; </span><br/><span></span><spanclass="tsd-kind-property">width</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">number</span><spanclass="tsd-signature-symbol">; </span><br/><spanclass="tsd-signature-symbol">}</span><spanclass="tsd-signature-symbol"> = ...</span></div><divclass="tsd-comment tsd-typography"><p>Since everything is scaled up by 6 by default using the game.canvas is annoying
</div><asideclass="tsd-sources"><p>Inherited from <ahref="scene_base.SceneBase.html">SceneBase</a>.<ahref="scene_base.SceneBase.html#scaledCanvas">scaledCanvas</a></p><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/f460f9a0e868d7800d235267597c7de7c64e4059/src/scene-base.ts#L13">src/scene-base.ts:13</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="scene"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>scene</span><ahref="#scene"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">scene</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">ScenePlugin</span></div><divclass="tsd-comment tsd-typography"><p>A reference to the Scene Manager Plugin.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from <ahref="scene_base.SceneBase.html">SceneBase</a>.<ahref="scene_base.SceneBase.html#sound">sound</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:101229</li></ul></aside></section><sectionclass="tsd-panel tsd-member"><aid="spritePipeline"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>sprite<wbr/>Pipeline</span><ahref="#spritePipeline"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">sprite<wbr/>Pipeline</span><spanclass="tsd-signature-symbol">:</span><ahref="pipelines_sprite.default.html"class="tsd-signature-type tsd-kind-class">default</a></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/f460f9a0e868d7800d235267597c7de7c64e4059/src/battle-scene.ts#L291">src/battle-scene.ts:291</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="sys"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>sys</span><ahref="#sys"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">sys</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">Systems</span></div><divclass="tsd-comment tsd-typography"><p>The Scene Systems. You must never overwrite this property, or all hell will break lose.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from <ahref="scene_base.SceneBase.html">SceneBase</a>.<ahref="scene_base.SceneBase.html#sys">sys</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:101194</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="textures"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>textures</span><ahref="#textures"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">textures</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">TextureManager</span></div><divclass="tsd-comment tsd-typography"><p>A reference to the Texture Manager.</p>
<p>This property will only be available if defined in the Scene Injection Map.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from <ahref="scene_base.SceneBase.html">SceneBase</a>.<ahref="scene_base.SceneBase.html#textures">textures</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:101236</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="time"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>time</span><ahref="#time"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">time</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">Clock</span></div><divclass="tsd-comment tsd-typography"><p>The Scene Time and Clock Plugin.</p>
<p>This property will only be available if defined in the Scene Injection Map and the plugin is installed.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from <ahref="scene_base.SceneBase.html">SceneBase</a>.<ahref="scene_base.SceneBase.html#tweens">tweens</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:101322</li></ul></aside></section><sectionclass="tsd-panel tsd-member"><aid="typeHints"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>type<wbr/>Hints</span><ahref="#typeHints"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">type<wbr/>Hints</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">boolean</span><spanclass="tsd-signature-symbol"> = false</span></div><divclass="tsd-comment tsd-typography"><p>Defines whether or not to show type effectiveness hints</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">expValue</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>raw value of exp to split among participants, OR the base multiplier to use with waveIndex</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">pokemonDefeated</span>: <spanclass="tsd-signature-type">boolean</span></span><divclass="tsd-comment tsd-typography"><p>If true, will increment Macho Brace stacks and give the party Pokemon friendship increases</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">useWaveIndexMultiplier</span>: <spanclass="tsd-signature-type">boolean</span></span><divclass="tsd-comment tsd-typography"><p>Default false. If true, will multiply expValue by a scaling waveIndex multiplier. Not needed if expValue is already scaled by level/wave</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">pokemonParticipantIds</span>: <spanclass="tsd-signature-type">Set</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">number</span><spanclass="tsd-signature-symbol">></span></span><divclass="tsd-comment tsd-typography"><p>Participants. If none are defined, no exp will be given. To spread evenly among the party, should pass all ids of party members.</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/f460f9a0e868d7800d235267597c7de7c64e4059/src/battle-scene.ts#L2692">src/battle-scene.ts:2692</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="clearEnemyModifiers"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>clear<wbr/>Enemy<wbr/>Modifiers</span><ahref="#clearEnemyModifiers"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="clearEnemyModifiers.clearEnemyModifiers-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">clear<wbr/>Enemy<wbr/>Modifiers</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">void</span><ahref="#clearEnemyModifiers.clearEnemyModifiers-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>Removes all modifiers from enemy of PersistentModifier type</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/f460f9a0e868d7800d235267597c7de7c64e4059/src/battle-scene.ts#L2681">src/battle-scene.ts:2681</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="clearPhaseQueue"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>clear<wbr/>Phase<wbr/>Queue</span><ahref="#clearPhaseQueue"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="clearPhaseQueue.clearPhaseQueue-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">clear<wbr/>Phase<wbr/>Queue</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">void</span><ahref="#clearPhaseQueue.clearPhaseQueue-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>Clears the phaseQueue</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/f460f9a0e868d7800d235267597c7de7c64e4059/src/battle-scene.ts#L2249">src/battle-scene.ts:2249</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="clearPhaseQueueSplice"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>clear<wbr/>Phase<wbr/>Queue<wbr/>Splice</span><ahref="#clearPhaseQueueSplice"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="clearPhaseQueueSplice.clearPhaseQueueSplice-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">clear<wbr/>Phase<wbr/>Queue<wbr/>Splice</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">void</span><ahref="#clearPhaseQueueSplice.clearPhaseQueueSplice-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>Resets phaseQueuePrependSpliceIndex to -1, implies that calls to unshiftPhase will insert at end of phaseQueuePrepend</p>
</div><sectionclass="tsd-panel"><h4>Type Parameters</h4><ulclass="tsd-type-parameter-list"><li><span><aid="findPhase.findPhase-1.P"class="tsd-anchor"></a><spanclass="tsd-kind-type-parameter">P</span><spanclass="tsd-signature-keyword"> extends </span><ahref="phase.Phase.html"class="tsd-signature-type tsd-kind-class">Phase</a> = <ahref="phase.Phase.html"class="tsd-signature-type tsd-kind-class">Phase</a></span></li></ul></section><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">phaseFilter</span>: <spanclass="tsd-signature-symbol">(</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">phase</span><spanclass="tsd-signature-symbol">: </span><aclass="tsd-signature-type tsd-kind-type-parameter"href="battle_scene.default.html#findPhase.findPhase-1.P">P</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>filter function to use to find the wanted phase</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">phase</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">phase</span>: <aclass="tsd-signature-type tsd-kind-type-parameter"href="battle_scene.default.html#findPhase.findPhase-1.P">P</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 <spanclass="tsd-signature-type">undefined</span><spanclass="tsd-signature-symbol"> | </span><aclass="tsd-signature-type tsd-kind-type-parameter"href="battle_scene.default.html#findPhase.findPhase-1.P">P</a></h4><p>the found phase or undefined if none found</p>
Active Pokemon include both enemy and player Pokemon of the current wave.
Note: Questions on garbage collection go to</p>
</div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">[]</span></h4><p>a string array of active sprite and audio keys that should not be deleted</p>
</div><h4class="tsd-returns-title">Returns <ahref="field_pokemon.EnemyPokemon.html"class="tsd-signature-type tsd-kind-class">EnemyPokemon</a><spanclass="tsd-signature-symbol">[]</span></h4><p>array of <ahref="field_pokemon.EnemyPokemon.html"class="tsd-kind-class"><code>EnemyPokemon</code></a></p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">isEnemy</span>: <spanclass="tsd-signature-type">boolean</span></span><divclass="tsd-comment tsd-typography"><p>Whether to return the enemy's modifier bar</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <ahref="modifier_modifier.ModifierBar.html"class="tsd-signature-type tsd-kind-class">ModifierBar</a></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/f460f9a0e868d7800d235267597c7de7c64e4059/src/battle-scene.ts#L853">src/battle-scene.ts:853</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="getModifiers"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>get<wbr/>Modifiers</span><ahref="#getModifiers"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="getModifiers.getModifiers-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">get<wbr/>Modifiers</span><spanclass="tsd-signature-symbol"><</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="battle_scene.default.html#getModifiers.getModifiers-1.T">T</a><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">modifierType</span>, <spanclass="tsd-kind-parameter">player</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><aclass="tsd-signature-type tsd-kind-type-parameter"href="battle_scene.default.html#getModifiers.getModifiers-1.T">T</a><spanclass="tsd-signature-symbol">[]</span><ahref="#getModifiers.getModifiers-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>Get all of the modifiers that match <code>modifierType</code></p>
</div><sectionclass="tsd-panel"><h4>Type Parameters</h4><ulclass="tsd-type-parameter-list"><li><span><aid="getModifiers.getModifiers-1.T"class="tsd-anchor"></a><spanclass="tsd-kind-type-parameter">T</span><spanclass="tsd-signature-keyword"> extends </span><ahref="modifier_modifier.PersistentModifier.html"class="tsd-signature-type tsd-kind-class">PersistentModifier</a></span></li></ul></section><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">modifierType</span>: <ahref="../types/utils.Constructor.html"class="tsd-signature-type tsd-kind-type-alias">Constructor</a><spanclass="tsd-signature-symbol"><</span><aclass="tsd-signature-type tsd-kind-type-parameter"href="battle_scene.default.html#getModifiers.getModifiers-1.T">T</a><spanclass="tsd-signature-symbol">></span></span><divclass="tsd-comment tsd-typography"><p>The type of modifier to apply; must extend <ahref="modifier_modifier.PersistentModifier.html"class="tsd-kind-class"><code>PersistentModifier</code></a></p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">player</span>: <spanclass="tsd-signature-type">boolean</span><spanclass="tsd-signature-symbol"> = true</span></span><divclass="tsd-comment tsd-typography"><p>Whether to search the player (<code>true</code>) or the enemy (<code>false</code>); Defaults to <code>true</code></p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <aclass="tsd-signature-type tsd-kind-type-parameter"href="battle_scene.default.html#getModifiers.getModifiers-1.T">T</a><spanclass="tsd-signature-symbol">[]</span></h4><p>the list of all modifiers that matched <code>modifierType</code>.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <ahref="data_mystery_encounters_mystery_encounter.default.html"class="tsd-signature-type tsd-kind-class">default</a></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/f460f9a0e868d7800d235267597c7de7c64e4059/src/battle-scene.ts#L3133">src/battle-scene.ts:3133</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="getNonSwitchedEnemyPokemon"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>get<wbr/>Non<wbr/>Switched<wbr/>Enemy<wbr/>Pokemon</span><ahref="#getNonSwitchedEnemyPokemon"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="getNonSwitchedEnemyPokemon.getNonSwitchedEnemyPokemon-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">get<wbr/>Non<wbr/>Switched<wbr/>Enemy<wbr/>Pokemon</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">undefined</span><spanclass="tsd-signature-symbol"> | </span><ahref="field_pokemon.EnemyPokemon.html"class="tsd-signature-type tsd-kind-class">EnemyPokemon</a><ahref="#getNonSwitchedEnemyPokemon.getNonSwitchedEnemyPokemon-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>Finds the first <ahref="field_pokemon.default.html#isActive"class="tsd-kind-method"><code>() | active EnemyPokemon</code></a> pokemon from the enemy that isn't also currently switching out</p>
</div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">undefined</span><spanclass="tsd-signature-symbol"> | </span><ahref="field_pokemon.EnemyPokemon.html"class="tsd-signature-type tsd-kind-class">EnemyPokemon</a></h4><p>Either the first <ahref="field_pokemon.EnemyPokemon.html"class="tsd-kind-class"><code>EnemyPokemon</code></a> satisfying, or undefined if no player pokemon on the field satisfy</p>
<divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/f460f9a0e868d7800d235267597c7de7c64e4059/src/battle-scene.ts#L803">src/battle-scene.ts:803</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="getNonSwitchedPlayerPokemon"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>get<wbr/>Non<wbr/>Switched<wbr/>Player<wbr/>Pokemon</span><ahref="#getNonSwitchedPlayerPokemon"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="getNonSwitchedPlayerPokemon.getNonSwitchedPlayerPokemon-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">get<wbr/>Non<wbr/>Switched<wbr/>Player<wbr/>Pokemon</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">undefined</span><spanclass="tsd-signature-symbol"> | </span><ahref="field_pokemon.PlayerPokemon.html"class="tsd-signature-type tsd-kind-class">PlayerPokemon</a><ahref="#getNonSwitchedPlayerPokemon.getNonSwitchedPlayerPokemon-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>Finds the first <ahref="field_pokemon.default.html#isActive"class="tsd-kind-method"><code>() | active PlayerPokemon</code></a> that isn't also currently switching out</p>
</div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">undefined</span><spanclass="tsd-signature-symbol"> | </span><ahref="field_pokemon.PlayerPokemon.html"class="tsd-signature-type tsd-kind-class">PlayerPokemon</a></h4><p>Either the first <ahref="field_pokemon.PlayerPokemon.html"class="tsd-kind-class"><code>PlayerPokemon</code></a> satisfying, or undefined if no player pokemon on the field satisfy</p>
<divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/f460f9a0e868d7800d235267597c7de7c64e4059/src/battle-scene.ts#L778">src/battle-scene.ts:778</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="getParty"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>get<wbr/>Party</span><ahref="#getParty"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="getParty.getParty-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">get<wbr/>Party</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><ahref="field_pokemon.PlayerPokemon.html"class="tsd-signature-type tsd-kind-class">PlayerPokemon</a><spanclass="tsd-signature-symbol">[]</span><ahref="#getParty.getParty-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"><h4class="tsd-returns-title">Returns <ahref="field_pokemon.PlayerPokemon.html"class="tsd-signature-type tsd-kind-class">PlayerPokemon</a><spanclass="tsd-signature-symbol">[]</span></h4><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/f460f9a0e868d7800d235267597c7de7c64e4059/src/battle-scene.ts#L766">src/battle-scene.ts:766</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="getPlayerField"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>get<wbr/>Player<wbr/>Field</span><ahref="#getPlayerField"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="getPlayerField.getPlayerField-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">get<wbr/>Player<wbr/>Field</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><ahref="field_pokemon.PlayerPokemon.html"class="tsd-signature-type tsd-kind-class">PlayerPokemon</a><spanclass="tsd-signature-symbol">[]</span><ahref="#getPlayerField.getPlayerField-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 an array of PlayerPokemon of length 1 or 2 depending on if double battles or not</p>
</div><h4class="tsd-returns-title">Returns <ahref="field_pokemon.PlayerPokemon.html"class="tsd-signature-type tsd-kind-class">PlayerPokemon</a><spanclass="tsd-signature-symbol">[]</span></h4><p>array of <ahref="field_pokemon.PlayerPokemon.html"class="tsd-kind-class"><code>PlayerPokemon</code></a></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/f460f9a0e868d7800d235267597c7de7c64e4059/src/battle-scene.ts#L2408">src/battle-scene.ts:2408</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="preload"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>preload</span><ahref="#preload"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="preload.preload-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">preload</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">void</span><spanclass="tsd-signature-symbol">></span><ahref="#preload.preload-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"><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">void</span><spanclass="tsd-signature-symbol">></span></h4><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/f460f9a0e868d7800d235267597c7de7c64e4059/src/battle-scene.ts#L342">src/battle-scene.ts:342</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="prependToPhase"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>prepend<wbr/>To<wbr/>Phase</span><ahref="#prependToPhase"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="prependToPhase.prependToPhase-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">prepend<wbr/>To<wbr/>Phase</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">phase</span>, <spanclass="tsd-kind-parameter">targetPhase</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">boolean</span><ahref="#prependToPhase.prependToPhase-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>Tries to add the input phase to index before target phase in the phaseQueue, else simply calls unshiftPhase()</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">phase</span>: <ahref="phase.Phase.html"class="tsd-signature-type tsd-kind-class">Phase</a></span><divclass="tsd-comment tsd-typography"><p><ahref="phase.Phase.html"class="tsd-kind-class"><code>Phase</code></a> the phase to be added</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">targetPhase</span>: <ahref="../types/utils.Constructor.html"class="tsd-signature-type tsd-kind-type-alias">Constructor</a><spanclass="tsd-signature-symbol"><</span><ahref="phase.Phase.html"class="tsd-signature-type tsd-kind-class">Phase</a><spanclass="tsd-signature-symbol">></span></span><divclass="tsd-comment tsd-typography"><p><ahref="phase.Phase.html"class="tsd-kind-class"><code>Phase</code></a> the type of phase to search for in phaseQueue</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">boolean</span></h4><p>boolean if a targetPhase was found and added</p>
<divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/f460f9a0e868d7800d235267597c7de7c64e4059/src/battle-scene.ts#L2374">src/battle-scene.ts:2374</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="processInfoButton"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>process<wbr/>Info<wbr/>Button</span><ahref="#processInfoButton"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="processInfoButton.processInfoButton-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">process<wbr/>Info<wbr/>Button</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">pressed</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">void</span><ahref="#processInfoButton.processInfoButton-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">pressed</span>: <spanclass="tsd-signature-type">boolean</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/f460f9a0e868d7800d235267597c7de7c64e4059/src/battle-scene.ts#L1559">src/battle-scene.ts:1559</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="pushConditionalPhase"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>push<wbr/>Conditional<wbr/>Phase</span><ahref="#pushConditionalPhase"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="pushConditionalPhase.pushConditionalPhase-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">push<wbr/>Conditional<wbr/>Phase</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">phase</span>, <spanclass="tsd-kind-parameter">condition</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">void</span><ahref="#pushConditionalPhase.pushConditionalPhase-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>Adds a phase to the conditional queue and ensures it is executed only when the specified condition is met.</p>
<p>This method allows deferring the execution of a phase until certain conditions are met, which is useful for handling
situations like abilities and entry hazards that depend on specific game states.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">phase</span>: <ahref="phase.Phase.html"class="tsd-signature-type tsd-kind-class">Phase</a></span><divclass="tsd-comment tsd-typography"><p>The phase to be added to the conditional queue.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">condition</span>: <spanclass="tsd-signature-symbol">(</span><spanclass="tsd-signature-symbol">(</span><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 that returns a boolean indicating whether the phase should be executed.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">phase</span>: <ahref="phase.Phase.html"class="tsd-signature-type tsd-kind-class">Phase</a></span><divclass="tsd-comment tsd-typography"><p><ahref="phase.Phase.html"class="tsd-kind-class"><code>Phase</code></a> the phase to add</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">defer</span>: <spanclass="tsd-signature-type">boolean</span><spanclass="tsd-signature-symbol"> = false</span></span><divclass="tsd-comment tsd-typography"><p>boolean on which queue to add to, defaults to false, and adds to phaseQueue</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">message</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>string for MessagePhase</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">callbackDelay</span>: <spanclass="tsd-signature-type">null</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>optional param for MessagePhase constructor</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">prompt</span>: <spanclass="tsd-signature-type">null</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">boolean</span></span><divclass="tsd-comment tsd-typography"><p>optional param for MessagePhase constructor</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">promptDelay</span>: <spanclass="tsd-signature-type">null</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>optional param for MessagePhase constructor</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">defer</span>: <spanclass="tsd-signature-type">null</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">boolean</span></span><divclass="tsd-comment tsd-typography"><p>boolean for which queue to add it to, false -> add to PhaseQueuePrepend, true -> nextCommandPhaseQueue</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/f460f9a0e868d7800d235267597c7de7c64e4059/src/battle-scene.ts#L2394">src/battle-scene.ts:2394</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="randBattleSeedInt"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>rand<wbr/>Battle<wbr/>Seed<wbr/>Int</span><ahref="#randBattleSeedInt"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="randBattleSeedInt.randBattleSeedInt-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">rand<wbr/>Battle<wbr/>Seed<wbr/>Int</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">range</span>, <spanclass="tsd-kind-parameter">min</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">number</span><ahref="#randBattleSeedInt.randBattleSeedInt-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>Generates a random number using the current battle's seed</p>
<p>This calls <ahref="battle.default.html#randSeedInt"class="tsd-kind-method"><code>Battle.randSeedInt</code></a>(<code>scene</code>, range, min) in <code>src/battle.ts</code>
which calls <ahref="../functions/utils.randSeedInt.html"class="tsd-kind-function"><code>randSeedInt</code></a>(range, min) in <code>src/utils.ts</code></p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">range</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>How large of a range of random numbers to choose from. If range <= 1, returns min</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">number</span></h4><p>A random integer between min and (min + range - 1)</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">removedPokemon</span>: <ahref="field_pokemon.default.html"class="tsd-signature-type tsd-kind-class">default</a></span><divclass="tsd-comment tsd-typography"><p><ahref="field_pokemon.default.html"class="tsd-kind-class"><code>Pokemon</code></a> the pokemon that is being removed from the field (flee, faint), moves to be redirected FROM</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">allyPokemon</span>: <ahref="field_pokemon.default.html"class="tsd-signature-type tsd-kind-class">default</a></span><divclass="tsd-comment tsd-typography"><p><ahref="field_pokemon.default.html"class="tsd-kind-class"><code>Pokemon</code></a> the pokemon that will have the moves be redirected TO</p>
Useful for MEs/Challenges that remove Pokemon from the player party temporarily or permanently</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">pokemon</span>: <ahref="field_pokemon.PlayerPokemon.html"class="tsd-signature-type tsd-kind-class">PlayerPokemon</a></span><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">destroy</span>: <spanclass="tsd-signature-type">boolean</span><spanclass="tsd-signature-symbol"> = true</span></span><divclass="tsd-comment tsd-typography"><p>Default true. If true, will destroy the <ahref="field_pokemon.PlayerPokemon.html"class="tsd-kind-class"><code>PlayerPokemon</code></a> after removing</p>
If the recepient already has the maximum amount allowed for this item, the transfer is cancelled.
The quantity to transfer is automatically capped at how much the recepient can take before reaching the maximum stack size for the item.
A transfer that moves a quantity smaller than what is specified in the transferQuantity parameter is still considered successful.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">itemModifier</span>: <ahref="modifier_modifier.PokemonHeldItemModifier.html"class="tsd-signature-type tsd-kind-class">PokemonHeldItemModifier</a></span><divclass="tsd-comment tsd-typography"><p><ahref="modifier_modifier.PokemonHeldItemModifier.html"class="tsd-kind-class"><code>PokemonHeldItemModifier</code></a> item to transfer (represents the whole stack)</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">target</span>: <ahref="field_pokemon.default.html"class="tsd-signature-type tsd-kind-class">default</a></span><divclass="tsd-comment tsd-typography"><p><ahref="field_pokemon.default.html"class="tsd-kind-class"><code>Pokemon</code></a> pokemon recepient in this transfer</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">transferQuantity</span>: <spanclass="tsd-signature-type">number</span><spanclass="tsd-signature-symbol"> = 1</span></span><divclass="tsd-comment tsd-typography"><p>integer how many items of the stack to transfer. Optional, defaults to 1</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">boolean</span><spanclass="tsd-signature-symbol">></span></h4><p>true if the transfer was successful</p>
<divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/f460f9a0e868d7800d235267597c7de7c64e4059/src/battle-scene.ts#L2549">src/battle-scene.ts:2549</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="unshiftPhase"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>unshift<wbr/>Phase</span><ahref="#unshiftPhase"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="unshiftPhase.unshiftPhase-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">unshift<wbr/>Phase</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">phase</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">void</span><ahref="#unshiftPhase.unshiftPhase-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>Adds Phase to the end of phaseQueuePrepend, or at phaseQueuePrependSpliceIndex</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">phase</span>: <ahref="phase.Phase.html"class="tsd-signature-type tsd-kind-class">Phase</a></span><divclass="tsd-comment tsd-typography"><p><ahref="phase.Phase.html"class="tsd-kind-class"><code>Phase</code></a> the phase to add</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/f460f9a0e868d7800d235267597c7de7c64e4059/src/battle-scene.ts#L2238">src/battle-scene.ts:2238</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="update"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>update</span><ahref="#update"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="update.update-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">update</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">void</span><ahref="#update.update-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>This method should be overridden by your own Scenes.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">duration</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>The time for this label to fade in, if it is not already visible.</p>
