pokerogue/main/classes/ui_settings_settings_gamepa...

88 lines
104 KiB
HTML
Raw Normal View History

2024-06-01 12:57:45 +00: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_settings_gamepad_ui_handler.html">ui/settings/settings-gamepad-ui-handler</a></li><li><a href="ui_settings_settings_gamepad_ui_handler.default.html">default</a></li></ul><h1>Class default</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Class representing the settings UI handler for gamepads.</p>
2024-07-03 18:50:01 +00: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/settings/settings-gamepad-ui-handler.default">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="ui_settings_abstract_control_settings_ui_handler.default.html" class="tsd-signature-type tsd-kind-class">default</a><ul class="tsd-hierarchy"><li><span class="target">default</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/126174efe4162693f17fbb44116ce1723bacc0bb/src/ui/settings/settings-gamepad-ui-handler.ts#L26">src/ui/settings/settings-gamepad-ui-handler.ts:26</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_settings_settings_gamepad_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 12:57:45 +00:00
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="ui_settings_settings_gamepad_ui_handler.default.html#actionsBg" 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>actions<wbr/>Bg</span></a>
<a href="ui_settings_settings_gamepad_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_settings_gamepad_ui_handler.default.html#bindingSettings" 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>binding<wbr/>Settings</span></a>
<a href="ui_settings_settings_gamepad_ui_handler.default.html#commonSettingsCount" 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>common<wbr/>Settings<wbr/>Count</span></a>
<a href="ui_settings_settings_gamepad_ui_handler.default.html#configs" 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>configs</span></a>
<a href="ui_settings_settings_gamepad_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_settings_gamepad_ui_handler.default.html#cursorObj" 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<wbr/>Obj</span></a>
2024-06-03 23:58:57 +00:00
<a href="ui_settings_settings_gamepad_ui_handler.default.html#device" 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>device</span></a>
2024-06-01 12:57:45 +00:00
<a href="ui_settings_settings_gamepad_ui_handler.default.html#inputsIcons" 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>inputs<wbr/>Icons</span></a>
<a href="ui_settings_settings_gamepad_ui_handler.default.html#keys" 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>keys</span></a>
<a href="ui_settings_settings_gamepad_ui_handler.default.html#layout" 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>layout</span></a>
<a href="ui_settings_settings_gamepad_ui_handler.default.html#localStoragePropertyName" 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>local<wbr/>Storage<wbr/>Property<wbr/>Name</span></a>
<a href="ui_settings_settings_gamepad_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_settings_gamepad_ui_handler.default.html#navigationContainer" 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>navigation<wbr/>Container</span></a>
<a href="ui_settings_settings_gamepad_ui_handler.default.html#navigationIcons" 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>navigation<wbr/>Icons</span></a>
<a href="ui_settings_settings_gamepad_ui_handler.default.html#optionCursors" 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>option<wbr/>Cursors</span></a>
<a href="ui_settings_settings_gamepad_ui_handler.default.html#optionValueLabels" 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>option<wbr/>Value<wbr/>Labels</span></a>
<a href="ui_settings_settings_gamepad_ui_handler.default.html#optionsBg" 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>options<wbr/>Bg</span></a>
<a href="ui_settings_settings_gamepad_ui_handler.default.html#optionsContainer" 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>options<wbr/>Container</span></a>
<a href="ui_settings_settings_gamepad_ui_handler.default.html#rowsToDisplay" 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>rows<wbr/>To<wbr/>Display</span></a>
<a href="ui_settings_settings_gamepad_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_settings_gamepad_ui_handler.default.html#scrollCursor" 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>scroll<wbr/>Cursor</span></a>
2024-06-03 23:58:57 +00:00
<a href="ui_settings_settings_gamepad_ui_handler.default.html#setSetting" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>set<wbr/>Setting</span></a>
<a href="ui_settings_settings_gamepad_ui_handler.default.html#setting" 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>setting</span></a>
2024-06-01 12:57:45 +00:00
<a href="ui_settings_settings_gamepad_ui_handler.default.html#settingBlacklisted" 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>setting<wbr/>Blacklisted</span></a>
<a href="ui_settings_settings_gamepad_ui_handler.default.html#settingDeviceDefaults" 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>setting<wbr/>Device<wbr/>Defaults</span></a>
<a href="ui_settings_settings_gamepad_ui_handler.default.html#settingDeviceOptions" 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>setting<wbr/>Device<wbr/>Options</span></a>
<a href="ui_settings_settings_gamepad_ui_handler.default.html#settingLabels" 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>setting<wbr/>Labels</span></a>
<a href="ui_settings_settings_gamepad_ui_handler.default.html#settingsContainer" 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>settings<wbr/>Container</span></a>
<a href="ui_settings_settings_gamepad_ui_handler.default.html#textureOverride" 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>texture<wbr/>Override</span></a>
<a href="ui_settings_settings_gamepad_ui_handler.default.html#titleSelected" 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>title<wbr/>Selected</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_settings_gamepad_ui_handler.default.html#clear" 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>clear</span></a>
<a href="ui_settings_settings_gamepad_ui_handler.default.html#eraseCursor" 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>erase<wbr/>Cursor</span></a>
2024-06-03 23:58:57 +00:00
<a href="ui_settings_settings_gamepad_ui_handler.default.html#getActiveConfig" 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/>Active<wbr/>Config</span></a>
2024-06-01 12:57:45 +00:00
<a href="ui_settings_settings_gamepad_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>
2024-06-03 23:58:57 +00:00
<a href="ui_settings_settings_gamepad_ui_handler.default.html#getLocalStorageSetting" 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/>Local<wbr/>Storage<wbr/>Setting</span></a>
2024-06-01 12:57:45 +00:00
<a href="ui_settings_settings_gamepad_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_settings_gamepad_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_settings_gamepad_ui_handler.default.html#processInput" 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>process<wbr/>Input</span></a>
<a href="ui_settings_settings_gamepad_ui_handler.default.html#resetScroll" 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>reset<wbr/>Scroll</span></a>
<a href="ui_settings_settings_gamepad_ui_handler.default.html#saveSettingToLocalStorage" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>save<wbr/>Setting<wbr/>To<wbr/>Local<wbr/>Storage</span></a>
<a href="ui_settings_settings_gamepad_ui_handler.default.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_settings_settings_gamepad_ui_handler.default.html#setLayout" 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/>Layout</span></a>
<a href="ui_settings_settings_gamepad_ui_handler.default.html#setOptionCursor" 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/>Option<wbr/>Cursor</span></a>
<a href="ui_settings_settings_gamepad_ui_handler.default.html#setScrollCursor" 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/>Scroll<wbr/>Cursor</span></a>
<a href="ui_settings_settings_gamepad_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_settings_gamepad_ui_handler.default.html#show" 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>show</span></a>
<a href="ui_settings_settings_gamepad_ui_handler.default.html#updateBindings" 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>update<wbr/>Bindings</span></a>
<a href="ui_settings_settings_gamepad_ui_handler.default.html#updateChosenGamepadDisplay" 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/>Chosen<wbr/>Gamepad<wbr/>Display</span></a>
<a href="ui_settings_settings_gamepad_ui_handler.default.html#updateNavigationDisplay" 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>update<wbr/>Navigation<wbr/>Display</span></a>
<a href="ui_settings_settings_gamepad_ui_handler.default.html#updateSettingsScroll" 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>update<wbr/>Settings<wbr/>Scroll</span></a>
</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_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_settings_gamepad_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>Creates an instance of SettingsGamepadUiHandler.</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">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>
</div><div class="tsd-comment tsd-typography"></div></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><div class="tsd-comment tsd-typography"><p>The UI mode, optional.</p>
2024-07-03 18:50:01 +00:00
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="ui_settings_settings_gamepad_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_settings_abstract_control_settings_ui_handler.default.html">default</a>.<a href="ui_settings_abstract_control_settings_ui_handler.default.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/126174efe4162693f17fbb44116ce1723bacc0bb/src/ui/settings/settings-gamepad-ui-handler.ts#L34">src/ui/settings/settings-gamepad-ui-handler.ts:34</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-protected tsd-is-inherited"><a id="actionsBg" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>actions<wbr/>Bg</span><a href="#actionsBg" 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/>Bg</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">NineSlice</span></div><aside class="tsd-sources"><p>Inherited from <a href="ui_settings_abstract_control_settings_ui_handler.default.html">default</a>.<a href="ui_settings_abstract_control_settings_ui_handler.default.html#actionsBg">actionsBg</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/126174efe4162693f17fbb44116ce1723bacc0bb/src/ui/settings/abstract-control-settings-ui-handler.ts#L39">src/ui/settings/abstract-control-settings-ui-handler.ts:39</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_settings_abstract_control_settings_ui_handler.default.html">default</a>.<a href="ui_settings_abstract_control_settings_ui_handler.default.html#active">active</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/126174efe4162693f17fbb44116ce1723bacc0bb/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 tsd-is-inherited"><a id="bindingSettings" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>binding<wbr/>Settings</span><a href="#bindingSettings" 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">binding<wbr/>Settings</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"><p>Inherited from <a href="ui_settings_abstract_control_settings_ui_handler.default.html">default</a>.<a href="ui_settings_abstract_control_settings_ui_handler.default.html#bindingSettings">bindingSettings</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/126174efe4162693f17fbb44116ce1723bacc0bb/src/ui/settings/abstract-control-settings-ui-handler.ts#L53">src/ui/settings/abstract-control-settings-ui-handler.ts:53</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="commonSettingsCount" class="tsd-anchor"></a>
</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>Inherited from <a href="ui_settings_abstract_control_settings_ui_handler.default.html">default</a>.<a href="ui_settings_abstract_control_settings_ui_handler.default.html#clear">clear</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/126174efe4162693f17fbb44116ce1723bacc0bb/src/ui/settings/abstract-control-settings-ui-handler.ts#L652">src/ui/settings/abstract-control-settings-ui-handler.ts:652</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="eraseCursor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>erase<wbr/>Cursor</span><a href="#eraseCursor" 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="eraseCursor.eraseCursor-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">erase<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">void</span><a href="#eraseCursor.eraseCursor-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>Erase the cursor from the UI.</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>Inherited from <a href="ui_settings_abstract_control_settings_ui_handler.default.html">default</a>.<a href="ui_settings_abstract_control_settings_ui_handler.default.html#eraseCursor">eraseCursor</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/126174efe4162693f17fbb44116ce1723bacc0bb/src/ui/settings/abstract-control-settings-ui-handler.ts#L665">src/ui/settings/abstract-control-settings-ui-handler.ts:665</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="getActiveConfig" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Active<wbr/>Config</span><a href="#getActiveConfig" 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="getActiveConfig.getActiveConfig-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Active<wbr/>Config</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/inputs_controller.InterfaceConfig.html" class="tsd-signature-type tsd-kind-interface">InterfaceConfig</a><a href="#getActiveConfig.getActiveConfig-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 active configuration.</p>
2024-06-03 23:58:57 +00:00
</div><h4 class="tsd-returns-title">Returns <a href="../interfaces/inputs_controller.InterfaceConfig.html" class="tsd-signature-type tsd-kind-interface">InterfaceConfig</a></h4><p>The active configuration for current device</p>
2024-07-03 18:50:01 +00:00
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="ui_settings_abstract_control_settings_ui_handler.default.html">default</a>.<a href="ui_settings_abstract_control_settings_ui_handler.default.html#getActiveConfig">getActiveConfig</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/126174efe4162693f17fbb44116ce1723bacc0bb/src/ui/settings/abstract-control-settings-ui-handler.ts#L284">src/ui/settings/abstract-control-settings-ui-handler.ts:284</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_settings_abstract_control_settings_ui_handler.default.html">default</a>.<a href="ui_settings_abstract_control_settings_ui_handler.default.html#getCursor">getCursor</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/126174efe4162693f17fbb44116ce1723bacc0bb/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="getLocalStorageSetting" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Local<wbr/>Storage<wbr/>Setting</span><a href="#getLocalStorageSetting" 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="getLocalStorageSetting.getLocalStorageSetting-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Local<wbr/>Storage<wbr/>Setting</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span><a href="#getLocalStorageSetting.getLocalStorageSetting-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">object</span></h4><aside class="tsd-sources"><p>Inherited from <a href="ui_settings_abstract_control_settings_ui_handler.default.html">default</a>.<a href="ui_settings_abstract_control_settings_ui_handler.default.html#getLocalStorageSetting">getLocalStorageSetting</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/126174efe4162693f17fbb44116ce1723bacc0bb/src/ui/settings/abstract-control-settings-ui-handler.ts#L81">src/ui/settings/abstract-control-settings-ui-handler.ts:81</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
2024-06-01 12:57:45 +00: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-07-03 18:50:01 +00:00
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="ui_settings_abstract_control_settings_ui_handler.default.html">default</a>.<a href="ui_settings_abstract_control_settings_ui_handler.default.html#processInput">processInput</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/126174efe4162693f17fbb44116ce1723bacc0bb/src/ui/settings/abstract-control-settings-ui-handler.ts#L427">src/ui/settings/abstract-control-settings-ui-handler.ts:427</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="resetScroll" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>reset<wbr/>Scroll</span><a href="#resetScroll" 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="resetScroll.resetScroll-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">reset<wbr/>Scroll</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="#resetScroll.resetScroll-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"><p>Inherited from <a href="ui_settings_abstract_control_settings_ui_handler.default.html">default</a>.<a href="ui_settings_abstract_control_settings_ui_handler.default.html#resetScroll">resetScroll</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/126174efe4162693f17fbb44116ce1723bacc0bb/src/ui/settings/abstract-control-settings-ui-handler.ts#L526">src/ui/settings/abstract-control-settings-ui-handler.ts:526</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="saveSettingToLocalStorage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>save<wbr/>Setting<wbr/>To<wbr/>Local<wbr/>Storage</span><a href="#saveSettingToLocalStorage" 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="saveSettingToLocalStorage.saveSettingToLocalStorage-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">save<wbr/>Setting<wbr/>To<wbr/>Local<wbr/>Storage</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">settingName</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">void</span><a href="#saveSettingToLocalStorage.saveSettingToLocalStorage-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>Save the setting to local storage.</p>
2024-06-03 23:58:57 +00: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">settingName</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The setting to save.</p>
2024-06-01 12:57:45 +00:00
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">cursor</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The cursor position to save.</p>
2024-07-03 18:50:01 +00: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"><p>Overrides <a href="ui_settings_abstract_control_settings_ui_handler.default.html">default</a>.<a href="ui_settings_abstract_control_settings_ui_handler.default.html#saveSettingToLocalStorage">saveSettingToLocalStorage</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/126174efe4162693f17fbb44116ce1723bacc0bb/src/ui/settings/settings-gamepad-ui-handler.ts#L122">src/ui/settings/settings-gamepad-ui-handler.ts:122</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><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 tsd-is-inherited"><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 12:57:45 +00: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-07-03 18:50:01 +00:00
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="ui_settings_abstract_control_settings_ui_handler.default.html">default</a>.<a href="ui_settings_abstract_control_settings_ui_handler.default.html#setCursor">setCursor</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/126174efe4162693f17fbb44116ce1723bacc0bb/src/ui/settings/abstract-control-settings-ui-handler.ts#L541">src/ui/settings/abstract-control-settings-ui-handler.ts:541</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="setLayout" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Layout</span><a href="#setLayout" 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="setLayout.setLayout-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set<wbr/>Layout</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">activeConfig</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#setLayout.setLayout-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 layout for the active configuration.</p>
2024-06-01 12:57:45 +00: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">activeConfig</span>: <a href="../interfaces/inputs_controller.InterfaceConfig.html" class="tsd-signature-type tsd-kind-interface">InterfaceConfig</a></span><div class="tsd-comment tsd-typography"><p>The active gamepad configuration.</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 layout was successfully applied, otherwise <code>false</code>.</p>
2024-07-03 18:50:01 +00:00
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="ui_settings_abstract_control_settings_ui_handler.default.html">default</a>.<a href="ui_settings_abstract_control_settings_ui_handler.default.html#setLayout">setLayout</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/126174efe4162693f17fbb44116ce1723bacc0bb/src/ui/settings/settings-gamepad-ui-handler.ts#L74">src/ui/settings/settings-gamepad-ui-handler.ts:74</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="setOptionCursor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Option<wbr/>Cursor</span><a href="#setOptionCursor" 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="setOptionCursor.setOptionCursor-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set<wbr/>Option<wbr/>Cursor</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">settingIndex</span>, <span class="tsd-kind-parameter">cursor</span>, <span class="tsd-kind-parameter">save</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="#setOptionCursor.setOptionCursor-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 option cursor to the specified position.</p>
2024-06-01 12:57:45 +00: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">settingIndex</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The index of the setting.</p>
</div><div class="tsd-comment tsd-typography"></div></li><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><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">save</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>Whether to save the setting to local storage.</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 option cursor was set successfully.</p>
2024-07-03 18:50:01 +00:00
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="ui_settings_abstract_control_settings_ui_handler.default.html">default</a>.<a href="ui_settings_abstract_control_settings_ui_handler.default.html#setOptionCursor">setOptionCursor</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/126174efe4162693f17fbb44116ce1723bacc0bb/src/ui/settings/abstract-control-settings-ui-handler.ts#L593">src/ui/settings/abstract-control-settings-ui-handler.ts:593</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="setScrollCursor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Scroll<wbr/>Cursor</span><a href="#setScrollCursor" 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="setScrollCursor.setScrollCursor-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set<wbr/>Scroll<wbr/>Cursor</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scrollCursor</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#setScrollCursor.setScrollCursor-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 scroll cursor to the specified position.</p>
2024-06-01 12:57:45 +00: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">scrollCursor</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The scroll 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 scroll cursor was set successfully.</p>
2024-07-03 18:50:01 +00:00
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="ui_settings_abstract_control_settings_ui_handler.default.html">default</a>.<a href="ui_settings_abstract_control_settings_ui_handler.default.html#setScrollCursor">setScrollCursor</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/126174efe4162693f17fbb44116ce1723bacc0bb/src/ui/settings/abstract-control-settings-ui-handler.ts#L567">src/ui/settings/abstract-control-settings-ui-handler.ts:567</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_settings_abstract_control_settings_ui_handler.default.html">default</a>.<a href="ui_settings_abstract_control_settings_ui_handler.default.html#setup">setup</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/126174efe4162693f17fbb44116ce1723bacc0bb/src/ui/settings/settings-gamepad-ui-handler.ts#L52">src/ui/settings/settings-gamepad-ui-handler.ts:52</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><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 tsd-is-inherited"><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 12:57:45 +00: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-07-03 18:50:01 +00:00
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="ui_settings_abstract_control_settings_ui_handler.default.html">default</a>.<a href="ui_settings_abstract_control_settings_ui_handler.default.html#show">show</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/126174efe4162693f17fbb44116ce1723bacc0bb/src/ui/settings/abstract-control-settings-ui-handler.ts#L363">src/ui/settings/abstract-control-settings-ui-handler.ts:363</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="updateBindings" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>update<wbr/>Bindings</span><a href="#updateBindings" 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="updateBindings.updateBindings-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">update<wbr/>Bindings</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="#updateBindings.updateBindings-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>Update the bindings for the current active device configuration.</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>Inherited from <a href="ui_settings_abstract_control_settings_ui_handler.default.html">default</a>.<a href="ui_settings_abstract_control_settings_ui_handler.default.html#updateBindings">updateBindings</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/126174efe4162693f17fbb44116ce1723bacc0bb/src/ui/settings/abstract-control-settings-ui-handler.ts#L291">src/ui/settings/abstract-control-settings-ui-handler.ts:291</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="updateChosenGamepadDisplay" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>update<wbr/>Chosen<wbr/>Gamepad<wbr/>Display</span><a href="#updateChosenGamepadDisplay" 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="updateChosenGamepadDisplay.updateChosenGamepadDisplay-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">update<wbr/>Chosen<wbr/>Gamepad<wbr/>Display</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="#updateChosenGamepadDisplay.updateChosenGamepadDisplay-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>Update the display of the chosen gamepad.</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/126174efe4162693f17fbb44116ce1723bacc0bb/src/ui/settings/settings-gamepad-ui-handler.ts#L91">src/ui/settings/settings-gamepad-ui-handler.ts:91</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="updateNavigationDisplay" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>update<wbr/>Navigation<wbr/>Display</span><a href="#updateNavigationDisplay" 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="updateNavigationDisplay.updateNavigationDisplay-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">update<wbr/>Navigation<wbr/>Display</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="#updateNavigationDisplay.updateNavigationDisplay-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"><p>Inherited from <a href="ui_settings_abstract_control_settings_ui_handler.default.html">default</a>.<a href="ui_settings_abstract_control_settings_ui_handler.default.html#updateNavigationDisplay">updateNavigationDisplay</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/126174efe4162693f17fbb44116ce1723bacc0bb/src/ui/settings/abstract-control-settings-ui-handler.ts#L333">src/ui/settings/abstract-control-settings-ui-handler.ts:333</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="updateSettingsScroll" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>update<wbr/>Settings<wbr/>Scroll</span><a href="#updateSettingsScroll" 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="updateSettingsScroll.updateSettingsScroll-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">update<wbr/>Settings<wbr/>Scroll</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="#updateSettingsScroll.updateSettingsScroll-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>Update the scroll position of the settings UI.</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>Inherited from <a href="ui_settings_abstract_control_settings_ui_handler.default.html">default</a>.<a href="ui_settings_abstract_control_settings_ui_handler.default.html#updateSettingsScroll">updateSettingsScroll</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/126174efe4162693f17fbb44116ce1723bacc0bb/src/ui/settings/abstract-control-settings-ui-handler.ts#L627">src/ui/settings/abstract-control-settings-ui-handler.ts:627</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-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"><h4 class="uppercase">Member Visibility</h4><form><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-private" name="private"/><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>Private</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></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><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-index-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#actionsBg" class="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>actions<wbr/>Bg</span></a><a href="#active" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24