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_achvs_ui_handler.html" > ui/achvs-ui-handler< / a > < / li > < li > < a href = "ui_achvs_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 > A basic abstract class to act as a holder and processor for UI elements.< / p >
2024-11-18 18:42:56 +00:00
< / div > < div class = "tsd-comment tsd-typography" > < / div > < / section > < section class = "tsd-panel tsd-hierarchy" > < h4 > Hierarchy (< a href = "../hierarchy.html#ui/achvs-ui-handler.default" > view full< / a > )< / h4 > < ul class = "tsd-hierarchy" > < li > < a href = "ui_message_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/0c920ba195c8fa8470694f5a1f4b3157438aa256/src/ui/achvs-ui-handler.ts#L28" > src/ui/achvs-ui-handler.ts:28< / 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_achvs_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-07-28 00:48:18 +01:00
< / div > < / section > < section class = "tsd-index-section" > < h3 class = "tsd-index-heading" > Properties< / h3 > < div class = "tsd-index-list" > < a href = "ui_achvs_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-05-31 14:57:14 +01:00
< a href = "ui_achvs_ui_handler.default.html#awaitingActionInput" 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 > awaiting< wbr / > Action< wbr / > Input< / span > < / a >
< a href = "ui_achvs_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_achvs_ui_handler.default.html#message" 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 > message< / span > < / a >
< a href = "ui_achvs_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_achvs_ui_handler.default.html#onActionInput" 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 > on< wbr / > Action< wbr / > Input< / span > < / a >
< a href = "ui_achvs_ui_handler.default.html#pendingPrompt" 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 > pending< wbr / > Prompt< / span > < / a >
< a href = "ui_achvs_ui_handler.default.html#prompt" 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 > prompt< / span > < / a >
< a href = "ui_achvs_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_achvs_ui_handler.default.html#textCallbackTimer" 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 > text< wbr / > Callback< wbr / > Timer< / span > < / a >
< a href = "ui_achvs_ui_handler.default.html#textTimer" 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 > text< wbr / > Timer< / span > < / a >
< a href = "ui_achvs_ui_handler.default.html#tutorialActive" 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 > tutorial< wbr / > Active< / span > < / a >
2024-09-27 22:52:07 +01:00
< a href = "ui_achvs_ui_handler.default.html#tutorialOverlay" 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 > tutorial< wbr / > Overlay< / span > < / a >
2024-05-31 14:57:14 +01:00
< / div > < / section > < section class = "tsd-index-section" > < h3 class = "tsd-index-heading" > Methods< / h3 > < div class = "tsd-index-list" > < a href = "ui_achvs_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_achvs_ui_handler.default.html#clearText" 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< wbr / > Text< / span > < / a >
< a href = "ui_achvs_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_achvs_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_achvs_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_achvs_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 >
2024-09-27 22:52:07 +01:00
< a href = "ui_achvs_ui_handler.default.html#initPromptSprite" 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 > init< wbr / > Prompt< wbr / > Sprite< / span > < / a >
< a href = "ui_achvs_ui_handler.default.html#initTutorialOverlay" 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 > init< wbr / > Tutorial< wbr / > Overlay< / span > < / a >
< a href = "ui_achvs_ui_handler.default.html#isTextAnimationInProgress" 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 > is< wbr / > Text< wbr / > Animation< wbr / > In< wbr / > Progress< / span > < / a >
2024-05-31 14:57:14 +01:00
< a href = "ui_achvs_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_achvs_ui_handler.default.html#processTutorialInput" 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 / > Tutorial< wbr / > Input< / span > < / a >
< a href = "ui_achvs_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 >
2024-09-10 23:07:25 +01:00
< a href = "ui_achvs_ui_handler.default.html#setMouseCursorStyle" 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-2048" > < / use > < / svg > < span > set< wbr / > Mouse< wbr / > Cursor< wbr / > Style< / span > < / a >
2024-08-17 18:01:18 +01:00
< a href = "ui_achvs_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 >
2024-05-31 14:57:14 +01:00
< a href = "ui_achvs_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_achvs_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_achvs_ui_handler.default.html#showAchv" class = "tsd-index-link tsd-is-protected" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-2048" > < / use > < / svg > < span > show< wbr / > Achv< / span > < / a >
< a href = "ui_achvs_ui_handler.default.html#showDialogue" 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< wbr / > Dialogue< / span > < / a >
< a href = "ui_achvs_ui_handler.default.html#showPrompt" 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< wbr / > Prompt< / span > < / a >
< a href = "ui_achvs_ui_handler.default.html#showText" 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< wbr / > Text< / span > < / a >
2024-09-01 23:17:02 +01:00
< a href = "ui_achvs_ui_handler.default.html#showVoucher" class = "tsd-index-link tsd-is-protected" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-2048" > < / use > < / svg > < span > show< wbr / > Voucher< / span > < / a >
2024-08-17 18:01:18 +01:00
< a href = "ui_achvs_ui_handler.default.html#updateAchvIcons" 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 / > Achv< wbr / > Icons< / span > < / a >
2024-09-01 23:17:02 +01:00
< a href = "ui_achvs_ui_handler.default.html#updateVoucherIcons" 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 / > Voucher< wbr / > Icons< / span > < / a >
2024-11-18 18:42:56 +00: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_achvs_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 > < span class = "tsd-kind-parameter" > mode< / span > : < span class = "tsd-signature-type" > null< / span > < span class = "tsd-signature-symbol" > | < / span > < a href = "../enums/ui_ui.Mode.html" class = "tsd-signature-type tsd-kind-enum" > Mode< / a > < span class = "tsd-signature-symbol" > = null< / span > < / span > < / li > < / ul > < / div > < h4 class = "tsd-returns-title" > Returns < a href = "ui_achvs_ui_handler.default.html" class = "tsd-signature-type tsd-kind-class" > default< / a > < / h4 > < aside class = "tsd-sources" > < p > Overrides < a href = "ui_message_ui_handler.default.html" > default< / a > .< a href = "ui_message_ui_handler.default.html#constructor" > constructor< / a > < / p > < ul > < li > Defined in < a href = "https://github.com/pagefaultgames/pokerogue/blob/0c920ba195c8fa8470694f5a1f4b3157438aa256/src/ui/achvs-ui-handler.ts#L60" > src/ui/achvs-ui-handler.ts:60< / 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_message_ui_handler.default.html" > default< / a > .< a href = "ui_message_ui_handler.default.html#active" > active< / a > < / p > < ul > < li > Defined in < a href = "https://github.com/pagefaultgames/pokerogue/blob/0c920ba195c8fa8470694f5a1f4b3157438aa256/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 = "awaitingActionInput" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < code class = "tsd-tag" > Protected< / code > < span > awaiting< wbr / > Action< wbr / > Input< / span > < a href = "#awaitingActionInput" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h3 > < d
2024-09-27 22:52:07 +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" > container< / span > : < span class = "tsd-signature-type" > Container< / span > < / span > < div class = "tsd-comment tsd-typography" > < p > the container to add the sprite to< / p >
2024-11-18 18:42:56 +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 > Inherited from < a href = "ui_message_ui_handler.default.html" > default< / a > .< a href = "ui_message_ui_handler.default.html#initPromptSprite" > initPromptSprite< / a > < / p > < ul > < li > Defined in < a href = "https://github.com/pagefaultgames/pokerogue/blob/0c920ba195c8fa8470694f5a1f4b3157438aa256/src/ui/message-ui-handler.ts#L24" > src/ui/message-ui-handler.ts:24< / a > < / li > < / ul > < / aside > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member tsd-is-inherited" > < a id = "initTutorialOverlay" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > init< wbr / > Tutorial< wbr / > Overlay< / span > < a href = "#initTutorialOverlay" 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 = "initTutorialOverlay.initTutorialOverlay-1" class = "tsd-anchor" > < / a > < span class = "tsd-kind-call-signature" > init< wbr / > Tutorial< wbr / > Overlay< / span > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-kind-parameter" > container< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > void< / span > < a href = "#initTutorialOverlay.initTutorialOverlay-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 > Create a semi transparent overlay that will get shown during tutorials< / p >
2024-09-27 22:52:07 +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" > container< / span > : < span class = "tsd-signature-type" > Container< / span > < / span > < div class = "tsd-comment tsd-typography" > < p > the container to add the overlay to< / p >
2024-11-18 18:42:56 +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 > Inherited from < a href = "ui_message_ui_handler.default.html" > default< / a > .< a href = "ui_message_ui_handler.default.html#initTutorialOverlay" > initTutorialOverlay< / a > < / p > < ul > < li > Defined in < a href = "https://github.com/pagefaultgames/pokerogue/blob/0c920ba195c8fa8470694f5a1f4b3157438aa256/src/ui/awaitable-ui-handler.ts#L33" > src/ui/awaitable-ui-handler.ts:33< / a > < / li > < / ul > < / aside > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member tsd-is-inherited" > < a id = "isTextAnimationInProgress" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > is< wbr / > Text< wbr / > Animation< wbr / > In< wbr / > Progress< / span > < a href = "#isTextAnimationInProgress" 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 = "isTextAnimationInProgress.isTextAnimationInProgress-1" class = "tsd-anchor" > < / a > < span class = "tsd-kind-call-signature" > is< wbr / > Text< wbr / > Animation< wbr / > In< wbr / > Progress< / 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 = "#isTextAnimationInProgress.isTextAnimationInProgress-1" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / li > < li class = "tsd-description" > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > boolean< / span > < / h4 > < aside class = "tsd-sources" > < p > Inherited from < a href = "ui_message_ui_handler.default.html" > default< / a > .< a href = "ui_message_ui_handler.default.html#isTextAnimationInProgress" > isTextAnimationInProgress< / a > < / p > < ul > < li > Defined in < a href = "https://github.com/pagefaultgames/pokerogue/blob/0c920ba195c8fa8470694f5a1f4b3157438aa256/src/ui/message-ui-handler.ts#L226" > src/ui/message-ui-handler.ts:226< / a > < / li > < / ul > < / aside > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member" > < a id = "processInput" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > process< wbr / > Input< / span > < a href = "#processInput" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h3 > < ul class = "tsd-signatures" > < li class = "tsd-signature tsd-anchor-link" > < a id = "processInput.processInput-1" class = "tsd-anchor" > < / a > < span class = "tsd-kind-call-signature" > process< wbr / > Input< / span > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-kind-parameter" > button< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < a href = "#processInput.processInput-1" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / li > < li class = "tsd-description" > < div class = "tsd-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 > < / li > < / ul > < / div > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > boolean< / span > < / h4 > < aside class = "tsd-sources" > < p > Overrides < a href = "ui_message_ui_handler.default.html" > default< / a > .< a href = "ui_message_ui_handler.default.html#processInput" > processInput< / a > < / p > < ul > < li > Defined in < a href = "https://github.com/pagefaultgames/pokerogue/blob/0c920ba195c8fa8470694f5a1f4b3157438aa256/src/ui/achvs-ui-handler.ts#L221" > src/ui/achvs-ui-handler.ts:221< / a > < / li > < / ul > < / aside > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member tsd-is-inherited" > < a id = "processTutorialInput" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > process< wbr / > Tutorial< wbr / > Input< / span > < a href = "#processTutorialInp
2024-09-10 23:07:25 +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" > cursorStyle< / span > : < span class = "tsd-signature-type" > " default" < / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > " pointer" < / span > < / span > < div class = "tsd-comment tsd-typography" > < p > cursor style to apply< / p >
< / 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" > < h4 class = "tsd-anchor-link" > < a id = "See" class = "tsd-anchor" > < / a > See< a href = "#See" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h4 > < p > < a href = "https://developer.mozilla.org/en-US/docs/Web/CSS/cursor" > https://developer.mozilla.org/en-US/docs/Web/CSS/cursor< / a > < / p >
2024-11-18 18:42:56 +00:00
< / div > < aside class = "tsd-sources" > < p > Inherited from < a href = "ui_message_ui_handler.default.html" > default< / a > .< a href = "ui_message_ui_handler.default.html#setMouseCursorStyle" > setMouseCursorStyle< / a > < / p > < ul > < li > Defined in < a href = "https://github.com/pagefaultgames/pokerogue/blob/0c920ba195c8fa8470694f5a1f4b3157438aa256/src/ui/ui-handler.ts#L60" > src/ui/ui-handler.ts:60< / 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 > setScrollCursor(scrollCursor: integer) : boolean
2024-08-17 18:01:18 +01:00
scrollCursor refers to the page's position within the entire sum of the data, unlike cursor, which refers to a user's position within displayed data< / 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" > scrollCursor< / span > : < span class = "tsd-signature-type" > number< / span > < / span > < / li > < / ul > < / div > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > boolean< / span > < / h4 > < p > returns a boolean that indicates whether the updated scrollCursor led to an update in the data displayed.< / p >
2024-11-18 18:42:56 +00:00
< div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/pagefaultgames/pokerogue/blob/0c920ba195c8fa8470694f5a1f4b3157438aa256/src/ui/achvs-ui-handler.ts#L346" > src/ui/achvs-ui-handler.ts:346< / 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" > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > void< / span > < / h4 > < aside class = "tsd-sources" > < p > Overrides < a href = "ui_message_ui_handler.default.html" > default< / a > .< a href = "ui_message_ui_handler.default.html#setup" > setup< / a > < / p > < ul > < li > Defined in < a href = "https://github.com/pagefaultgames/pokerogue/blob/0c920ba195c8fa8470694f5a1f4b3157438aa256/src/ui/achvs-ui-handler.ts#L68" > src/ui/achvs-ui-handler.ts:68< / 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-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 > < / li > < / ul > < / div > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > boolean< / span > < / h4 > < aside class = "tsd-sources" > < p > Overrides < a href = "ui_message_ui_handler.default.html" > default< / a > .< a href = "ui_message_ui_handler.default.html#show" > show< / a > < / p > < ul > < li > Defined in < a href = "https://github.com/pagefaultgames/pokerogue/blob/0c920ba195c8fa8470694f5a1f4b3157438aa256/src/ui/achvs-ui-handler.ts#L177" > src/ui/achvs-ui-handler.ts:177< / a > < / li > < / ul > < / aside > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member tsd-is-protected" > < a id = "showAchv" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < code class = "tsd-tag" > Protected< / code > < span > show< wbr / > Achv< / span > < a href = "#showAchv" 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-protected" > < li class = "tsd-signature tsd-anchor-link" > < a id = "showAchv.showAchv-1" class = "tsd-anchor" > < / a > < span class = "tsd-kind-call-signature" > show< wbr / > Achv< / span > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-kind-parameter" > achv< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > void< / span > < a href = "#showAchv.showAchv-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 = "ts
2024-08-17 18:01:18 +01:00
Determines what data is to be displayed on the UI and updates it accordingly based on the current value of this.scrollCursor< / p >
2024-11-18 18:42:56 +00:00
< / 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/0c920ba195c8fa8470694f5a1f4b3157438aa256/src/ui/achvs-ui-handler.ts#L378" > src/ui/achvs-ui-handler.ts:378< / a > < / li > < / ul > < / aside > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member" > < a id = "updateVoucherIcons" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > update< wbr / > Voucher< wbr / > Icons< / span > < a href = "#updateVoucherIcons" 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 = "updateVoucherIcons.updateVoucherIcons-1" class = "tsd-anchor" > < / a > < span class = "tsd-kind-call-signature" > update< wbr / > Voucher< wbr / > Icons< / 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 = "#updateVoucherIcons.updateVoucherIcons-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 > updateVoucherIcons(): void
2024-09-01 23:17:02 +01:00
Determines what data is to be displayed on the UI and updates it accordingly based on the current value of this.scrollCursor< / p >
2024-11-18 18:42:56 +00:00
< / 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/0c920ba195c8fa8470694f5a1f4b3157438aa256/src/ui/achvs-ui-handler.ts#L418" > src/ui/achvs-ui-handler.ts:418< / 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 = "#awaitingActionInput" 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 > awaiting< wbr / > Action< wbr / > Input< / span > < / a > < a href = "#cursor" class = "tsd-is-protected tsd-is-inherited" > < svg