pokerogue/main/classes/ui_modal_ui_handler.ModalUiHandler.html

27 lines
51 KiB
HTML
Raw Normal View History

2024-06-08 06:08:50 +01:00
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ModalUiHandler | 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/ui_modal_ui_handler.html">ui/modal-ui-handler</a></li><li><a href="ui_modal_ui_handler.ModalUiHandler.html">ModalUiHandler</a></li></ul><h1>Class ModalUiHandler<code class="tsd-tag ts-flagAbstract">Abstract</code> </h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A basic abstract class to act as a holder and processor for UI elements.</p>
2024-06-22 16:39:01 +01:00
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#ui/modal-ui-handler.ModalUiHandler">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="ui_ui_handler.default.html" class="tsd-signature-type tsd-kind-class">default</a><ul class="tsd-hierarchy"><li><span class="target">ModalUiHandler</span><ul class="tsd-hierarchy"><li><a href="ui_form_modal_ui_handler.FormModalUiHandler.html" class="tsd-signature-type tsd-kind-class">FormModalUiHandler</a></li><li><a href="ui_loading_modal_ui_handler.default.html" class="tsd-signature-type tsd-kind-class">default</a></li><li><a href="ui_outdated_modal_ui_handler.default.html" class="tsd-signature-type tsd-kind-class">default</a></li><li><a href="ui_session_reload_modal_ui_handler.default.html" class="tsd-signature-type tsd-kind-class">default</a></li><li><a href="ui_unavailable_modal_ui_handler.default.html" class="tsd-signature-type tsd-kind-class">default</a></li></ul></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/77d25d18f963568bc015a8cc4bb98ff6f9b9533c/src/ui/modal-ui-handler.ts#L12">src/ui/modal-ui-handler.ts:12</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="ui_modal_ui_handler.ModalUiHandler.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-05-31 14:57:14 +01:00
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="ui_modal_ui_handler.ModalUiHandler.html#active" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>active</span></a>
<a href="ui_modal_ui_handler.ModalUiHandler.html#buttonBgs" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>button<wbr/>Bgs</span></a>
<a href="ui_modal_ui_handler.ModalUiHandler.html#buttonContainers" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>button<wbr/>Containers</span></a>
<a href="ui_modal_ui_handler.ModalUiHandler.html#cursor" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cursor</span></a>
<a href="ui_modal_ui_handler.ModalUiHandler.html#modalBg" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>modal<wbr/>Bg</span></a>
<a href="ui_modal_ui_handler.ModalUiHandler.html#modalContainer" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>modal<wbr/>Container</span></a>
<a href="ui_modal_ui_handler.ModalUiHandler.html#mode" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>mode</span></a>
<a href="ui_modal_ui_handler.ModalUiHandler.html#scene" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>scene</span></a>
<a href="ui_modal_ui_handler.ModalUiHandler.html#titleText" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>title<wbr/>Text</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="ui_modal_ui_handler.ModalUiHandler.html#clear" 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</span></a>
<a href="ui_modal_ui_handler.ModalUiHandler.html#getButtonLabels" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Button<wbr/>Labels</span></a>
<a href="ui_modal_ui_handler.ModalUiHandler.html#getButtonTopMargin" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Button<wbr/>Top<wbr/>Margin</span></a>
<a href="ui_modal_ui_handler.ModalUiHandler.html#getCursor" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Cursor</span></a>
<a href="ui_modal_ui_handler.ModalUiHandler.html#getHeight" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Height</span></a>
<a href="ui_modal_ui_handler.ModalUiHandler.html#getMargin" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Margin</span></a>
<a href="ui_modal_ui_handler.ModalUiHandler.html#getModalTitle" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Modal<wbr/>Title</span></a>
<a href="ui_modal_ui_handler.ModalUiHandler.html#getTextColor" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Text<wbr/>Color</span></a>
<a href="ui_modal_ui_handler.ModalUiHandler.html#getUi" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Ui</span></a>
<a href="ui_modal_ui_handler.ModalUiHandler.html#getWidth" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Width</span></a>
<a href="ui_modal_ui_handler.ModalUiHandler.html#processInput" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>process<wbr/>Input</span></a>
<a href="ui_modal_ui_handler.ModalUiHandler.html#setCursor" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Cursor</span></a>
<a href="ui_modal_ui_handler.ModalUiHandler.html#setup" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>setup</span></a>
<a href="ui_modal_ui_handler.ModalUiHandler.html#show" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>show</span></a>
<a href="ui_modal_ui_handler.ModalUiHandler.html#updateContainer" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Container</span></a>
2024-06-22 16:39:01 +01:00
</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_ModalUiHandler" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Modal<wbr/>Ui<wbr/>Handler</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scene</span>, <span class="tsd-kind-parameter">mode</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ui_modal_ui_handler.ModalUiHandler.html" class="tsd-signature-type tsd-kind-class">ModalUiHandler</a><a href="#constructor.new_ModalUiHandler" 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">scene</span>: <a href="battle_scene.default.html" class="tsd-signature-type tsd-kind-class">default</a></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <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></ul></div><h4 class="tsd-returns-title">Returns <a href="ui_modal_ui_handler.ModalUiHandler.html" class="tsd-signature-type tsd-kind-class">ModalUiHandler</a></h4><aside class="tsd-sources"><p>Overrides <a href="ui_ui_handler.default.html">default</a>.<a href="ui_ui_handler.default.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/77d25d18f963568bc015a8cc4bb98ff6f9b9533c/src/ui/modal-ui-handler.ts#L19">src/ui/modal-ui-handler.ts:19</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 tsd-is-inherited"><a id="active" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>active</span><a href="#active" 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">active</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div><aside class="tsd-sources"><p>Inherited from <a href="ui_ui_handler.default.html">default</a>.<a href="ui_ui_handler.default.html#active">active</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/77d25d18f963568bc015a8cc4bb98ff6f9b9533c/src/ui/ui-handler.ts#L13">src/ui/ui-handler.ts:13</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected"><a id="buttonBgs" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>button<wbr/>Bgs</span><a href="#buttonBgs" 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">button<wbr/>Bgs</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">NineSlice</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/77d25d18f963568bc015a8cc4bb98ff6f9b9533c/src/ui/modal-ui-handler.ts#L17">src/ui/modal-ui-handler.ts:17</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected"><a id="buttonContainers" class="tsd-anc