pokerogue/main/classes/phases.MovePhase.html

22 lines
36 KiB
HTML
Raw Normal View History

2024-06-20 20:08:42 +01:00
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>MovePhase | 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.MovePhase.html">MovePhase</a></li></ul><h1>Class MovePhase</h1></div><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#phases.MovePhase">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="phases.BattlePhase.html" class="tsd-signature-type tsd-kind-class">BattlePhase</a><ul class="tsd-hierarchy"><li><span class="target">MovePhase</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/7ae6baf9a51480ee618f4d84f9c45379e513fea9/src/phases.ts#L2541">src/phases.ts:2541</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-index-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.MovePhase.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>
2024-05-31 14:57:14 +01:00
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="phases.MovePhase.html#cancelled" 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>cancelled</span></a>
<a href="phases.MovePhase.html#failed" 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>failed</span></a>
<a href="phases.MovePhase.html#followUp" 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>follow<wbr/>Up</span></a>
<a href="phases.MovePhase.html#ignorePp" 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>ignore<wbr/>Pp</span></a>
<a href="phases.MovePhase.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.MovePhase.html#pokemon" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>pokemon</span></a>
<a href="phases.MovePhase.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.MovePhase.html#targets" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>targets</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="phases.MovePhase.html#canMove" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>can<wbr/>Move</span></a>
<a href="phases.MovePhase.html#cancel" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>cancel</span></a>
<a href="phases.MovePhase.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.MovePhase.html#fail" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>fail</span></a>
<a href="phases.MovePhase.html#getEffectPhase" 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/>Effect<wbr/>Phase</span></a>
<a href="phases.MovePhase.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.MovePhase.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.MovePhase.html#showFailedText" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>show<wbr/>Failed<wbr/>Text</span></a>
<a href="phases.MovePhase.html#showMoveText" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>show<wbr/>Move<wbr/>Text</span></a>
<a href="phases.MovePhase.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>
2024-06-20 20:08:42 +01:00
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><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_MovePhase" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Move<wbr/>Phase</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scene</span>, <span class="tsd-kind-parameter">pokemon</span>, <span class="tsd-kind-parameter">targets</span>, <span class="tsd-kind-parameter">move</span>, <span class="tsd-kind-parameter">followUp</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">ignorePp</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="phases.MovePhase.html" class="tsd-signature-type tsd-kind-class">MovePhase</a><a href="#constructor.new_MovePhase" 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">pokemon</span>: <a href="field_pokemon.default.html" class="tsd-signature-type tsd-kind-class">default</a></span></li><li><span><span class="tsd-kind-parameter">targets</span>: <a href="../enums/battle.BattlerIndex.html" class="tsd-signature-type tsd-kind-enum">BattlerIndex</a><span class="tsd-signature-symbol">[]</span></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><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">followUp</span>: <span class="tsd-signature-type">boolean</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">ignorePp</span>: <span class="tsd-signature-type">boolean</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="phases.MovePhase.html" class="tsd-signature-type tsd-kind-class">MovePhase</a></h4><aside class="tsd-sources"><p>Overrides <a href="phases.BattlePhase.html">BattlePhase</a>.<a href="phases.BattlePhase.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/7ae6baf9a51480ee618f4d84f9c45379e513fea9/src/phases.ts#L2550">src/phases.ts:2550</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-protected"><a id="cancelled" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>cancelled</span><a href="#cancelled" 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">cancelled</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/7ae6baf9a51480ee618f4d84f9c45379e513fea9/src/phases.ts#L2548">src/phases.ts:2548</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected"><a id="failed" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>failed</span><a href="#
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/7ae6baf9a51480ee618f4d84f9c45379e513fea9/src/phases.ts#L2572">src/phases.ts:2572</a></li></ul></aside></li></ul></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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Overrides <a href="phases.BattlePhase.html">BattlePhase</a>.<a href="phases.BattlePhase.html#end">end</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/7ae6baf9a51480ee618f4d84f9c45379e513fea9/src/phases.ts#L2828">src/phases.ts:2828</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="fail" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>fail</span><a href="#fail" 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="fail.fail-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">fail</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="#fail.fail-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>Signifies the current move should fail but still use PP</p>
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/7ae6baf9a51480ee618f4d84f9c45379e513fea9/src/phases.ts#L2567">src/phases.ts:2567</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getEffectPhase" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Effect<wbr/>Phase</span><a href="#getEffectPhase" 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="getEffectPhase.getEffectPhase-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Effect<wbr/>Phase</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="phases.MoveEffectPhase.html" class="tsd-signature-type tsd-kind-class">MoveEffectPhase</a><a href="#getEffectPhase.getEffectPhase-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="phases.MoveEffectPhase.html" class="tsd-signature-type tsd-kind-class">MoveEffectPhase</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/7ae6baf9a51480ee618f4d84f9c45379e513fea9/src/phases.ts#L2797">src/phases.ts:2797</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="hideEnemyTrainer" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>hide<wbr/>Enemy<wbr/>Trainer</span><a href="#hideEnemyTrainer" 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="hideEnemyTrainer.hideEnemyTrainer-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">hide<wbr/>Enemy<wbr/>Trainer</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="#hideEnemyTrainer.hideEnemyTrainer-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>Inherited from <a href="phases.BattlePhase.html">BattlePhase</a>.<a href="phases.BattlePhase.html#hideEnemyTrainer">hideEnemyTrainer</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/7ae6baf9a51480ee618f4d84f9c45379e513fea9/src/phases.ts#L671">src/phases.ts:671</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