random-mirrors/pokerogue
1
0
Fork 0
mirror of https://github.com/pagefaultgames/pokerogue.git synced 2024-11-26 16:56:11 +00:00
Code Issues Packages Projects Releases Wiki Activity
e5e7f80f69
pokerogue/main/classes/phases_move_charge_phase.MoveChargePhase.html

21 lines
34 KiB
HTML
Raw Normal View History

[skip ci] Deploy docs
2024-10-26 22:31:27 +01:00
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>MoveChargePhase | 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_move_charge_phase.html">phases/move-charge-phase</a></li><li><a href="phases_move_charge_phase.MoveChargePhase.html">MoveChargePhase</a></li></ul><h1>Class MoveChargePhase</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Phase for the &quot;charging turn&quot; of two-turn moves (e.g. Dig).</p>
[skip ci] Deploy docs
2024-10-28 02:34:09 +00:00
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a href="../hierarchy.html#phases/move-charge-phase.MoveChargePhase">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="phases_pokemon_phase.PokemonPhase.html" class="tsd-signature-type tsd-kind-class">PokemonPhase</a><ul class="tsd-hierarchy"><li><span class="target">MoveChargePhase</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/5797f265a415cdaabdc639bdcf9ce949f01c24f7/src/phases/move-charge-phase.ts#L16">src/phases/move-charge-phase.ts:16</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_move_charge_phase.MoveChargePhase.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-10-26 22:31:27 +01:00
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="phases_move_charge_phase.MoveChargePhase.html#battlerIndex" 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>battler<wbr/>Index</span></a>
<a href="phases_move_charge_phase.MoveChargePhase.html#fieldIndex" class="tsd-index-link 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>
<a href="phases_move_charge_phase.MoveChargePhase.html#move" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>move</span></a>
<a href="phases_move_charge_phase.MoveChargePhase.html#player" class="tsd-index-link 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_move_charge_phase.MoveChargePhase.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>
<a href="phases_move_charge_phase.MoveChargePhase.html#targetIndex" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>target<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="phases_move_charge_phase.MoveChargePhase.html#end" class="tsd-index-link"><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_move_charge_phase.MoveChargePhase.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_move_charge_phase.MoveChargePhase.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_move_charge_phase.MoveChargePhase.html#getTargetPokemon" 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/>Target<wbr/>Pokemon</span></a>
<a href="phases_move_charge_phase.MoveChargePhase.html#getUserPokemon" 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/>User<wbr/>Pokemon</span></a>
<a href="phases_move_charge_phase.MoveChargePhase.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_move_charge_phase.MoveChargePhase.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>
<a href="phases_move_charge_phase.MoveChargePhase.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-10-28 02:34:09 +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_MoveChargePhase" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Move<wbr/>Charge<wbr/>Phase</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scene</span>, <span class="tsd-kind-parameter">battlerIndex</span>, <span class="tsd-kind-parameter">targetIndex</span>, <span class="tsd-kind-parameter">move</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="phases_move_charge_phase.MoveChargePhase.html" class="tsd-signature-type tsd-kind-class">MoveChargePhase</a><a href="#constructor.new_MoveChargePhase" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">scene</span>: <a href="battle_scene.default.html" class="tsd-signature-type tsd-kind-class">default</a></span></li><li><span><span class="tsd-kind-parameter">battlerIndex</span>: <a href="../enums/battle.BattlerIndex.html" class="tsd-signature-type tsd-kind-enum">BattlerIndex</a></span></li><li><span><span class="tsd-kind-parameter">targetIndex</span>: <a href="../enums/battle.BattlerIndex.html" class="tsd-signature-type tsd-kind-enum">BattlerIndex</a></span></li><li><span><span class="tsd-kind-parameter">move</span>: <a href="field_pokemon.PokemonMove.html" class="tsd-signature-type tsd-kind-class">PokemonMove</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="phases_move_charge_phase.MoveChargePhase.html" class="tsd-signature-type tsd-kind-class">MoveChargePhase</a></h4><aside class="tsd-sources"><p>Overrides <a href="phases_pokemon_phase.PokemonPhase.html">PokemonPhase</a>.<a href="phases_pokemon_phase.PokemonPhase.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/5797f265a415cdaabdc639bdcf9ce949f01c24f7/src/phases/move-charge-phase.ts#L22">src/phases/move-charge-phase.ts:22</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="battlerIndex" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Protected</code><span>battler<wbr/>Index</span><a href="#battlerIndex" 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">battler<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_pokemon_phase.PokemonPhase.html">PokemonPhase</a>.<a href="phases_pokemon_phase.PokemonPhase.html#battlerIndex">battlerIndex</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/5797f265a415cdaabdc639bdcf9ce949f01c24f7/src/phases/pokemon-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/5797f265a415cdaabdc639bdcf9ce949f01c24f7/src/phases/move-charge-phase.ts#L18">src/phases/move-charge-phase.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="player" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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_pokemon_phase.PokemonPhase.html">PokemonPhase</a>.<a href="phases_pokemon_phase.PokemonPhase.html#player">player</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/5797f265a415cdaabdc639bdcf9ce949f01c24f7/src/phases/pokemon-phase.ts#L8">src/phases/pokemon-phase.ts:8</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_scene.default.html" class="tsd-signature-type tsd-kind-class">default</a></div><aside class="tsd-sources"><p>Inherited from <a href="phases_pokemon_phase.PokemonPhase.html">PokemonPhase</a>.<a href="phases_pokemon_phase.PokemonPhase.html#scene">scene</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/5797f265a415cdaabdc639bdcf9ce949f01c24f7/src/phase.ts#L4">src/phase.ts:4</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="targetIndex" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>target<wbr/>Index</span><a href="#targetIndex" 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">target<wbr/>Index</span><span class="tsd-signature-symbol">:</span> <a href="../enums/battle.BattlerIndex.html" class="tsd-signature-type tsd-kind-enum">BattlerIndex</a></div><div class="tsd-comment tsd-typography"><p>The field index targeted by the move (Charging moves assume single target)</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/5797f265a415cdaabdc639bdcf9ce949f01c24f7/src/phases/move-charge-phase.ts#L20">src/phases/move-charge-phase.ts:20</a></li></ul></aside></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Methods</h2></summary><section><section class="tsd-panel tsd-member"><a id="end" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>end</span><a href="#end" 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="end.end-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">end</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="#end.end-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Checks the move's instant charge conditions, then ends this phase.</p>
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="phases_pokemon_phase.PokemonPhase.html">PokemonPhase</a>.<a href="phases_pokemon_phase.PokemonPhase.html#end">end</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/5797f265a415cdaabdc639bdcf9ce949f01c24f7/src/phases/move-charge-phase.ts#L53">src/phases/move-charge-phase.ts:53</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="executeForAll" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>execute<wbr/>For<wbr/>All</span><a href="#executeForAll" 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="executeForAll.executeForAll-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">execute<wbr/>For<wbr/>All</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">func</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#executeForAll.executeForAll-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">func</span>: <span class="tsd-signature-type">PokemonFunc</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_pokemon_phase.PokemonPhase.html">PokemonPhase</a>.<a href="phases_pokemon_phase.PokemonPhase.html#executeForAll">executeForAll</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/5797f265a415cdaabdc639bdcf9ce949f01c24f7/src/phases/field-phase.ts#L7">src/phases/field-phase.ts:7</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="getPokemon" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Pokemon</span><a href="#getPokemon" 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="getPokemon.getPokemon-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Pokemon</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="field_pokemon.default.html" class="tsd-signature-type tsd-kind-class">default</a><a href="#getPokemon.getPokemon-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 <a href="field_pokemon.default.html" class="tsd-signature-type tsd-kind-class">default</a></h4><aside class="tsd-sources"><p>Inherited from <a href="phases_pokemon_phase.PokemonPhase.html">PokemonPhase</a>.<a href="phases_pokemon_phase.PokemonPhase.html#getPokemon">getPokemon</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/5797f265a415cdaabdc639bdcf9ce949f01c24f7/src/phases/pokemon-phase.ts#L23">src/phases/pokemon-phase.ts:23</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getTargetPokemon" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Target<wbr/>Pokemon</span><a href="#getTargetPokemon" 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-signatur
Reference in New Issue Copy Permalink