pokerogue/main/classes/test_utils_gameManager.default.html

75 lines
63 KiB
HTML
Raw Normal View History

2024-06-07 23:34:52 +01: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/test_utils_gameManager.html">test/utils/gameManager</a></li><li><a href="test_utils_gameManager.default.html">default</a></li></ul><h1>Class default</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Class to manage the game state and transitions between phases.</p>
2024-07-08 15:15:32 +01:00
</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/1234554d74157ba4fddbf17b964476bbe59f7ca9/src/test/utils/gameManager.ts#L40">src/test/utils/gameManager.ts:40</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="test_utils_gameManager.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>
2024-06-07 23:34:52 +01:00
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="test_utils_gameManager.default.html#gameWrapper" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>game<wbr/>Wrapper</span></a>
<a href="test_utils_gameManager.default.html#inputsHandler" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>inputs<wbr/>Handler</span></a>
<a href="test_utils_gameManager.default.html#phaseInterceptor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>phase<wbr/>Interceptor</span></a>
<a href="test_utils_gameManager.default.html#scene" class="tsd-index-link"><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="test_utils_gameManager.default.html#textInterceptor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>text<wbr/>Interceptor</span></a>
2024-06-10 15:11:46 +01:00
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="test_utils_gameManager.default.html#doAttack" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>do<wbr/>Attack</span></a>
<a href="test_utils_gameManager.default.html#doKillOpponents" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>do<wbr/>Kill<wbr/>Opponents</span></a>
2024-06-10 22:36:45 +01:00
<a href="test_utils_gameManager.default.html#doSelectModifier" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>do<wbr/>Select<wbr/>Modifier</span></a>
2024-06-17 23:06:36 +01:00
<a href="test_utils_gameManager.default.html#doSelectTarget" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>do<wbr/>Select<wbr/>Target</span></a>
2024-06-12 19:50:38 +01:00
<a href="test_utils_gameManager.default.html#doSwitchPokemon" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>do<wbr/>Switch<wbr/>Pokemon</span></a>
2024-06-10 15:11:46 +01:00
<a href="test_utils_gameManager.default.html#endPhase" 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<wbr/>Phase</span></a>
2024-06-07 23:34:52 +01:00
<a href="test_utils_gameManager.default.html#exportSaveToTest" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>export<wbr/>Save<wbr/>To<wbr/>Test</span></a>
2024-06-12 02:42:39 +01:00
<a href="test_utils_gameManager.default.html#forceOpponentToSwitch" 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/>Opponent<wbr/>To<wbr/>Switch</span></a>
2024-06-07 23:34:52 +01:00
<a href="test_utils_gameManager.default.html#importData" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>import<wbr/>Data</span></a>
<a href="test_utils_gameManager.default.html#isCurrentMode" 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/>Current<wbr/>Mode</span></a>
<a href="test_utils_gameManager.default.html#isCurrentPhase" 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/>Current<wbr/>Phase</span></a>
<a href="test_utils_gameManager.default.html#isVictory" 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/>Victory</span></a>
2024-06-10 15:11:46 +01:00
<a href="test_utils_gameManager.default.html#killPokemon" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>kill<wbr/>Pokemon</span></a>
2024-06-07 23:34:52 +01:00
<a href="test_utils_gameManager.default.html#onNextPrompt" 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/>Next<wbr/>Prompt</span></a>
<a href="test_utils_gameManager.default.html#runToSummon" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>run<wbr/>To<wbr/>Summon</span></a>
<a href="test_utils_gameManager.default.html#runToTitle" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>run<wbr/>To<wbr/>Title</span></a>
<a href="test_utils_gameManager.default.html#setMode" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Mode</span></a>
<a href="test_utils_gameManager.default.html#startBattle" 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<wbr/>Battle</span></a>
2024-06-10 15:11:46 +01:00
<a href="test_utils_gameManager.default.html#toNextTurn" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>Next<wbr/>Turn</span></a>
<a href="test_utils_gameManager.default.html#toNextWave" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>Next<wbr/>Wave</span></a>
2024-06-07 23:34:52 +01:00
<a href="test_utils_gameManager.default.html#waitMode" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>wait<wbr/>Mode</span></a>
</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_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">phaserGame</span>, <span class="tsd-kind-parameter">bypassLogin</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="test_utils_gameManager.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-comment tsd-typography"><p>Creates an instance of GameManager.</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">phaserGame</span>: <span class="tsd-signature-type">Game</span></span><div class="tsd-comment tsd-typography"><p>The Phaser game instance.</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">bypassLogin</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></span><div class="tsd-comment tsd-typography"><p>Whether to bypass the login phase.</p>
2024-07-08 15:15:32 +01:00
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="test_utils_gameManager.default.html" class="tsd-signature-type tsd-kind-class">default</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/1234554d74157ba4fddbf17b964476bbe59f7ca9/src/test/utils/gameManager.ts#L52">src/test/utils/gameManager.ts:52</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"><a id="gameWrapper" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>game<wbr/>Wrapper</span><a href="#gameWrapper" 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<wbr/>Wrapper</span><span class="tsd-signature-symbol">:</span> <a href="test_utils_gameWrapper.default.html" class="tsd-signature-type tsd-kind-class">default</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/1234554d74157ba4fddbf17b964476bbe59f7ca9/src/test/utils/gameManager.ts#L41">src/test/utils/gameManager.ts:41</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="inputsHandler" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>inputs<wbr/>Handler</span><a href="#inputsHandler" 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">inputs<wbr/>Handler</span><span class="tsd-signature-symbol">:</span> <a href="test_utils_inputsHandler.default.html" class="tsd-signature-type tsd-kind-class">default</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/1234554d74157ba4fddbf17b964476bbe59f7ca9/src/test/utils/gameManager.ts#L45">src/test/utils/gameManager.ts:45</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="phaseInterceptor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>phase<wbr/>Interceptor</span><a href="#phaseInterceptor" 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">phase<wbr/>Interceptor</span><span class="tsd-signature-symbol">:</span> <a href="test_utils_phaseInterceptor.default.html" class="tsd-signature-type tsd-kind-class">default</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/1234554d74157ba4fddbf17b964476bbe59f7ca9/src/test/utils/gameManager.ts#L43">src/test/utils/gameManager.ts:43</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="scene" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/1234554d74157ba4fddbf17b964476bbe59f7ca9/src/test/utils/gameManager.ts#L42">src/test/utils/gameManager.ts:42</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="textInterceptor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>text<wbr/>Interceptor</span><a href="#textInterceptor" 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">text<wbr/>Interceptor</span><span class="tsd-si
2024-06-10 22:36:45 +01: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">movePosition</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>the index of the move in the pokemon&#39;s moveset array</p>
2024-07-08 15:15:32 +01:00
</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/1234554d74157ba4fddbf17b964476bbe59f7ca9/src/test/utils/gameManager.ts#L166">src/test/utils/gameManager.ts:166</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="doKillOpponents" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>do<wbr/>Kill<wbr/>Opponents</span><a href="#doKillOpponents" 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="doKillOpponents.doKillOpponents-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">do<wbr/>Kill<wbr/>Opponents</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="#doKillOpponents.doKillOpponents-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>Faint all opponents currently on the field</p>
</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/1234554d74157ba4fddbf17b964476bbe59f7ca9/src/test/utils/gameManager.ts#L189">src/test/utils/gameManager.ts:189</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="doSelectModifier" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>do<wbr/>Select<wbr/>Modifier</span><a href="#doSelectModifier" 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="doSelectModifier.doSelectModifier-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">do<wbr/>Select<wbr/>Modifier</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="#doSelectModifier.doSelectModifier-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>Emulate selecting a modifier (item)</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/1234554d74157ba4fddbf17b964476bbe59f7ca9/src/test/utils/gameManager.ts#L197">src/test/utils/gameManager.ts:197</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="doSelectTarget" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>do<wbr/>Select<wbr/>Target</span><a href="#doSelectTarget" 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="doSelectTarget.doSelectTarget-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">do<wbr/>Select<wbr/>Target</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-type">void</span><a href="#doSelectTarget.doSelectTarget-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>Emulate a player&#39;s target selection after an attack is chosen,
2024-06-17 23:06:36 +01:00
usually called after <a href="test_utils_gameManager.default.html#doAttack" class="tsd-kind-method"><code>doAttack</code></a> in a double battle.</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">targetIndex</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 index of the attack target</p>
2024-07-08 15:15:32 +01:00
</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/1234554d74157ba4fddbf17b964476bbe59f7ca9/src/test/utils/gameManager.ts#L180">src/test/utils/gameManager.ts:180</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="doSwitchPokemon" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>do<wbr/>Switch<wbr/>Pokemon</span><a href="#doSwitchPokemon" 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="doSwitchPokemon.doSwitchPokemon-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">do<wbr/>Switch<wbr/>Pokemon</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">pokemonIndex</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#doSwitchPokemon.doSwitchPokemon-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>Switch pokemon and transition to the enemy command phase</p>
2024-06-12 19:50:38 +01: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">pokemonIndex</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>the index of the pokemon in your party to switch to</p>
2024-07-08 15:15:32 +01:00
</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/1234554d74157ba4fddbf17b964476bbe59f7ca9/src/test/utils/gameManager.ts#L310">src/test/utils/gameManager.ts:310</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="endPhase" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>end<wbr/>Phase</span><a href="#endPhase" 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="endPhase.endPhase-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">end<wbr/>Phase</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="#endPhase.endPhase-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>Ends the current 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"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/1234554d74157ba4fddbf17b964476bbe59f7ca9/src/test/utils/gameManager.ts#L86">src/test/utils/gameManager.ts:86</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="exportSaveToTest" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>export<wbr/>Save<wbr/>To<wbr/>Test</span><a href="#exportSaveToTest" 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="exportSaveToTest.exportSaveToTest-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">export<wbr/>Save<wbr/>To<wbr/>Test</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">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#exportSaveToTest.exportSaveToTest-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>Exports the save data to import it in a test game.</p>
2024-06-07 23:34:52 +01: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">string</span><span class="tsd-signature-symbol">&gt;</span></h4><p>A promise that resolves with the exported save data.</p>
2024-07-08 15:15:32 +01:00
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/1234554d74157ba4fddbf17b964476bbe59f7ca9/src/test/utils/gameManager.ts#L265">src/test/utils/gameManager.ts:265</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="forceOpponentToSwitch" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>force<wbr/>Opponent<wbr/>To<wbr/>Switch</span><a href="#forceOpponentToSwitch" 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="forceOpponentToSwitch.forceOpponentToSwitch-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">force<wbr/>Opponent<wbr/>To<wbr/>Switch</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="#forceOpponentToSwitch.forceOpponentToSwitch-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"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/1234554d74157ba4fddbf17b964476bbe59f7ca9/src/test/utils/gameManager.ts#L209">src/test/utils/gameManager.ts:209</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="importData" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>import<wbr/>Data</span><a href="#importData" 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="importData.importData-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">import<wbr/>Data</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">path</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-symbol">[</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span><a href="#importData.importData-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>Imports game data from a file.</p>
2024-06-07 23:34:52 +01: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">path</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The path to the data file.</p>
</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-symbol">[</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span></h4><p>A promise that resolves with a tuple containing a boolean indicating success and an integer status code.</p>
2024-07-08 15:15:32 +01:00
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/1234554d74157ba4fddbf17b964476bbe59f7ca9/src/test/utils/gameManager.ts#L281">src/test/utils/gameManager.ts:281</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="isCurrentMode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Current<wbr/>Mode</span><a href="#isCurrentMode" 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="isCurrentMode.isCurrentMode-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">is<wbr/>Current<wbr/>Mode</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">mode</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#isCurrentMode.isCurrentMode-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 if the current mode matches the target mode.</p>
2024-06-07 23:34:52 +01: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">mode</span>: <a href="../enums/ui_ui.Mode.html" class="tsd-signature-type tsd-kind-enum">Mode</a></span><div class="tsd-comment tsd-typography"><p>The target mode.</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>True if the current mode matches the target mode, otherwise false.</p>
2024-07-08 15:15:32 +01:00
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/1234554d74157ba4fddbf17b964476bbe59f7ca9/src/test/utils/gameManager.ts#L257">src/test/utils/gameManager.ts:257</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="isCurrentPhase" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Current<wbr/>Phase</span><a href="#isCurrentPhase" 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="isCurrentPhase.isCurrentPhase-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">is<wbr/>Current<wbr/>Phase</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">phaseTarget</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#isCurrentPhase.isCurrentPhase-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 if the current phase matches the target phase.</p>
2024-06-07 23:34:52 +01: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">phaseTarget</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The target phase.</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>True if the current phase matches the target phase, otherwise false.</p>
2024-07-08 15:15:32 +01:00
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/1234554d74157ba4fddbf17b964476bbe59f7ca9/src/test/utils/gameManager.ts#L247">src/test/utils/gameManager.ts:247</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="isVictory" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Victory</span><a href="#isVictory" 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="isVictory.isVictory-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">is<wbr/>Victory</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#isVictory.isVictory-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 if the player has won the battle.</p>
2024-06-07 23:34:52 +01:00
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>True if the player has won, otherwise false.</p>
2024-07-08 15:15:32 +01:00
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/1234554d74157ba4fddbf17b964476bbe59f7ca9/src/test/utils/gameManager.ts#L238">src/test/utils/gameManager.ts:238</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="killPokemon" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>kill<wbr/>Pokemon</span><a href="#killPokemon" 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="killPokemon.killPokemon-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">kill<wbr/>Pokemon</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">pokemon</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="#killPokemon.killPokemon-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">pokemon</span>: <a href="field_pokemon.PlayerPokemon.html" class="tsd-signature-type tsd-kind-class">PlayerPokemon</a><span class="tsd-signature-symbol"> | </span><a href="field_pokemon.EnemyPokemon.html" class="tsd-signature-type tsd-kind-class">EnemyPokemon</a></span></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><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/1234554d74157ba4fddbf17b964476bbe59f7ca9/src/test/utils/gameManager.ts#L295">src/test/utils/gameManager.ts:295</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="onNextPrompt" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>on<wbr/>Next<wbr/>Prompt</span><a href="#onNextPrompt" 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="onNextPrompt.onNextPrompt-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">on<wbr/>Next<wbr/>Prompt</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">phaseTarget</span>, <span class="tsd-kind-parameter">mode</span>, <span class="tsd-kind-parameter">callback</span>, <span class="tsd-kind-parameter">expireFn</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">awaitingActionInput</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="#onNextPrompt.onNextPrompt-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>Adds an action to be executed on the next prompt.</p>
2024-06-07 23:34:52 +01: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">phaseTarget</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The target phase.</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">mode</span>: <a href="../enums/ui_ui.Mode.html" class="tsd-signature-type tsd-kind-enum">Mode</a></span><div class="tsd-comment tsd-typography"><p>The mode to wait for.</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">callback</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></span><div class="tsd-comment tsd-typography"><p>The callback to execute.</p>
</div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><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></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">expireFn</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></span><div class="tsd-comment tsd-typography"><p>Optional function to determine if the prompt has expired.</p>
2024-07-08 15:15:32 +01:00
</div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><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></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li><li><span><span class="tsd-kind-parameter">awaitingActionInput</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span></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/1234554d74157ba4fddbf17b964476bbe59f7ca9/src/test/utils/gameManager.ts#L97">src/test/utils/gameManager.ts:97</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="runToSummon" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>run<wbr/>To<wbr/>Summon</span><a href="#runToSummon" 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="runToSummon.runToSummon-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">run<wbr/>To<wbr/>Summon</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">species</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="#runToSummon.runToSummon-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>Runs the game to the summon phase.</p>
2024-06-13 23:45:37 +01:00
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">species</span>: <a href="../enums/enums_species.Species.html" class="tsd-signature-type tsd-kind-enum">Species</a><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>Optional array of species to summon.</p>
2024-06-07 23:34:52 +01: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><p>A promise that resolves when the summon phase is reached.</p>
2024-07-08 15:15:32 +01:00
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/1234554d74157ba4fddbf17b964476bbe59f7ca9/src/test/utils/gameManager.ts#L126">src/test/utils/gameManager.ts:126</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="runToTitle" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>run<wbr/>To<wbr/>Title</span><a href="#runToTitle" 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="runToTitle.runToTitle-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">run<wbr/>To<wbr/>Title</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="#runToTitle.runToTitle-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>Runs the game to the title phase.</p>
2024-06-07 23:34:52 +01: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><p>A promise that resolves when the title phase is reached.</p>
2024-07-08 15:15:32 +01:00
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/1234554d74157ba4fddbf17b964476bbe59f7ca9/src/test/utils/gameManager.ts#L105">src/test/utils/gameManager.ts:105</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="setMode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Mode</span><a href="#setMode" 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="setMode.setMode-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set<wbr/>Mode</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">mode</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setMode.setMode-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>Sets the game mode.</p>
2024-06-07 23:34:52 +01: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">mode</span>: <a href="../enums/ui_ui.Mode.html" class="tsd-signature-type tsd-kind-enum">Mode</a></span><div class="tsd-comment tsd-typography"><p>The mode to set.</p>
2024-07-08 15:15:32 +01:00
</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/1234554d74157ba4fddbf17b964476bbe59f7ca9/src/test/utils/gameManager.ts#L67">src/test/utils/gameManager.ts:67</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="startBattle" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>start<wbr/>Battle</span><a href="#startBattle" 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="startBattle.startBattle-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">start<wbr/>Battle</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">species</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="#startBattle.startBattle-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>Transitions to the start of a battle.</p>
2024-06-13 23:45:37 +01:00
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">species</span>: <a href="../enums/enums_species.Species.html" class="tsd-signature-type tsd-kind-enum">Species</a><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>Optional array of species to start the battle with.</p>
2024-06-07 23:34:52 +01: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><p>A promise that resolves when the battle is started.</p>
2024-07-08 15:15:32 +01:00
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/1234554d74157ba4fddbf17b964476bbe59f7ca9/src/test/utils/gameManager.ts#L145">src/test/utils/gameManager.ts:145</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="toNextTurn" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>Next<wbr/>Turn</span><a href="#toNextTurn" 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="toNextTurn.toNextTurn-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>Next<wbr/>Turn</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="#toNextTurn.toNextTurn-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>Transition to the next upcoming <a href="phases.CommandPhase.html" class="tsd-kind-class"><code>CommandPhase</code></a></p>
</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/1234554d74157ba4fddbf17b964476bbe59f7ca9/src/test/utils/gameManager.ts#L218">src/test/utils/gameManager.ts:218</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="toNextWave" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>Next<wbr/>Wave</span><a href="#toNextWave" 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="toNextWave.toNextWave-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>Next<wbr/>Wave</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="#toNextWave.toNextWave-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>Emulate selecting a modifier (item) and transition to the next upcoming <a href="phases.CommandPhase.html" class="tsd-kind-class"><code>CommandPhase</code></a></p>
</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/1234554d74157ba4fddbf17b964476bbe59f7ca9/src/test/utils/gameManager.ts#L223">src/test/utils/gameManager.ts:223</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="waitMode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>wait<wbr/>Mode</span><a href="#waitMode" 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="waitMode.waitMode-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">wait<wbr/>Mode</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">mode</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="#waitMode.waitMode-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>Waits until the specified mode is set.</p>
2024-06-07 23:34:52 +01: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">mode</span>: <a href="../enums/ui_ui.Mode.html" class="tsd-signature-type tsd-kind-enum">Mode</a></span><div class="tsd-comment tsd-typography"><p>The mode to wait for.</p>
</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><p>A promise that resolves when the mode is set.</p>
2024-07-08 15:15:32 +01:00
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/1234554d74157ba4fddbf17b964476bbe59f7ca9/src/test/utils/gameManager.ts#L76">src/test/utils/gameManager.ts:76</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-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"><h4 class="uppercase">Member Visibility</h4><form><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-private" name="private"/><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>Private</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></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><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-index-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"><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><a href="#gameWrapper" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>game<wbr/>Wrapper</span></a><a href="#inputsHandler" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>inputs<wbr/>Handler</span></a><a href="#phaseInterceptor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>phase<wbr/>Interceptor</span></a><a href="#scene" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>sce