pokerogue/main/classes/test_utils_phaseInterceptor.default.html

54 lines
49 KiB
HTML
Raw Normal View History

2024-09-28 03:36:23 +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_phaseInterceptor.html">test/utils/phaseInterceptor</a></li><li><a href="test_utils_phaseInterceptor.default.html">default</a></li></ul><h1>Class default</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/2b3dbcc72fb61372d832752b90fa4b2a6c03aec4/src/test/utils/phaseInterceptor.ts#L66">src/test/utils/phaseInterceptor.ts:66</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_phaseInterceptor.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-07-28 00:48:18 +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_phaseInterceptor.default.html#log" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>log</span></a>
<a href="test_utils_phaseInterceptor.default.html#phases" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>phases</span></a>
2024-06-07 23:34:52 +01:00
<a href="test_utils_phaseInterceptor.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>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="test_utils_phaseInterceptor.default.html#addToNextPrompt" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>To<wbr/>Next<wbr/>Prompt</span></a>
2024-08-17 18:01:18 +01:00
<a href="test_utils_phaseInterceptor.default.html#clearLogs" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>clear<wbr/>Logs</span></a>
2024-06-07 23:34:52 +01:00
<a href="test_utils_phaseInterceptor.default.html#initPhases" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>init<wbr/>Phases</span></a>
2024-06-13 13:43:43 +01:00
<a href="test_utils_phaseInterceptor.default.html#pop" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>pop</span></a>
2024-06-08 20:55:30 +01:00
<a href="test_utils_phaseInterceptor.default.html#rejectAll" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>reject<wbr/>All</span></a>
2024-06-07 23:34:52 +01:00
<a href="test_utils_phaseInterceptor.default.html#restoreOg" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>restore<wbr/>Og</span></a>
<a href="test_utils_phaseInterceptor.default.html#run" 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</span></a>
<a href="test_utils_phaseInterceptor.default.html#runFrom" 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/>From</span></a>
2024-06-08 20:55:30 +01:00
<a href="test_utils_phaseInterceptor.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>
2024-09-10 23:07:25 +01:00
<a href="test_utils_phaseInterceptor.default.html#shift" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>shift</span></a>
2024-06-07 23:34:52 +01:00
<a href="test_utils_phaseInterceptor.default.html#startPhase" 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/>Phase</span></a>
2024-06-10 15:11:46 +01:00
<a href="test_utils_phaseInterceptor.default.html#startPromptHandler" 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/>Prompt<wbr/>Handler</span></a>
2024-06-08 20:55:30 +01:00
<a href="test_utils_phaseInterceptor.default.html#superEndPhase" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>super<wbr/>End<wbr/>Phase</span></a>
2024-06-07 23:34:52 +01:00
<a href="test_utils_phaseInterceptor.default.html#to" 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</span></a>
2024-06-08 20:55:30 +01:00
<a href="test_utils_phaseInterceptor.default.html#unlock" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>unlock</span></a>
2024-06-07 23:34:52 +01:00
<a href="test_utils_phaseInterceptor.default.html#whenAboutToRun" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>when<wbr/>About<wbr/>To<wbr/>Run</span></a>
2024-07-28 00:48:18 +01:00
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Constructors</h2></summary><section><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_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">scene</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="test_utils_phaseInterceptor.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>Constructor to initialize the scene and properties, and to start the phase handling.</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">scene</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The scene to be managed.</p>
2024-09-28 03:36:23 +01:00
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="test_utils_phaseInterceptor.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/2b3dbcc72fb61372d832752b90fa4b2a6c03aec4/src/test/utils/phaseInterceptor.ts#L145">src/test/utils/phaseInterceptor.ts:145</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"><a id="log" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>log</span><a href="#log" 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">log</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/2b3dbcc72fb61372d832752b90fa4b2a6c03aec4/src/test/utils/phaseInterceptor.ts#L69">src/test/utils/phaseInterceptor.ts:69</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="phases" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>phases</span><a href="#phases" 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">phases</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol"> = {}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/2b3dbcc72fb61372d832752b90fa4b2a6c03aec4/src/test/utils/phaseInterceptor.ts#L68">src/test/utils/phaseInterceptor.ts:68</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> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/2b3dbcc72fb61372d832752b90fa4b2a6c03aec4/src/test/utils/phaseInterceptor.ts#L67">src/test/utils/phaseInterceptor.ts:67</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="addToNextPrompt" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>add<wbr/>To<wbr/>Next<wbr/>Prompt</span><a href="#addToNextPrompt" 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="addToNextPrompt.addToNextPrompt-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">add<wbr/>To<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
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 for the prompt.</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 of the UI.</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 function to execute.</p>
2024-08-17 18:01:18 +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><code class="tsd-tag">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>The function to determine if the prompt has expired.</p>
2024-09-28 03:36:23 +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><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/2b3dbcc72fb61372d832752b90fa4b2a6c03aec4/src/test/utils/phaseInterceptor.ts#L392">src/test/utils/phaseInterceptor.ts:392</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="clearLogs" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>clear<wbr/>Logs</span><a href="#clearLogs" 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="clearLogs.clearLogs-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">clear<wbr/>Logs</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="#clearLogs.clearLogs-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>Clears phase logs</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/2b3dbcc72fb61372d832752b90fa4b2a6c03aec4/src/test/utils/phaseInterceptor.ts#L157">src/test/utils/phaseInterceptor.ts:157</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="initPhases" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>init<wbr/>Phases</span><a href="#initPhases" 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="initPhases.initPhases-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">init<wbr/>Phases</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="#initPhases.initPhases-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>Method to initialize phases and their corresponding methods.</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/2b3dbcc72fb61372d832752b90fa4b2a6c03aec4/src/test/utils/phaseInterceptor.ts#L295">src/test/utils/phaseInterceptor.ts:295</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="pop" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>pop</span><a href="#pop" 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="pop.pop-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">pop</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="#pop.pop-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/2b3dbcc72fb61372d832752b90fa4b2a6c03aec4/src/test/utils/phaseInterceptor.ts#L271">src/test/utils/phaseInterceptor.ts:271</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="rejectAll" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>reject<wbr/>All</span><a href="#rejectAll" 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="rejectAll.rejectAll-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">reject<wbr/>All</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#rejectAll.rejectAll-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">error</span>: <span class="tsd-signature-type">any</span></span></li></ul></div><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/2b3dbcc72fb61372d832752b90fa4b2a6c03aec4/src/test/utils/phaseInterceptor.ts#L161">src/test/utils/phaseInterceptor.ts:161</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="restoreOg" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>restore<wbr/>Og</span><a href="#restoreOg" 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="restoreOg.restoreOg-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">restore<wbr/>Og</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="#restoreOg.restoreOg-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>Restores the original state of phases and clears intervals.</p>
2024-06-07 23:34:52 +01:00
<p>This function iterates through all phases and resets their <code>start</code> method to the original
function stored in <code>this.phases</code>. Additionally, it clears the <code>promptInterval</code> and <code>interval</code>.</p>
2024-09-28 03:36:23 +01:00
</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/2b3dbcc72fb61372d832752b90fa4b2a6c03aec4/src/test/utils/phaseInterceptor.ts#L408">src/test/utils/phaseInterceptor.ts:408</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="run" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>run</span><a href="#run" 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="run.run-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">run</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">phaseTarget</span>, <span class="tsd-kind-parameter">skipFn</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="#run.run-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>Method to run a phase with an optional skip function.</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 phase to run.</p>
2024-07-28 00:48:18 +01:00
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">skipFn</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>Optional skip function.</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 phase is run.</p>
2024-09-28 03:36:23 +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/2b3dbcc72fb61372d832752b90fa4b2a6c03aec4/src/test/utils/phaseInterceptor.ts#L222">src/test/utils/phaseInterceptor.ts:222</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="runFrom" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>run<wbr/>From</span><a href="#runFrom" 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="runFrom.runFrom-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">run<wbr/>From</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">phaseFrom</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="test_utils_phaseInterceptor.default.html" class="tsd-signature-type tsd-kind-class">default</a><a href="#runFrom.runFrom-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>Method to set the starting 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">phaseFrom</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The phase to start from.</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="test_utils_phaseInterceptor.default.html" class="tsd-signature-type tsd-kind-class">default</a></h4><p>The instance of the PhaseInterceptor.</p>
2024-09-28 03:36:23 +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/2b3dbcc72fb61372d832752b90fa4b2a6c03aec4/src/test/utils/phaseInterceptor.ts#L175">src/test/utils/phaseInterceptor.ts:175</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-kind-parameter">args</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="#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>m2m to set mode.</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">mode</span>: <a href="../enums/ui_ui.Mode.html" class="tsd-signature-type tsd-kind-enum">Mode</a></span></li><li><span><code class="tsd-tag">Rest</code><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/2b3dbcc72fb61372d832752b90fa4b2a6c03aec4/src/test/utils/phaseInterceptor.ts#L345">src/test/utils/phaseInterceptor.ts:345</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="shift" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>shift</span><a href="#shift" 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="shift.shift-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">shift</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">shouldRun</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="#shift.shift-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>Remove the current phase from the phase interceptor.</p>
2024-09-10 23:07:25 +01:00
<p>Do not call this unless absolutely necessary. This function is intended
for cleaning up the phase interceptor when, for whatever reason, a phase
is manually ended without using the phase interceptor.</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">shouldRun</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span><div class="tsd-comment tsd-typography"><p>Whether or not the current scene should also be run.</p>
2024-09-28 03:36:23 +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/2b3dbcc72fb61372d832752b90fa4b2a6c03aec4/src/test/utils/phaseInterceptor.ts#L285">src/test/utils/phaseInterceptor.ts:285</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="startPhase" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>start<wbr/>Phase</span><a href="#startPhase" 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="startPhase.startPhase-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">start<wbr/>Phase</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">phase</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#startPhase.startPhase-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>Method to start a phase and log it.</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">phase</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The phase to start.</p>
2024-09-28 03:36:23 +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/2b3dbcc72fb61372d832752b90fa4b2a6c03aec4/src/test/utils/phaseInterceptor.ts#L314">src/test/utils/phaseInterceptor.ts:314</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="startPromptHandler" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>start<wbr/>Prompt<wbr/>Handler</span><a href="#startPromptHandler" 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="startPromptHandler.startPromptHandler-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">start<wbr/>Prompt<wbr/>Handler</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="#startPromptHandler.startPromptHandler-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>Method to start the prompt handler.</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/2b3dbcc72fb61372d832752b90fa4b2a6c03aec4/src/test/utils/phaseInterceptor.ts#L364">src/test/utils/phaseInterceptor.ts:364</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="superEndPhase" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>super<wbr/>End<wbr/>Phase</span><a href="#superEndPhase" 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="superEndPhase.superEndPhase-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">super<wbr/>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="#superEndPhase.superEndPhase-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>Method to end a phase and log it.</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/2b3dbcc72fb61372d832752b90fa4b2a6c03aec4/src/test/utils/phaseInterceptor.ts#L334">src/test/utils/phaseInterceptor.ts:334</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="to" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to</span><a href="#to" 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="to.to-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">phaseTo</span>, <span class="tsd-kind-parameter">runTarget</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="#to.to-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>Method to transition to a 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">phaseTo</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The phase to transition to.</p>
2024-06-08 20:55:30 +01:00
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">runTarget</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></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><p>A promise that resolves when the transition is complete.</p>
2024-09-28 03:36:23 +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/2b3dbcc72fb61372d832752b90fa4b2a6c03aec4/src/test/utils/phaseInterceptor.ts#L185">src/test/utils/phaseInterceptor.ts:185</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="unlock" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>unlock</span><a href="#unlock" 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="unlock.unlock-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">unlock</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="#unlock.unlock-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/2b3dbcc72fb61372d832752b90fa4b2a6c03aec4/src/test/utils/phaseInterceptor.ts#L325">src/test/utils/phaseInterceptor.ts:325</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="whenAboutToRun" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>when<wbr/>About<wbr/>To<wbr/>Run</span><a href="#whenAboutToRun" 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="whenAboutToRun.whenAboutToRun-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">when<wbr/>About<wbr/>To<wbr/>Run</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">phaseTarget</span>, <span class="tsd-kind-parameter">skipFn</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="#whenAboutToRun.whenAboutToRun-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">phaseTarget</span>: <span class="tsd-signature-type">any</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">skipFn</span>: <span class="tsd-signature-type">any</span></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/2b3dbcc72fb61372d832752b90fa4b2a6c03aec4/src/test/utils/phaseInterceptor.ts#L256">src/test/utils/phaseInterceptor.ts:256</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 ty