<!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_run_history_ui_handler.html">ui/run-history-ui-handler</a></li><li><ahref="ui_run_history_ui_handler.default.html">default</a></li></ul><h1>Class default</h1></div><sectionclass="tsd-panel tsd-comment"><divclass="tsd-comment tsd-typography"><p>RunHistoryUiHandler handles the UI of the Run History Menu
Run History itself is broken into an array of RunEntryContainer objects that can show the user basic details about their run and allow them to access more details about their run through cursor action.
It navigates similarly to the UI of the save slot select menu.
The only valid input buttons are Button.ACTION and Button.CANCEL.</p>
</div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">void</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Overrides <ahref="ui_message_ui_handler.default.html">default</a>.<ahref="ui_message_ui_handler.default.html#clear">clear</a></p><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/e5af2dc49a51500144cef94bc5e1e6acdba54246/src/ui/run-history-ui-handler.ts#L226">src/ui/run-history-ui-handler.ts:226</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited"><aid="clearText"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>clear<wbr/>Text</span><ahref="#clearText"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="clearText.clearText-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">clear<wbr/>Text</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">void</span><ahref="#clearText.clearText-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"><p>Inherited from <ahref="ui_message_ui_handler.default.html">default</a>.<ahref="ui_message_ui_handler.default.html#clearText">clearText</a></p><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/e5af2dc49a51500144cef94bc5e1e6acdba54246/src/ui/message-ui-handler.ts#L234">src/ui/message-ui-handler.ts:234</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited"><aid="getCursor"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>get<wbr/>Cursor</span><ahref="#getCursor"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="getCursor.getCursor-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">get<wbr/>Cursor</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">number</span><ahref="#getCursor.getCursor-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">number</span></h4><asideclass="tsd-sources"><p>Inherited from <ahref="ui_message_ui_handler.default.html">default</a>.<ahref="ui_message_ui_handler.default.html#getCursor">getCursor</a></p><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/e5af2dc49a51500144cef94bc5e1e6acdba54246/src/ui/ui-handler.ts#L42">src/ui/ui-handler.ts:42</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited"><aid="getTextColor"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>get<wbr/>Text<wbr/>Color</span><ahref="#getTextColor"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="getTextColor.getTextColor-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">get<wbr/>Text<wbr/>Color</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">style</span>, <spanclass="tsd-kind-parameter">shadow</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type
</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/e5af2dc49a51500144cef94bc5e1e6acdba54246/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/e5af2dc49a51500144cef94bc5e1e6acdba54246/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/e5af2dc49a51500144cef94bc5e1e6acdba54246/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="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="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">boolean</span><ahref="#processInput.processInput-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>Performs a certain action based on the button pressed by the user</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">button</span>: <ahref="../enums/enums_buttons.Button.html"class="tsd-signature-type tsd-kind-enum">Button</a></span><divclass="tsd-comment tsd-typography"><p>The user can navigate through the runs with Button.UP/Button.DOWN.
Button.ACTION allows the user to access more information about their runs.
