pokerogue/main/classes/ui_settings_abstract_binding_ui_handler.default.html

61 lines
66 KiB
HTML
Raw Normal View History

2024-07-28 00:48:18 +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/ui_settings_abstract_binding_ui_handler.html">ui/settings/abstract-binding-ui-handler</a></li><li><a href="ui_settings_abstract_binding_ui_handler.default.html">default</a></li></ul><h1>Class default<code class="tsd-tag">Abstract</code></h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Abstract class for handling UI elements related to button bindings.</p>
2024-08-17 20:49:01 +01:00
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a href="../hierarchy.html#ui/settings/abstract-binding-ui-handler.default">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">default</span><ul class="tsd-hierarchy"><li><a href="ui_settings_gamepad_binding_ui_handler.default.html" class="tsd-signature-type tsd-kind-class">default</a></li><li><a href="ui_settings_keyboard_binding_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/15584f8f1e5e61114f17a4da56cb6cfb34349f21/src/ui/settings/abstract-binding-ui-handler.ts#L15">src/ui/settings/abstract-binding-ui-handler.ts:15</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="ui_settings_abstract_binding_ui_handler.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-01 13:57:45 +01:00
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="ui_settings_abstract_binding_ui_handler.default.html#actionBg" 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>action<wbr/>Bg</span></a>
<a href="ui_settings_abstract_binding_ui_handler.default.html#actionLabel" 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>action<wbr/>Label</span></a>
<a href="ui_settings_abstract_binding_ui_handler.default.html#actionsContainer" 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>actions<wbr/>Container</span></a>
<a href="ui_settings_abstract_binding_ui_handler.default.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_settings_abstract_binding_ui_handler.default.html#buttonPressed" 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/>Pressed</span></a>
<a href="ui_settings_abstract_binding_ui_handler.default.html#cancelFn" 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>cancel<wbr/>Fn</span></a>
<a href="ui_settings_abstract_binding_ui_handler.default.html#cancelLabel" 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>cancel<wbr/>Label</span></a>
<a href="ui_settings_abstract_binding_ui_handler.default.html#countdownTimer" 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>countdown<wbr/>Timer</span></a>
<a href="ui_settings_abstract_binding_ui_handler.default.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_settings_abstract_binding_ui_handler.default.html#listening" 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>listening</span></a>
<a href="ui_settings_abstract_binding_ui_handler.default.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_settings_abstract_binding_ui_handler.default.html#newButtonIcon" 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>new<wbr/>Button<wbr/>Icon</span></a>
<a href="ui_settings_abstract_binding_ui_handler.default.html#optionSelectBg" 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>option<wbr/>Select<wbr/>Bg</span></a>
<a href="ui_settings_abstract_binding_ui_handler.default.html#optionSelectContainer" 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>option<wbr/>Select<wbr/>Container</span></a>
<a href="ui_settings_abstract_binding_ui_handler.default.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_settings_abstract_binding_ui_handler.default.html#swapText" 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>swap<wbr/>Text</span></a>
<a href="ui_settings_abstract_binding_ui_handler.default.html#target" 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>target</span></a>
<a href="ui_settings_abstract_binding_ui_handler.default.html#targetButtonIcon" 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>target<wbr/>Button<wbr/>Icon</span></a>
<a href="ui_settings_abstract_binding_ui_handler.default.html#timeLeftAutoClose" 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>time<wbr/>Left<wbr/>Auto<wbr/>Close</span></a>
<a href="ui_settings_abstract_binding_ui_handler.default.html#timerText" 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>timer<wbr/>Text</span></a>
<a href="ui_settings_abstract_binding_ui_handler.default.html#titleBg" 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/>Bg</span></a>
<a href="ui_settings_abstract_binding_ui_handler.default.html#unlockText" 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>unlock<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_settings_abstract_binding_ui_handler.default.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_settings_abstract_binding_ui_handler.default.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_settings_abstract_binding_ui_handler.default.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_settings_abstract_binding_ui_handler.default.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_settings_abstract_binding_ui_handler.default.html#getWindowHeight" 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/>Window<wbr/>Height</span></a>
<a href="ui_settings_abstract_binding_ui_handler.default.html#getWindowWidth" 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/>Window<wbr/>Width</span></a>
<a href="ui_settings_abstract_binding_ui_handler.default.html#manageAutoCloseTimer" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>manage<wbr/>Auto<wbr/>Close<wbr/>Timer</span></a>
<a href="ui_settings_abstract_binding_ui_handler.default.html#onInputDown" 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/>Input<wbr/>Down</span></a>
<a href="ui_settings_abstract_binding_ui_handler.default.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_settings_abstract_binding_ui_handler.default.html#setCursor" 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/>Cursor</span></a>
<a href="ui_settings_abstract_binding_ui_handler.default.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_settings_abstract_binding_ui_handler.default.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_settings_abstract_binding_ui_handler.default.html#swapAction" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>swap<wbr/>Action</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-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_settings_abstract_binding_ui_handler.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 for the AbstractBindingUiHandler.</p>
2024-06-01 13:57: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">scene</span>: <a href="battle_scene.default.html" class="tsd-signature-type tsd-kind-class">default</a></span><div class="tsd-comment tsd-typography"><p>The BattleScene instance.</p>
2024-08-17 18:01:18 +01:00
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">mode</span>: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../enums/ui_ui.Mode.html" class="tsd-signature-type tsd-kind-enum">Mode</a><span class="tsd-signature-symbol"> = null</span></span><div class="tsd-comment tsd-typography"><p>The UI mode.</p>
2024-08-17 20:49:01 +01:00
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="ui_settings_abstract_binding_ui_handler.default.html" class="tsd-signature-type tsd-kind-class">default</a></h4><div class="tsd-comment tsd-typography"></div><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/15584f8f1e5e61114f17a4da56cb6cfb34349f21/src/ui/settings/abstract-binding-ui-handler.ts#L55">src/ui/settings/abstract-binding-ui-handler.ts:55</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 tsd-is-protected"><a id="actionBg" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Protected</code><span>action<wbr/>Bg</span><a href="#actionBg" 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">action<wbr/>Bg</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">NineSlice</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/15584f8f1e5e61114f17a4da56cb6cfb34349f21/src/ui/settings/abstract-binding-ui-handler.ts#L22">src/ui/settings/abstract-binding-ui-handler.ts:22</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected"><a id="actionLabel" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Protected</code><span>action<wbr/>Label</span><a href="#actionLabel" 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">action<wbr/>Label</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Text</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/15584f8f1e5e61114f17a4da56cb6cfb34349f21/src/ui/settings/abstract-binding-ui-handler.ts#L29">src/ui/settings/abstract-binding-ui-handler.ts:29</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected"><a id="actionsContainer" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Protected</code><span>actions<wbr/>Container</span><a href="#actionsContainer" 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">actions<wbr/>Container</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Container</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/15584f8f1e5e61114f17a4da56cb6cfb34349f21/src/ui/settings/abstract-binding-ui-handler.ts#L18">src/ui/settings/abstract-binding-ui-handler.ts:18</a></li></ul></aside></section><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.ht
</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"><p>Overrides <a href="ui_ui_handler.default.html">default</a>.<a href="ui_ui_handler.default.html#clear">clear</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/15584f8f1e5e61114f17a4da56cb6cfb34349f21/src/ui/settings/abstract-binding-ui-handler.ts#L226">src/ui/settings/abstract-binding-ui-handler.ts:226</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="getCursor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Cursor</span><a href="#getCursor" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="getCursor.getCursor-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Cursor</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#getCursor.getCursor-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">number</span></h4><aside class="tsd-sources"><p>Inherited from <a href="ui_ui_handler.default.html">default</a>.<a href="ui_ui_handler.default.html#getCursor">getCursor</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/15584f8f1e5e61114f17a4da56cb6cfb34349f21/src/ui/ui-handler.ts#L42">src/ui/ui-handler.ts:42</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="getTextColor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Text<wbr/>Color</span><a href="#getTextColor" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="getTextColor.getTextColor-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Text<wbr/>Color</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">style</span>, <span class="tsd-kind-parameter">shadow</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getTextColor.getTextColor-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">style</span>: <a href="../enums/ui_text.TextStyle.html" class="tsd-signature-type tsd-kind-enum">TextStyle</a></span></li><li><span><span class="tsd-kind-parameter">shadow</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">string</span></h4><aside class="tsd-sources"><p>Inherited from <a href="ui_ui_handler.default.html">default</a>.<a href="ui_ui_handler.default.html#getTextColor">getTextColor</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/15584f8f1e5e61114f17a4da56cb6cfb34349f21/src/ui/ui-handler.ts#L38">src/ui/ui-handler.ts:38</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="getUi" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Ui</span><a href="#getUi" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href
2024-06-01 13:57:45 +01:00
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>The window height.</p>
2024-08-17 20:49:01 +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/15584f8f1e5e61114f17a4da56cb6cfb34349f21/src/ui/settings/abstract-binding-ui-handler.ts#L156">src/ui/settings/abstract-binding-ui-handler.ts:156</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getWindowWidth" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Window<wbr/>Width</span><a href="#getWindowWidth" 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="getWindowWidth.getWindowWidth-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Window<wbr/>Width</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#getWindowWidth.getWindowWidth-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>Get the width of the window.</p>
2024-06-01 13:57:45 +01:00
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>The window width.</p>
2024-08-17 20:49:01 +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/15584f8f1e5e61114f17a4da56cb6cfb34349f21/src/ui/settings/abstract-binding-ui-handler.ts#L147">src/ui/settings/abstract-binding-ui-handler.ts:147</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="manageAutoCloseTimer" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>manage<wbr/>Auto<wbr/>Close<wbr/>Timer</span><a href="#manageAutoCloseTimer" 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="manageAutoCloseTimer.manageAutoCloseTimer-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">manage<wbr/>Auto<wbr/>Close<wbr/>Timer</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="#manageAutoCloseTimer.manageAutoCloseTimer-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/15584f8f1e5e61114f17a4da56cb6cfb34349f21/src/ui/settings/abstract-binding-ui-handler.ts#L104">src/ui/settings/abstract-binding-ui-handler.ts:104</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="onInputDown" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>on<wbr/>Input<wbr/>Down</span><a href="#onInputDown" 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="onInputDown.onInputDown-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">on<wbr/>Input<wbr/>Down</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">buttonIcon</span>, <span class="tsd-kind-parameter">assignedButtonIcon</span>, <span class="tsd-kind-parameter">type</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#onInputDown.onInputDown-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>Handle input down events.</p>
2024-06-01 13:57: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">buttonIcon</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The icon of the button that was pressed.</p>
2024-08-17 18:01:18 +01:00
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">assignedButtonIcon</span>: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The icon of the button that is assigned.</p>
2024-06-01 13:57:45 +01:00
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">type</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The type of button press.</p>
2024-08-17 20:49:01 +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/15584f8f1e5e61114f17a4da56cb6cfb34349f21/src/ui/settings/abstract-binding-ui-handler.ts#L247">src/ui/settings/abstract-binding-ui-handler.ts:247</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="processInput" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>process<wbr/>Input</span><a href="#processInput" 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="processInput.processInput-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">process<wbr/>Input</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">button</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#processInput.processInput-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>Process the input for the given button.</p>
2024-06-01 13:57: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">button</span>: <a href="../enums/enums_buttons.Button.html" class="tsd-signature-type tsd-kind-enum">Button</a></span><div class="tsd-comment tsd-typography"><p>The button to process.</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><code>true</code> if the input was processed successfully.</p>
2024-08-17 20:49:01 +01:00
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="ui_ui_handler.default.html">default</a>.<a href="ui_ui_handler.default.html#processInput">processInput</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/15584f8f1e5e61114f17a4da56cb6cfb34349f21/src/ui/settings/abstract-binding-ui-handler.ts#L166">src/ui/settings/abstract-binding-ui-handler.ts:166</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="setCursor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Cursor</span><a href="#setCursor" 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="setCursor.setCursor-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set<wbr/>Cursor</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">cursor</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#setCursor.setCursor-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>Set the cursor to the specified position.</p>
2024-06-01 13:57: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">cursor</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The cursor position to set.</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><code>true</code> if the cursor was set successfully.</p>
2024-08-17 20:49:01 +01:00
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="ui_ui_handler.default.html">default</a>.<a href="ui_ui_handler.default.html#setCursor">setCursor</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/15584f8f1e5e61114f17a4da56cb6cfb34349f21/src/ui/settings/abstract-binding-ui-handler.ts#L207">src/ui/settings/abstract-binding-ui-handler.ts:207</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="setup" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>setup</span><a href="#setup" 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="setup.setup-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">setup</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="#setup.setup-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>Setup UI elements.</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"><p>Overrides <a href="ui_ui_handler.default.html">default</a>.<a href="ui_ui_handler.default.html#setup">setup</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/15584f8f1e5e61114f17a4da56cb6cfb34349f21/src/ui/settings/abstract-binding-ui-handler.ts#L62">src/ui/settings/abstract-binding-ui-handler.ts:62</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="show" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>show</span><a href="#show" 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="show.show-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">show</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">boolean</span><a href="#show.show-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>Show the UI with the provided arguments.</p>
2024-06-01 13:57: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">args</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>Arguments to be passed to the show method.</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><code>true</code> if successful.</p>
2024-08-17 20:49:01 +01:00
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="ui_ui_handler.default.html">default</a>.<a href="ui_ui_handler.default.html#show">show</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/15584f8f1e5e61114f17a4da56cb6cfb34349f21/src/ui/settings/abstract-binding-ui-handler.ts#L123">src/ui/settings/abstract-binding-ui-handler.ts:123</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="swapAction" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Abstract</code><span>swap<wbr/>Action</span><a href="#swapAction" 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="swapAction.swapAction-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">swap<wbr/>Action</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="#swapAction.swapAction-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">boolean</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/15584f8f1e5e61114f17a4da56cb6cfb34349f21/src/ui/settings/abstract-binding-ui-handler.ts#L41">src/ui/settings/abstract-binding-ui-handler.ts:41</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 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-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></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><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-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0