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

50 lines
66 KiB
HTML
Raw Normal View History

[skip ci] Deploy docs
2024-10-27 04:06:25 +00:00
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>default | 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/battle.html">battle</a></li><li><a href="battle.default.html">default</a></li></ul><h1>Class default</h1></div><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a href="../hierarchy.html#battle.default">view full</a>)</h4><ul class="tsd-hierarchy"><li><span class="target">default</span><ul class="tsd-hierarchy"><li><a href="battle.FixedBattle.html" class="tsd-signature-type tsd-kind-class">FixedBattle</a></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/battle.ts#L62">src/battle.ts:62</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="battle.default.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="battle.default.html#battleScore" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>battle<wbr/>Score</span></a>
<a href="battle.default.html#battleSeed" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>battle<wbr/>Seed</span></a>
<a href="battle.default.html#battleSpec" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>battle<wbr/>Spec</span></a>
<a href="battle.default.html#battleType" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>battle<wbr/>Type</span></a>
<a href="battle.default.html#double" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>double</span></a>
<a href="battle.default.html#enemyFaints" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>enemy<wbr/>Faints</span></a>
[skip ci] Deploy docs
2024-09-27 21:52:07 +00:00
<a href="battle.default.html#enemyFaintsHistory" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>enemy<wbr/>Faints<wbr/>History</span></a>
[skip ci] Deploy docs
2024-05-31 13:57:14 +00:00
<a href="battle.default.html#enemyLevels" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>enemy<wbr/>Levels</span></a>
<a href="battle.default.html#enemyParty" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>enemy<wbr/>Party</span></a>
<a href="battle.default.html#enemySwitchCounter" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>enemy<wbr/>Switch<wbr/>Counter</span></a>
<a href="battle.default.html#escapeAttempts" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>escape<wbr/>Attempts</span></a>
<a href="battle.default.html#gameMode" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>game<wbr/>Mode</span></a>
<a href="battle.default.html#lastMove" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>last<wbr/>Move</span></a>
<a href="battle.default.html#lastUsedPokeball" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>last<wbr/>Used<wbr/>Pokeball</span></a>
<a href="battle.default.html#moneyScattered" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>money<wbr/>Scattered</span></a>
[skip ci] Deploy docs
2024-09-27 21:52:07 +00:00
<a href="battle.default.html#mysteryEncounter" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>mystery<wbr/>Encounter?</span></a>
<a href="battle.default.html#mysteryEncounterType" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>mystery<wbr/>Encounter<wbr/>Type?</span></a>
[skip ci] Deploy docs
2024-05-31 13:57:14 +00:00
<a href="battle.default.html#playerFaints" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>player<wbr/>Faints</span></a>
[skip ci] Deploy docs
2024-09-27 21:52:07 +00:00
<a href="battle.default.html#playerFaintsHistory" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>player<wbr/>Faints<wbr/>History</span></a>
[skip ci] Deploy docs
2024-05-31 13:57:14 +00:00
<a href="battle.default.html#playerParticipantIds" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>player<wbr/>Participant<wbr/>Ids</span></a>
<a href="battle.default.html#postBattleLoot" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>post<wbr/>Battle<wbr/>Loot</span></a>
<a href="battle.default.html#seenEnemyPartyMemberIds" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>seen<wbr/>Enemy<wbr/>Party<wbr/>Member<wbr/>Ids</span></a>
<a href="battle.default.html#started" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>started</span></a>
<a href="battle.default.html#trainer" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>trainer</span></a>
<a href="battle.default.html#turn" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>turn</span></a>
<a href="battle.default.html#turnCommands" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>turn<wbr/>Commands</span></a>
<a href="battle.default.html#waveIndex" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>wave<wbr/>Index</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="battle.default.html#addBattleScore" 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/>Battle<wbr/>Score</span></a>
<a href="battle.default.html#addParticipant" 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/>Participant</span></a>
<a href="battle.default.html#addPostBattleLoot" 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/>Post<wbr/>Battle<wbr/>Loot</span></a>
<a href="battle.default.html#getBattlerCount" 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/>Battler<wbr/>Count</span></a>
<a href="battle.default.html#getBgmOverride" 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/>Override</span></a>
[skip ci] Deploy docs
2024-09-27 21:52:07 +00:00
<a href="battle.default.html#getLevelForWave" 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/>Level<wbr/>For<wbr/>Wave</span></a>
[skip ci] Deploy docs
2024-05-31 13:57:14 +00:00
<a href="battle.default.html#incrementTurn" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>increment<wbr/>Turn</span></a>
[skip ci] Deploy docs
2024-09-27 21:52:07 +00:00
<a href="battle.default.html#isBattleMysteryEncounter" 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/>Battle<wbr/>Mystery<wbr/>Encounter</span></a>
[skip ci] Deploy docs
2024-05-31 13:57:14 +00:00
<a href="battle.default.html#pickUpScatteredMoney" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>pick<wbr/>Up<wbr/>Scattered<wbr/>Money</span></a>
<a href="battle.default.html#randSeedGaussForLevel" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>rand<wbr/>Seed<wbr/>Gauss<wbr/>For<wbr/>Level</span></a>
<a href="battle.default.html#randSeedInt" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>rand<wbr/>Seed<wbr/>Int</span></a>
<a href="battle.default.html#removeFaintedParticipant" 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/>Fainted<wbr/>Participant</span></a>
[skip ci] Deploy docs
2024-10-27 04:06:25 +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_default" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new default</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">gameMode</span>, <span class="tsd-kind-parameter">waveIndex</span>, <span class="tsd-kind-parameter">battleType</span>, <span class="tsd-kind-parameter">trainer</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">double</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="battle.default.html" class="tsd-signature-type tsd-kind-class">default</a><a href="#constructor.new_default" 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">gameMode</span>: <a href="game_mode.GameMode.html" class="tsd-signature-type tsd-kind-class">GameMode</a></span></li><li><span><span class="tsd-kind-parameter">waveIndex</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">battleType</span>: <a href="../enums/battle.BattleType.html" class="tsd-signature-type tsd-kind-enum">BattleType</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">trainer</span>: <a href="field_trainer.default.html" class="tsd-signature-type tsd-kind-class">default</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">double</span>: <span class="tsd-signature-type">boolean</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="battle.default.html" class="tsd-signature-type tsd-kind-class">default</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/battle.ts#L98">src/battle.ts:98</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="battleScore" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>battle<wbr/>Score</span><a href="#battleScore" 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">battle<wbr/>Score</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/battle.ts#L77">src/battle.ts:77</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="battleSeed" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>battle<wbr/>Seed</span><a href="#battleSeed" aria-label="Permalink" class="tsd
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/battle.ts#L88">src/battle.ts:88</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="enemyFaintsHistory" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>enemy<wbr/>Faints<wbr/>History</span><a href="#enemyFaintsHistory" 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">enemy<wbr/>Faints<wbr/>History</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/battle.FaintLogEntry.html" class="tsd-signature-type tsd-kind-interface">FaintLogEntry</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/battle.ts#L90">src/battle.ts:90</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="enemyLevels" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>enemy<wbr/>Levels</span><a href="#enemyLevels" 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">enemy<wbr/>Levels</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/battle.ts#L68">src/battle.ts:68</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="enemyParty" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>enemy<wbr/>Party</span><a href="#enemyParty" 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">enemy<wbr/>Party</span><span class="tsd-signature-symbol">:</span> <a href="field_pokemon.EnemyPokemon.html" class="tsd-signature-type tsd-kind-class">EnemyPokemon</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/battle.ts#L69">src/battle.ts:69</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="enemySwitchCounter" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>enemy<wbr/>Switch<wbr/>Counter</span><a href="#enemySwitchCounter" 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">enemy<wbr/>Switch<wbr/>Counter</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/battle.ts#L73">src/battle.ts:73</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="escapeAttempts" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>escape<wbr/>Attempts</span><a href="#escapeAttempts" 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">escape<wbr/>Attempts</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signatu
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/battle.ts#L94">src/battle.ts:94</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="mysteryEncounterType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>mystery<wbr/>Encounter<wbr/>Type</span><a href="#mysteryEncounterType" 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">mystery<wbr/>Encounter<wbr/>Type</span><span class="tsd-signature-symbol">?:</span> <a href="../enums/enums_mystery_encounter_type.MysteryEncounterType.html" class="tsd-signature-type tsd-kind-enum">MysteryEncounterType</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/battle.ts#L92">src/battle.ts:92</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="playerFaints" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>player<wbr/>Faints</span><a href="#playerFaints" 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">player<wbr/>Faints</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></div><div class="tsd-comment tsd-typography"><p>The number of times a Pokemon on the player's side has fainted this battle</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/battle.ts#L86">src/battle.ts:86</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="playerFaintsHistory" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>player<wbr/>Faints<wbr/>History</span><a href="#playerFaintsHistory" 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">player<wbr/>Faints<wbr/>History</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/battle.FaintLogEntry.html" class="tsd-signature-type tsd-kind-interface">FaintLogEntry</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/battle.ts#L89">src/battle.ts:89</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="playerParticipantIds" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>player<wbr/>Participant<wbr/>Ids</span><a href="#playerParticipantIds" 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">player<wbr/>Participant<wbr/>Ids</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Set</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/battle.ts#L76">src/battle.ts:76</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="postBattleLoot" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>post<wbr/>Battle<wbr/>Loot</span><a href="#postBattleLoot" 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">post<wbr/>Battle<wbr/>Loot</span><span class="tsd-signature-symbol">:</span> <a href="modifier_modifier.PokemonHeldItemModifier.html" class="tsd-signature-type tsd-kind-class">PokemonHeldItemModifier</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/battle.ts#L78">src/battle.ts:78</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="seenEnemyPartyMemberIds" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>seen<wbr/>Enemy<wbr/>Party<wbr/>Member<wbr/>Ids</span><a href="#seenEnemyPartyMemberIds" 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">seen<wbr/>Enemy<wbr/>Party<wbr/>Member<wbr/>Ids</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Set</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/battle.ts#L70">src/battle.ts:70</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="started" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>started</span><a href="#started" aria-label="Permalink" class="ts
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/battle.ts#L416">src/battle.ts:416</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="pickUpScatteredMoney" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>pick<wbr/>Up<wbr/>Scattered<wbr/>Money</span><a href="#pickUpScatteredMoney" 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="pickUpScatteredMoney.pickUpScatteredMoney-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">pick<wbr/>Up<wbr/>Scattered<wbr/>Money</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scene</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#pickUpScatteredMoney.pickUpScatteredMoney-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">scene</span>: <a href="battle_scene.default.html" class="tsd-signature-type tsd-kind-class">default</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/battle.ts#L178">src/battle.ts:178</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="randSeedGaussForLevel" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>rand<wbr/>Seed<wbr/>Gauss<wbr/>For<wbr/>Level</span><a href="#randSeedGaussForLevel" 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="randSeedGaussForLevel.randSeedGaussForLevel-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">rand<wbr/>Seed<wbr/>Gauss<wbr/>For<wbr/>Level</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#randSeedGaussForLevel.randSeedGaussForLevel-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">value</span>: <span class="tsd-signature-type">number</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/battle.ts#L143">src/battle.ts:143</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="randSeedInt" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>rand<wbr/>Seed<wbr/>Int</span><a href="#randSeedInt" 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="randSeedInt.randSeedInt-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">rand<wbr/>Seed<wbr/>Int</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-pa
[skip ci] Deploy docs
2024-09-10 22:07:25 +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">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">range</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>How large of a range of random numbers to choose from. If range &lt;= 1, returns min</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">min</span>: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></span><div class="tsd-comment tsd-typography"><p>The minimum integer to pick, default <code>0</code></p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>A random integer between min and (min + range - 1)</p>
[skip ci] Deploy docs
2024-10-27 04:06:25 +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/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/battle.ts#L390">src/battle.ts:390</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="removeFaintedParticipant" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>remove<wbr/>Fainted<wbr/>Participant</span><a href="#removeFaintedParticipant" 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="removeFaintedParticipant.removeFaintedParticipant-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">remove<wbr/>Fainted<wbr/>Participant</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">playerPokemon</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#removeFaintedParticipant.removeFaintedParticipant-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">playerPokemon</span>: <a href="field_pokemon.PlayerPokemon.html" class="tsd-signature-type tsd-kind-class">PlayerPokemon</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/battle.ts#L165">src/battle.ts:165</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">Da