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_settings_ui_handler.html" > ui/settings/abstract-settings-ui-handler< / a > < / li > < li > < a href = "ui_settings_abstract_settings_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 > Abstract class for handling UI elements related to settings.< / p >
2024-07-29 22:13:21 +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-settings-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_settings_audio_ui_handler.default.html" class = "tsd-signature-type tsd-kind-class" > default< / a > < / li > < li > < a href = "ui_settings_settings_display_ui_handler.default.html" class = "tsd-signature-type tsd-kind-class" > default< / a > < / li > < li > < a href = "ui_settings_settings_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/c8ce7960dd7dc620417df374c4736c3bed606902/src/ui/settings/abstract-settings-ui-handler.ts#L17" > src/ui/settings/abstract-settings-ui-handler.ts:17< / 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_settings_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-04 00:58:57 +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_settings_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 >
2024-06-01 13:57:45 +01:00
< a href = "ui_settings_abstract_settings_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 >
2024-06-04 00:58:57 +01:00
< a href = "ui_settings_abstract_settings_ui_handler.default.html#localStorageKey" 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 > local< wbr / > Storage< wbr / > Key< / span > < / a >
2024-06-01 13:57:45 +01:00
< a href = "ui_settings_abstract_settings_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_settings_ui_handler.default.html#navigationIcons" 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 > navigation< wbr / > Icons< / span > < / a >
2024-06-13 17:04:08 +01:00
< a href = "ui_settings_abstract_settings_ui_handler.default.html#rowsToDisplay" 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 > rows< wbr / > To< wbr / > Display< / span > < / a >
2024-06-01 13:57:45 +01:00
< a href = "ui_settings_abstract_settings_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 >
2024-06-04 00:58:57 +01:00
< a href = "ui_settings_abstract_settings_ui_handler.default.html#settings" 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 > settings< / span > < / a >
< a href = "ui_settings_abstract_settings_ui_handler.default.html#title" 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< / span > < / a >
2024-06-01 13:57:45 +01:00
< / div > < / section > < section class = "tsd-index-section" > < h3 class = "tsd-index-heading" > Methods< / h3 > < div class = "tsd-index-list" > < a href = "ui_settings_abstract_settings_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_settings_ui_handler.default.html#eraseCursor" class = "tsd-index-link" > < 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 >
< a href = "ui_settings_abstract_settings_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_settings_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_settings_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_settings_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_settings_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_settings_ui_handler.default.html#setOptionCursor" 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 / > Option< wbr / > Cursor< / span > < / a >
< a href = "ui_settings_abstract_settings_ui_handler.default.html#setScrollCursor" 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 / > Scroll< wbr / > Cursor< / span > < / a >
< a href = "ui_settings_abstract_settings_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_settings_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_settings_ui_handler.default.html#updateBindings" 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 / > Bindings< / span > < / a >
< a href = "ui_settings_abstract_settings_ui_handler.default.html#updateSettingsScroll" 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 / > Settings< wbr / > Scroll< / span > < / a >
2024-07-29 22:13:21 +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_settings_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-parameters" > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameter-list" > < li > < span > < span class = "tsd-kind-parameter" > scene< / span > : < a href = "battle_scene.default.html" class = "tsd-signature-type tsd-kind-class" > default< / a > < / span > < / li > < li > < span > < code class = "tsd-tag" > Optional< / code > < span class = "tsd-kind-parameter" > mode< / span > : < a href = "../enums/ui_ui.Mode.html" class = "tsd-signature-type tsd-kind-enum" > Mode< / a > < / span > < / li > < / ul > < / div > < h4 class = "tsd-returns-title" > Returns < a href = "ui_settings_abstract_settings_ui_handler.default.html" class = "tsd-signature-type tsd-kind-class" > default< / a > < / h4 > < aside class = "tsd-sources" > < p > Overrides < a href = "ui_ui_handler.default.html" > default< / a > .< a href = "ui_ui_handler.default.html#constructor" > constructor< / a > < / p > < ul > < li > Defined in < a href = "https://github.com/pagefaultgames/pokerogue/blob/c8ce7960dd7dc620417df374c4736c3bed606902/src/ui/settings/abstract-settings-ui-handler.ts#L43" > src/ui/settings/abstract-settings-ui-handler.ts:43< / 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-inherited" > < a id = "active" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > active< / span > < a href = "#active" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h3 > < div class = "tsd-signature" > < span class = "tsd-kind-property" > active< / span > < span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > = false< / span > < / div > < aside class = "tsd-sources" > < p > Inherited from < a href = "ui_ui_handler.default.html" > default< / a > .< a href = "ui_ui_handler.default.html#active" > active< / a > < / p > < ul > < li > Defined in < a href = "https://github.com/pagefaultgames/pokerogue/blob/c8ce7960dd7dc620417df374c4736c3bed606902/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 = "cursor" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < code class = "tsd-tag" > Protected< / code > < span > cursor< / span > < a href = "#cursor" 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" > cursor< / span > < span class = "tsd-signature-sym
< / 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/c8ce7960dd7dc620417df374c4736c3bed606902/src/ui/settings/abstract-settings-ui-handler.ts#L374" > src/ui/settings/abstract-settings-ui-handler.ts:374< / a > < / li > < / ul > < / aside > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member" > < 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" > < 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" > < ul > < li > Defined in < a href = "https://github.com/pagefaultgames/pokerogue/blob/c8ce7960dd7dc620417df374c4736c3bed606902/src/ui/settings/abstract-settings-ui-handler.ts#L388" > src/ui/settings/abstract-settings-ui-handler.ts:388< / 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/c8ce7960dd7dc620417df374c4736c3bed606902/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/c8ce7960dd7dc620417df374c4736c3bed606902/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 = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h3 > < ul class = "tsd-signatures tsd-is-inherited" > < li class = "tsd-s
2024-06-04 00:58:57 +01:00
This method handles navigation through a UI menu, including movement through menu items
and handling special actions like cancellation. Each button press may adjust the cursor
position or the menu scroll, and plays a sound effect if the action was successful.< / 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" > 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 pressed by the user.< / 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 action associated with the button was successfully processed, < code > false< / code > otherwise.< / p >
2024-07-29 22:13:21 +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/c8ce7960dd7dc620417df374c4736c3bed606902/src/ui/settings/abstract-settings-ui-handler.ts#L206" > src/ui/settings/abstract-settings-ui-handler.ts:206< / 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-07-29 22:13:21 +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/c8ce7960dd7dc620417df374c4736c3bed606902/src/ui/settings/abstract-settings-ui-handler.ts#L284" > src/ui/settings/abstract-settings-ui-handler.ts:284< / a > < / li > < / ul > < / aside > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member" > < 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" > < 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 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" > 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 >
2024-07-28 00:48:18 +01:00
< / div > < div class = "tsd-comment tsd-typography" > < / div > < / li > < li > < span > < code class = "tsd-tag" > 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 >
2024-06-01 13:57:45 +01:00
< / 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-29 22:13:21 +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/c8ce7960dd7dc620417df374c4736c3bed606902/src/ui/settings/abstract-settings-ui-handler.ts#L306" > src/ui/settings/abstract-settings-ui-handler.ts:306< / a > < / li > < / ul > < / aside > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member" > < 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" > < 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 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" > 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-29 22:13:21 +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/c8ce7960dd7dc620417df374c4736c3bed606902/src/ui/settings/abstract-settings-ui-handler.ts#L342" > src/ui/settings/abstract-settings-ui-handler.ts:342< / 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/c8ce7960dd7dc620417df374c4736c3bed606902/src/ui/settings/abstract-settings-ui-handler.ts#L53" > src/ui/settings/abstract-settings-ui-handler.ts:53< / 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-07-29 22:13:21 +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/c8ce7960dd7dc620417df374c4736c3bed606902/src/ui/settings/abstract-settings-ui-handler.ts#L179" > src/ui/settings/abstract-settings-ui-handler.ts:179< / a > < / li > < / ul > < / aside > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member" > < 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" > < 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" > < ul > < li > Defined in < a href = "https://github.com/pagefaultgames/pokerogue/blob/c8ce7960dd7dc620417df374c4736c3bed606902/src/ui/settings/abstract-settings-ui-handler.ts#L152" > src/ui/settings/abstract-settings-ui-handler.ts:152< / a > < / li > < / ul > < / aside > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member" > < 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" > < 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" > < ul > < li > Defined in < a href = "https://github.com/pagefaultgames/pokerogue/blob/c8ce7960dd7dc620417df374c4736c3bed606902/src/ui/settings/abstract-settings-ui-handler.ts#L359" > src/ui/settings/abstract-settings-ui-handler.ts:359< / 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 0 24 24" fill = "none" > < use href = "../assets/icons.svg#icon-chevronDown" > < / use > < / svg > On This Page< / h3 > < / summary > < div class = "tsd-accordion-details" > < details open class = "tsd-accordion tsd-page-navigation-section" > < summary class = "tsd-accordion-summary" data-key = "tsd-otp-Constructors" > < svg width = "20" height = "20" viewBox = "0 0 24 24" fill = "none" > < use href = "../assets/icons.svg#icon-chevronDown" > < / use > < / svg > Constructors< / summary > < div > < 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 > < / div > < / details > < details open class = "tsd-accordion tsd-page-navigation-section" > < summary class = "tsd-accordion-summary" data-key = "tsd-otp-Properties" > < svg width = "20" height = "20" viewBox = "0 0 24 24" fill = "none" > < use href = "../assets/icons.svg#icon-chevronDown" > < / use > < / svg > Properties< / summary > < div > < a href = "#active" class = "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 = "#cursor" 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 > cursor< / span > < / a > < a href = "#localStorageKey" class = "tsd-is-protected" > < svg cla
