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

19 lines
21 KiB
HTML
Raw Normal View History

[skip ci] Deploy docs
2024-08-17 17:01: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>MoveHelper | 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/test_utils_helpers_moveHelper.html">test/utils/helpers/moveHelper</a></li><li><a href="test_utils_helpers_moveHelper.MoveHelper.html">MoveHelper</a></li></ul><h1>Class MoveHelper</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Helper to handle a Pokemon's move</p>
[skip ci] Deploy docs
2024-09-01 22:17:02 +00:00
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a href="../hierarchy.html#test/utils/helpers/moveHelper.MoveHelper">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="test_utils_helpers_gameManagerHelper.GameManagerHelper.html" class="tsd-signature-type tsd-kind-class">GameManagerHelper</a><ul class="tsd-hierarchy"><li><span class="target">MoveHelper</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/86fe4dd888c1ad54e4939fb24a30f477fd0b1133/src/test/utils/helpers/moveHelper.ts#L14">src/test/utils/helpers/moveHelper.ts:14</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="test_utils_helpers_moveHelper.MoveHelper.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-08-17 17:01:18 +00:00
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="test_utils_helpers_moveHelper.MoveHelper.html#game" 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>game</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="test_utils_helpers_moveHelper.MoveHelper.html#forceHit" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>force<wbr/>Hit</span></a>
<a href="test_utils_helpers_moveHelper.MoveHelper.html#forceMiss" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>force<wbr/>Miss</span></a>
[skip ci] Deploy docs
2024-09-01 22:17:02 +00:00
<a href="test_utils_helpers_moveHelper.MoveHelper.html#select" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>select</span></a>
</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_MoveHelper" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Move<wbr/>Helper</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">game</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="test_utils_helpers_moveHelper.MoveHelper.html" class="tsd-signature-type tsd-kind-class">MoveHelper</a><a href="#constructor.new_MoveHelper" 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">game</span>: <a href="test_utils_gameManager.default.html" class="tsd-signature-type tsd-kind-class">default</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="test_utils_helpers_moveHelper.MoveHelper.html" class="tsd-signature-type tsd-kind-class">MoveHelper</a></h4><aside class="tsd-sources"><p>Inherited from <a href="test_utils_helpers_gameManagerHelper.GameManagerHelper.html">GameManagerHelper</a>.<a href="test_utils_helpers_gameManagerHelper.GameManagerHelper.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/86fe4dd888c1ad54e4939fb24a30f477fd0b1133/src/test/utils/helpers/gameManagerHelper.ts#L9">src/test/utils/helpers/gameManagerHelper.ts:9</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="game" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Protected</code> <code class="tsd-tag">Readonly</code><span>game</span><a href="#game" 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">game</span><span class="tsd-signature-symbol">:</span> <a href="test_utils_gameManager.default.html" class="tsd-signature-type tsd-kind-class">default</a></div><aside class="tsd-sources"><p>Inherited from <a href="test_utils_helpers_gameManagerHelper.GameManagerHelper.html">GameManagerHelper</a>.<a href="test_utils_helpers_gameManagerHelper.GameManagerHelper.html#game">game</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/86fe4dd888c1ad54e4939fb24a30f477fd0b1133/src/test/utils/helpers/gameManagerHelper.ts#L7">src/test/utils/helpers/gameManagerHelper.ts:7</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="forceHit" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>force<wbr/>Hi
return value to <code>true</code> <a href="phases_move_effect_phase.MoveEffectPhase.html#hitCheck" class="tsd-kind-method"><code>MoveEffectPhase.hitCheck</code></a>.
[skip ci] Deploy docs
2024-08-17 17:01:18 +00:00
Used to force a move to hit.</p>
[skip ci] Deploy docs
2024-09-01 22:17:02 +00:00
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</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/86fe4dd888c1ad54e4939fb24a30f477fd0b1133/src/test/utils/helpers/moveHelper.ts#L20">src/test/utils/helpers/moveHelper.ts:20</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="forceMiss" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>force<wbr/>Miss</span><a href="#forceMiss" 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="forceMiss.forceMiss-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">force<wbr/>Miss</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">firstTargetOnly</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#forceMiss.forceMiss-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>Intercepts <code>MoveEffectPhase</code> and mocks the hitCheck's
return value to <code>false</code> <a href="phases_move_effect_phase.MoveEffectPhase.html#hitCheck" class="tsd-kind-method"><code>MoveEffectPhase.hitCheck</code></a>.
[skip ci] Deploy docs
2024-08-17 17:01:18 +00:00
Used to force a move to miss.</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">firstTargetOnly</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span><div class="tsd-comment tsd-typography"><p>Whether the move should force miss on the first target only, in the case of multi-target moves.</p>
[skip ci] Deploy docs
2024-09-01 22:17:02 +00:00
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</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/86fe4dd888c1ad54e4939fb24a30f477fd0b1133/src/test/utils/helpers/moveHelper.ts#L31">src/test/utils/helpers/moveHelper.ts:31</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="select" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>select</span><a href="#select" 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="select.select-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">select</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">move</span>, <span class="tsd-kind-parameter">pkmIndex</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">targetIndex</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="#select.select-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>Select the move to be used by the given Pokemon(-index). Triggers during the next <a href="phases_command_phase.CommandPhase.html" class="tsd-kind-class"><code>CommandPhase</code></a></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">move</span>: <a href="../enums/enums_moves.Moves.html" class="tsd-signature-type tsd-kind-enum">Moves</a></span><div class="tsd-comment tsd-typography"><p>the move to use</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">pkmIndex</span>: <span class="tsd-signature-type">0</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">1</span><span class="tsd-signature-symbol"> = 0</span></span><div class="tsd-comment tsd-typography"><p>the pokemon index. Relevant for double-battles only (defaults to 0)</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">targetIndex</span>: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../enums/battle.BattlerIndex.html" class="tsd-signature-type tsd-kind-enum">BattlerIndex</a></span><div class="tsd-comment tsd-typography"><p>The <a href="../enums/battle.BattlerIndex.html" class="tsd-kind-enum"><code>BattlerIndex</code></a> of the Pokemon to target for single-target moves, or <code>null</code> if a manual call to <code>selectTarget()</code> is required</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></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/86fe4dd888c1ad54e4939fb24a30f477fd0b1133/src/test/utils/helpers/moveHelper.ts#L48">src/test/utils/helpers/moveHelper.ts:48</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">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#game" class="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>game</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Methods"><svg width="20" height="20" viewBox="0 0 24 24"