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

28 lines
41 KiB
HTML
Raw Normal View History

[skip ci] Deploy docs
2024-07-27 23:48:18 +00:00
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>SwitchSummonPhase | 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/phases.html">phases</a></li><li><a href="phases.SwitchSummonPhase.html">SwitchSummonPhase</a></li></ul><h1>Class SwitchSummonPhase</h1></div><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a href="../hierarchy.html#phases.SwitchSummonPhase">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="phases.SummonPhase.html" class="tsd-signature-type tsd-kind-class">SummonPhase</a><ul class="tsd-hierarchy"><li><span class="target">SwitchSummonPhase</span><ul class="tsd-hierarchy"><li><a href="phases.ReturnPhase.html" class="tsd-signature-type tsd-kind-class">ReturnPhase</a></li></ul></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/e98ef1c757bf2c79263f25266b2ec9b784e8699c/src/phases.ts#L1552">src/phases.ts:1552</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="phases.SwitchSummonPhase.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="phases.SwitchSummonPhase.html#fieldIndex" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>field<wbr/>Index</span></a>
[skip ci] Deploy docs
2024-05-31 13:57:14 +00:00
<a href="phases.SwitchSummonPhase.html#partyMemberIndex" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>party<wbr/>Member<wbr/>Index</span></a>
<a href="phases.SwitchSummonPhase.html#player" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>player</span></a>
<a href="phases.SwitchSummonPhase.html#scene" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>scene</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="phases.SwitchSummonPhase.html#end" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>end</span></a>
<a href="phases.SwitchSummonPhase.html#executeForAll" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>execute<wbr/>For<wbr/>All</span></a>
<a href="phases.SwitchSummonPhase.html#getOrder" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Order</span></a>
<a href="phases.SwitchSummonPhase.html#getParty" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Party</span></a>
<a href="phases.SwitchSummonPhase.html#getPokemon" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Pokemon</span></a>
<a href="phases.SwitchSummonPhase.html#hideEnemyTrainer" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>hide<wbr/>Enemy<wbr/>Trainer</span></a>
<a href="phases.SwitchSummonPhase.html#onEnd" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>on<wbr/>End</span></a>
<a href="phases.SwitchSummonPhase.html#preSummon" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>pre<wbr/>Summon</span></a>
<a href="phases.SwitchSummonPhase.html#queuePostSummon" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>queue<wbr/>Post<wbr/>Summon</span></a>
<a href="phases.SwitchSummonPhase.html#showEnemyTrainer" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>show<wbr/>Enemy<wbr/>Trainer</span></a>
[skip ci] Deploy docs
2024-06-10 14:11:46 +00:00
<a href="phases.SwitchSummonPhase.html#start" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>start</span></a>
[skip ci] Deploy docs
2024-05-31 13:57:14 +00:00
<a href="phases.SwitchSummonPhase.html#summon" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>summon</span></a>
<a href="phases.SwitchSummonPhase.html#switchAndSummon" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>switch<wbr/>And<wbr/>Summon</span></a>
[skip ci] Deploy docs
2024-07-27 23:48:18 +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_SwitchSummonPhase" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Switch<wbr/>Summon<wbr/>Phase</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scene</span>, <span class="tsd-kind-parameter">fieldIndex</span>, <span class="tsd-kind-parameter">slotIndex</span>, <span class="tsd-kind-parameter">doReturn</span>, <span class="tsd-kind-parameter">batonPass</span>, <span class="tsd-kind-parameter">player</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="phases.SwitchSummonPhase.html" class="tsd-signature-type tsd-kind-class">SwitchSummonPhase</a><a href="#constructor.new_SwitchSummonPhase" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Constructor for creating a new SwitchSummonPhase</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">scene</span>: <a href="battle_scene.default.html" class="tsd-signature-type tsd-kind-class">default</a></span><div class="tsd-comment tsd-typography"><p><a href="battle_scene.default.html" class="tsd-kind-class"><code>BattleScene</code></a> the scene the phase is associated with</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">fieldIndex</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>integer representing position on the battle field</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">slotIndex</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>integer for the index of pokemon (in party of 6) to switch into</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">doReturn</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>boolean whether to render &quot;comeback&quot; dialogue</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">batonPass</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>boolean if the switch is from baton pass</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">player</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>boolean if the switch is from the player</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="phases.SwitchSummonPhase.html" class="tsd-signature-type tsd-kind-class">SwitchSummonPhase</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="phases.SummonPhase.html">SummonPhase</a>.<a href="phases.SummonPhase.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/e98ef1c757bf2c79263f25266b2ec9b784e8699c/src/phases.ts#L1568">src/phases.ts:1568</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 tsd-is-protected tsd-is-inherited"><a id="fieldIndex" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Protected</code><span>field<wbr/>Index</span><a href="#fieldIndex" 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">field<wbr/>Index</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="phases.SummonPhase.html">SummonPhase</a>.<a href="phases.SummonPhase.html#fieldIndex">fieldIndex</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/e98ef1c757bf2c79263f25266b2ec9b784e8699c/src/phases.ts#L759">src/phases.ts:759</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="partyMemberIndex" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Protected</code><span>party<wbr/>Member<wbr/>Index</span><a href="#partyMemberIndex" 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">party<wbr/>Member<wbr/>Index</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="phases.SummonPhase.html">SummonPhase</a>.<a href="phases.SummonPhase.html#partyMemberIndex">partyMemberIndex</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/e98ef1c757bf2c79263f25266b2ec9b784e8699c/src/phases.ts#L758">src/phases.ts:758</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="player" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Protected</code><span>player</span><a href="#player" 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</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="phases.SummonPhase.html">SummonPhase</a>.<a href="phases.SummonPhase.html#player">player</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/e98ef1c757bf2c79263f25266b2ec9b784e8699c/src/phases.ts#L760">src/phases.ts:760</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="scene" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Protected</code><span>scene</span><a href="#scene" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">scene</span><span class="tsd-signature-symbol">:</span> <a href="battle
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="phases.SummonPhase.html">SummonPhase</a>.<a href="phases.SummonPhase.html#preSummon">preSummon</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/e98ef1c757bf2c79263f25266b2ec9b784e8699c/src/phases.ts#L1580">src/phases.ts:1580</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="queuePostSummon" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>queue<wbr/>Post<wbr/>Summon</span><a href="#queuePostSummon" 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="queuePostSummon.queuePostSummon-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">queue<wbr/>Post<wbr/>Summon</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#queuePostSummon.queuePostSummon-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Overrides <a href="phases.SummonPhase.html">SummonPhase</a>.<a href="phases.SummonPhase.html#queuePostSummon">queuePostSummon</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/e98ef1c757bf2c79263f25266b2ec9b784e8699c/src/phases.ts#L1705">src/phases.ts:1705</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="showEnemyTrainer" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>show<wbr/>Enemy<wbr/>Trainer</span><a href="#showEnemyTrainer" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="showEnemyTrainer.showEnemyTrainer-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">show<wbr/>Enemy<wbr/>Trainer</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">trainerSlot</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#showEnemyTrainer.showEnemyTrainer-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">trainerSlot</span>: <a href="../enums/data_trainer_config.TrainerSlot.html" class="tsd-signature-type tsd-kind-enum">TrainerSlot</a><span class="tsd-signature-symbol"> = TrainerSlot.NONE</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Inherited from <a href="phases.SummonPhase.html">SummonPhase</a>.<a href="phases.SummonPhase.html#showEnemyTrainer">showEnemyTrainer</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/e98ef1c757bf2c79263f25266b2ec9b784e8699c/src/phases.ts#L655">src/phases.ts:655</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="start" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>start</span><a href="#start" 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="start.start-1" class="tsd-anchor"></