<!DOCTYPE html><htmlclass="default"lang="en"><head><metacharset="utf-8"/><metahttp-equiv="x-ua-compatible"content="IE=edge"/><title>default | pokemon-rogue-battle</title><metaname="description"content="Documentation for pokemon-rogue-battle"/><metaname="viewport"content="width=device-width, initial-scale=1"/><linkrel="stylesheet"href="../assets/style.css"/><linkrel="stylesheet"href="../assets/highlight.css"/><scriptdefersrc="../assets/main.js"></script><scriptasyncsrc="../assets/icons.js"id="tsd-icons-script"></script><scriptasyncsrc="../assets/search.js"id="tsd-search-script"></script><scriptasyncsrc="../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><headerclass="tsd-page-toolbar"><divclass="tsd-toolbar-contents container"><divclass="table-cell"id="tsd-search"data-base=".."><divclass="field"><labelfor="tsd-search-field"class="tsd-widget tsd-toolbar-icon search no-caption"><svgwidth="16"height="16"viewBox="0 0 16 16"fill="none"><usehref="../assets/icons.svg#icon-search"></use></svg></label><inputtype="text"id="tsd-search-field"aria-label="Search"/></div><divclass="field"><divid="tsd-toolbar-links"></div></div><ulclass="results"><liclass="state loading">Preparing search index...</li><liclass="state failure">The search index is not available</li></ul><ahref="../index.html"class="title">pokemon-rogue-battle</a></div><divclass="table-cell"id="tsd-widgets"><ahref="#"class="tsd-widget tsd-toolbar-icon menu no-caption"data-toggle="menu"aria-label="Menu"><svgwidth="16"height="16"viewBox="0 0 16 16"fill="none"><usehref="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><divclass="container container-main"><divclass="col-content"><divclass="tsd-page-title"><ulclass="tsd-breadcrumb"><li><ahref="../index.html">pokemon-rogue-battle</a></li><li><ahref="../modules/ui_save_slot_select_ui_handler.html">ui/save-slot-select-ui-handler</a></li><li><ahref="ui_save_slot_select_ui_handler.default.html">default</a></li></ul><h1>Class default</h1></div><sectionclass="tsd-panel tsd-comment"><divclass="tsd-comment tsd-typography"><p>A basic abstract class to act as a holder and processor for UI elements.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">container</span>: <spanclass="tsd-signature-type">Container</span></span><divclass="tsd-comment tsd-typography"><p>the container to add the sprite to</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">void</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from <ahref="ui_message_ui_handler.default.html">default</a>.<ahref="ui_message_ui_handler.default.html#initPromptSprite">initPromptSprite</a></p><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/9a56f080db2405010240ff0273328973ec3c78b5/src/ui/message-ui-handler.ts#L24">src/ui/message-ui-handler.ts:24</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited"><aid="initTutorialOverlay"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>init<wbr/>Tutorial<wbr/>Overlay</span><ahref="#initTutorialOverlay"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited"><liclass="tsd-signature tsd-anchor-link"><aid="initTutorialOverlay.initTutorialOverlay-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">init<wbr/>Tutorial<wbr/>Overlay</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">container</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">void</span><ahref="#initTutorialOverlay.initTutorialOverlay-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Create a semi transparent overlay that will get shown during tutorials</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">container</span>: <spanclass="tsd-signature-type">Container</span></span><divclass="tsd-comment tsd-typography"><p>the container to add the overlay to</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">void</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from <ahref="ui_message_ui_handler.default.html">default</a>.<ahref="ui_message_ui_handler.default.html#initTutorialOverlay">initTutorialOverlay</a></p><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/9a56f080db2405010240ff0273328973ec3c78b5/src/ui/awaitable-ui-handler.ts#L33">src/ui/awaitable-ui-handler.ts:33</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited"><aid="isTextAnimationInProgress"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>is<wbr/>Text<wbr/>Animation<wbr/>In<wbr/>Progress</span><ahref="#isTextAnimationInProgress"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited"><liclass="tsd-signature tsd-anchor-link"><aid="isTextAnimationInProgress.isTextAnimationInProgress-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">is<wbr/>Text<wbr/>Animation<wbr/>In<wbr/>Progress</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">boolean</span><ahref="#isTextAnimationInProgress.isTextAnimationInProgress-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">boolean</span></h4><asideclass="tsd-sources"><p>Inherited from <ahref="ui_message_ui_handler.default.html">default</a>.<ahref="ui_message_ui_handler.default.html#isTextAnimationInProgress">isTextAnimationInProgress</a></p><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/9a56f080db2405010240ff0273328973ec3c78b5/src/ui/message-ui-handler.ts#L226">src/ui/message-ui-handler.ts:226</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="populateSessionSlots"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>populate<wbr/>Session<wbr/>Slots</span><ahref="#populateSessionSlots"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass="tsd-signature tsd-anchor-link"><aid="populateSessionSlots.populateSessionSlots-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">populate<wbr/>Session<wbr/>Slots</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">void</span><ahref="#populateSessionSlots.populateSessionSlots-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">void</span></h4><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/9a56f080db2405010240ff0273328973ec3c78b5/src/ui/save-slot-select-ui-handler.ts#L186">src/ui/save-slot-select-ui-handler.ts:186</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="processInput"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>process<wbr/>Input</span><ahref="#processInput"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass="tsd-signature tsd-anchor-link"><aid="processInput.processInput-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">process<wbr/>Input</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">button</span><spanclass=
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">slotIndex</span>: <spanclass="tsd-signature-type">number</span></span></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">void</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/9a56f080db2405010240ff0273328973ec3c78b5/src/ui/save-slot-select-ui-handler.ts#L259">src/ui/save-slot-select-ui-handler.ts:259</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="setArrowVisibility"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>set<wbr/>Arrow<wbr/>Visibility</span><ahref="#setArrowVisibility"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass="tsd-signature tsd-anchor-link"><aid="setArrowVisibility.setArrowVisibility-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">set<wbr/>Arrow<wbr/>Visibility</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">hasData</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">void</span><ahref="#setArrowVisibility.setArrowVisibility-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Helper function that checks if the session slot involved holds data or not</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">hasData</span>: <spanclass="tsd-signature-type">boolean</span></span><divclass="tsd-comment tsd-typography"><p><code>true</code> if session slot contains data | 'false' if not</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">void</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/9a56f080db2405010240ff0273328973ec3c78b5/src/ui/save-slot-select-ui-handler.ts#L270">src/ui/save-slot-select-ui-handler.ts:270</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="setCursor"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>set<wbr/>Cursor</span><ahref="#setCursor"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass="tsd-signature tsd-anchor-link"><aid="setCursor.setCursor-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">set<wbr/>Cursor</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">cursor</span>, <spanclass="tsd-kind-parameter">prevSlotIndex</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">boolean</span><ahref="#setCursor.setCursor-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Move the cursor to a new position and update the view accordingly</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">cursor</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>the new cursor position, between <code>0</code> and <code>SLOTS_ON_SCREEN - 1</code></p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">prevSlotIndex</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>index of the previous session occupied by the cursor, between <code>0</code> and <code>SESSION_SLOTS_COUNT - 1</code> - optional</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">boolean</span></h4><p><code>true</code> if the cursor position has changed | <code>false</code> if it has not</p>
</div><asideclass="tsd-sources"><p>Inherited from <ahref="ui_message_ui_handler.default.html">default</a>.<ahref="ui_message_ui_handler.default.html#setMouseCursorStyle">setMouseCursorStyle</a></p><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/9a56f080db2405010240ff0273328973ec3c78b5/src/ui/ui-handler.ts#L60">src/ui/ui-handler.ts:60</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="setScrollCursor"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>set<wbr/>Scroll<wbr/>Cursor</span><ahref="#setScrollCursor"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass="tsd-signature tsd-anchor-link"><aid="setScrollCursor.setScrollCursor-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">set<wbr/>Scroll<wbr/>Cursor</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">scrollCursor</span>, <spanclass="tsd-kind-parameter">prevSlotIndex</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">boolean</span><ahref="#setScrollCursor.setScrollCursor-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Move the scrolling cursor to a new position and update the view accordingly</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">scrollCursor</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>the new cursor position, between <code>0</code> and <code>SESSION_SLOTS_COUNT - SLOTS_ON_SCREEN</code></p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">prevSlotIndex</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>index of the previous slot occupied by the cursor, between <code>0</code> and <code>SESSION_SLOTS_COUNT-1</code> - optional</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">boolean</span></h4><p><code>true</code> if the cursor position has changed | <code>false</code> if it has not</p>
