pokerogue/main/classes/ui_starter_select_ui_handle...

98 lines
137 KiB
HTML
Raw Normal View History

2024-07-27 23:48:18 +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_starter_select_ui_handler.html">ui/starter-select-ui-handler</a></li><li><a href="ui_starter_select_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-09-01 23:05:27 +00:00
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a href="../hierarchy.html#ui/starter-select-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/ac1c29facaedc572f7cdcf2c69aeb3a379c0c153/src/ui/starter-select-ui-handler.ts#L221">src/ui/starter-select-ui-handler.ts:221</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_starter_select_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-27 23:48:18 +00:00
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="ui_starter_select_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 13:57:14 +00:00
<a href="ui_starter_select_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_starter_select_ui_handler.default.html#blockInput" 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>block<wbr/>Input</span></a>
<a href="ui_starter_select_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-07 22:34:52 +00:00
<a href="ui_starter_select_ui_handler.default.html#cursorObj" class="tsd-index-link"><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-05-31 13:57:14 +00:00
<a href="ui_starter_select_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_starter_select_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_starter_select_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_starter_select_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_starter_select_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_starter_select_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-07-27 23:48:18 +00:00
<a href="ui_starter_select_ui_handler.default.html#starterSpecies" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>starter<wbr/>Species</span></a>
2024-05-31 13:57:14 +00:00
<a href="ui_starter_select_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_starter_select_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_starter_select_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-07-27 23:48:18 +00:00
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="ui_starter_select_ui_handler.default.html#addToParty" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>To<wbr/>Party</span></a>
<a href="ui_starter_select_ui_handler.default.html#checkIconId" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>check<wbr/>Icon<wbr/>Id</span></a>
2024-05-31 13:57:14 +00:00
<a href="ui_starter_select_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_starter_select_ui_handler.default.html#clearText" 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<wbr/>Text</span></a>
2024-08-17 17:01:18 +00:00
<a href="ui_starter_select_ui_handler.default.html#getCurrentDexProps" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Current<wbr/>Dex<wbr/>Props</span></a>
2024-05-31 13:57:14 +00:00
<a href="ui_starter_select_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_starter_select_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_starter_select_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_starter_select_ui_handler.default.html#getValueLimit" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Value<wbr/>Limit</span></a>
2024-06-10 16:42:16 +00:00
<a href="ui_starter_select_ui_handler.default.html#hideInstructions" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>hide<wbr/>Instructions</span></a>
2024-09-01 22:17:02 +00:00
<a href="ui_starter_select_ui_handler.default.html#initStarterPrefs" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>init<wbr/>Starter<wbr/>Prefs</span></a>
2024-07-27 23:48:18 +00:00
<a href="ui_starter_select_ui_handler.default.html#isInParty" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>In<wbr/>Party</span></a>
<a href="ui_starter_select_ui_handler.default.html#isPartyValid" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Party<wbr/>Valid</span></a>
2024-05-31 13:57:14 +00:00
<a href="ui_starter_select_ui_handler.default.html#isPassiveAvailable" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Passive<wbr/>Available</span></a>
2024-06-22 00:21:13 +00:00
<a href="ui_starter_select_ui_handler.default.html#isSameSpeciesEggAvailable" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Same<wbr/>Species<wbr/>Egg<wbr/>Available</span></a>
2024-05-31 13:57:14 +00:00
<a href="ui_starter_select_ui_handler.default.html#isUpgradeAnimationEnabled" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Upgrade<wbr/>Animation<wbr/>Enabled</span></a>
<a href="ui_starter_select_ui_handler.default.html#isUpgradeIconEnabled" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Upgrade<wbr/>Icon<wbr/>Enabled</span></a>
<a href="ui_starter_select_ui_handler.default.html#isValueReductionAvailable" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Value<wbr/>Reduction<wbr/>Available</span></a>
2024-07-27 23:48:18 +00:00
<a href="ui_starter_select_ui_handler.default.html#moveStarterIconsCursor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>move<wbr/>Starter<wbr/>Icons<wbr/>Cursor</span></a>
2024-05-31 13:57:14 +00:00
<a href="ui_starter_select_ui_handler.default.html#onCandyUpgradeDisplayChanged" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>on<wbr/>Candy<wbr/>Upgrade<wbr/>Display<wbr/>Changed</span></a>
<a href="ui_starter_select_ui_handler.default.html#popStarter" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>pop<wbr/>Starter</span></a>
<a href="ui_starter_select_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_starter_select_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>
2024-08-17 17:01:18 +00:00
<a href="ui_starter_select_ui_handler.default.html#resetFilters" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>reset<wbr/>Filters</span></a>
2024-05-31 13:57:14 +00:00
<a href="ui_starter_select_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-07-27 23:48:18 +00:00
<a href="ui_starter_select_ui_handler.default.html#setFilterMode" 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/>Filter<wbr/>Mode</span></a>
2024-05-31 13:57:14 +00:00
<a href="ui_starter_select_ui_handler.default.html#setSpecies" 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/>Species</span></a>
<a href="ui_starter_select_ui_handler.default.html#setSpeciesDetails" 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/>Species<wbr/>Details</span></a>
<a href="ui_starter_select_ui_handler.default.html#setTypeIcons" 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/>Type<wbr/>Icons</span></a>
<a href="ui_starter_select_ui_handler.default.html#setUpgradeAnimation" 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/>Upgrade<wbr/>Animation</span></a>
<a href="ui_starter_select_ui_handler.default.html#setUpgradeIcon" 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/>Upgrade<wbr/>Icon</span></a>
<a href="ui_starter_select_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_starter_select_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_starter_select_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_starter_select_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_starter_select_ui_handler.default.html#showStats" 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<wbr/>Stats</span></a>
<a href="ui_starter_select_ui_handler.default.html#showText" 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<wbr/>Text</span></a>
<a href="ui_starter_select_ui_handler.default.html#switchMoveHandler" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>switch<wbr/>Move<wbr/>Handler</span></a>
<a href="ui_starter_select_ui_handler.default.html#toggleStatsMode" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>toggle<wbr/>Stats<wbr/>Mode</span></a>
2024-08-17 17:01:18 +00:00
<a href="ui_starter_select_ui_handler.default.html#tryExit" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>try<wbr/>Exit</span></a>
2024-05-31 13:57:14 +00:00
<a href="ui_starter_select_ui_handler.default.html#tryStart" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>try<wbr/>Start</span></a>
<a href="ui_starter_select_ui_handler.default.html#tryUpdateValue" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>try<wbr/>Update<wbr/>Value</span></a>
2024-06-10 16:42:16 +00:00
<a href="ui_starter_select_ui_handler.default.html#updateButtonIcon" 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/>Button<wbr/>Icon</span></a>
2024-08-17 17:01:18 +00:00
<a href="ui_starter_select_ui_handler.default.html#updateFilterButtonIcon" 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/>Filter<wbr/>Button<wbr/>Icon</span></a>
2024-05-31 13:57:14 +00:00
<a href="ui_starter_select_ui_handler.default.html#updateInstructions" 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/>Instructions</span></a>
2024-08-17 17:01:18 +00:00
<a href="ui_starter_select_ui_handler.default.html#updatePartyIcon" 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/>Party<wbr/>Icon</span></a>
2024-07-27 23:48:18 +00:00
<a href="ui_starter_select_ui_handler.default.html#updateScroll" 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/>Scroll</span></a>
2024-05-31 13:57:14 +00:00
<a href="ui_starter_select_ui_handler.default.html#updateStarterValueLabel" 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/>Starter<wbr/>Value<wbr/>Label</span></a>
2024-07-27 23:48:18 +00:00
<a href="ui_starter_select_ui_handler.default.html#updateStarters" 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/>Starters</span></a>
2024-09-01 23:05:27 +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-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ui_starter_select_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></ul></div><h4 class="tsd-returns-title">Returns <a href="ui_starter_select_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/ac1c29facaedc572f7cdcf2c69aeb3a379c0c153/src/ui/starter-select-ui-handler.ts#L351">src/ui/starter-select-ui-handler.ts:351</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/ac1c29facaedc572f7cdcf2c69aeb3a379c0c153/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><div class="tsd-signature"><span class="tsd-kind-property">awaiting<wbr/>Action<wbr/>Input</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</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#awa
2024-09-01 22:17:02 +00:00
and to display the correct shiny, variant, and form based on the StarterPreferences</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">speciesId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>the id of the species to get props for</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">bigint</span></h4><p>the dex props</p>
2024-09-01 23:05:27 +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/ac1c29facaedc572f7cdcf2c69aeb3a379c0c153/src/ui/starter-select-ui-handler.ts#L3430">src/ui/starter-select-ui-handler.ts:3430</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_message_ui_handler.default.html">default</a>.<a href="ui_message_ui_handler.default.html#getCursor">getCursor</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/ac1c29facaedc572f7cdcf2c69aeb3a379c0c153/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_message_ui_handler.default.html">default</a>.<a href="ui_message_ui_handler.default.html#getTextColor">getTextColor</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/ac1c29facaedc572f7cdcf2c69aeb3a379c0c153/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-signature tsd-anchor-link"><a id="getUi.getUi-1" class="tsd-anchor"></a><span class=
2024-09-01 22:17:02 +00:00
If somehow a preference is set for a form, variant, gender, ability or nature
that wasn't actually unlocked or is invalid it will be cleared here</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">species</span>: <a href="data_pokemon_species.default.html" class="tsd-signature-type tsd-kind-class">default</a></span><div class="tsd-comment tsd-typography"><p>The species to get Starter Preferences for</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../interfaces/system_game_data.StarterAttributes.html" class="tsd-signature-type tsd-kind-interface">StarterAttributes</a></h4><p>StarterAttributes for the species</p>
2024-09-01 23:05:27 +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/ac1c29facaedc572f7cdcf2c69aeb3a379c0c153/src/ui/starter-select-ui-handler.ts#L955">src/ui/starter-select-ui-handler.ts:955</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="isInParty" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>In<wbr/>Party</span><a href="#isInParty" 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="isInParty.isInParty-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">is<wbr/>In<wbr/>Party</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">species</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><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">]</span><a href="#isInParty.isInParty-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">species</span>: <a href="data_pokemon_species.default.html" class="tsd-signature-type tsd-kind-class">default</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">]</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/ac1c29facaedc572f7cdcf2c69aeb3a379c0c153/src/ui/starter-select-ui-handler.ts#L2092">src/ui/starter-select-ui-handler.ts:2092</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="isPartyValid" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Party<wbr/>Valid</span><a href="#isPartyValid" 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="isPartyValid.isPartyValid-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">is<wbr/>Party<wbr/>Valid</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="#isPartyValid.isPartyValid-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/ac1c29facaedc572f7cdcf2c69aeb3a379c0c153/src/ui/starter-select-ui-handler.ts#L3412">src/ui/starter-select-ui-handler.ts:3412</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="isPassiveAvailable" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Passive<wbr/>Available</span><a href="#isPassiveAvailable" 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="isPassiveAvailable.isPassiveAvailable-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">is<wbr/>Passive<wbr/>Available</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">speciesId</
2024-05-31 13:57:14 +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">speciesId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The ID of the species to check the passive of</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>true if the user has enough candies and a passive has not been unlocked already</p>
2024-09-01 23:05:27 +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/ac1c29facaedc572f7cdcf2c69aeb3a379c0c153/src/ui/starter-select-ui-handler.ts#L1085">src/ui/starter-select-ui-handler.ts:1085</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="isSameSpeciesEggAvailable" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Same<wbr/>Species<wbr/>Egg<wbr/>Available</span><a href="#isSameSpeciesEggAvailable" 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="isSameSpeciesEggAvailable.isSameSpeciesEggAvailable-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">is<wbr/>Same<wbr/>Species<wbr/>Egg<wbr/>Available</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">speciesId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#isSameSpeciesEggAvailable.isSameSpeciesEggAvailable-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>Determines if an same species egg can be bought for the given species ID</p>
2024-06-22 00:21:13 +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">speciesId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The ID of the species to check the value reduction of</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>true if the user has enough candies</p>
2024-09-01 23:05:27 +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/ac1c29facaedc572f7cdcf2c69aeb3a379c0c153/src/ui/starter-select-ui-handler.ts#L1111">src/ui/starter-select-ui-handler.ts:1111</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="isUpgradeAnimationEnabled" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Upgrade<wbr/>Animation<wbr/>Enabled</span><a href="#isUpgradeAnimationEnabled" 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="isUpgradeAnimationEnabled.isUpgradeAnimationEnabled-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">is<wbr/>Upgrade<wbr/>Animation<wbr/>Enabled</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="#isUpgradeAnimationEnabled.isUpgradeAnimationEnabled-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>Determines if 'Animation' based upgrade notifications should be shown</p>
2024-07-27 23:48:18 +00:00
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>true if upgrade notifications are enabled and set to display an 'Animation'</p>
2024-09-01 23:05:27 +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/ac1c29facaedc572f7cdcf2c69aeb3a379c0c153/src/ui/starter-select-ui-handler.ts#L1076">src/ui/starter-select-ui-handler.ts:1076</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="isUpgradeIconEnabled" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Upgrade<wbr/>Icon<wbr/>Enabled</span><a href="#isUpgradeIconEnabled" 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="isUpgradeIconEnabled.isUpgradeIconEnabled-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">is<wbr/>Upgrade<wbr/>Icon<wbr/>Enabled</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="#isUpgradeIconEnabled.isUpgradeIconEnabled-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>Determines if 'Icon' based upgrade notifications should be shown</p>
2024-07-27 23:48:18 +00:00
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>true if upgrade notifications are enabled and set to display an 'Icon'</p>
2024-09-01 23:05:27 +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/ac1c29facaedc572f7cdcf2c69aeb3a379c0c153/src/ui/starter-select-ui-handler.ts#L1069">src/ui/starter-select-ui-handler.ts:1069</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="isValueReductionAvailable" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Value<wbr/>Reduction<wbr/>Available</span><a href="#isValueReductionAvailable" 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="isValueReductionAvailable.isValueReductionAvailable-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">is<wbr/>Value<wbr/>Reduction<wbr/>Available</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">speciesId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#isValueReductionAvailable.isValueReductionAvailable-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>Determines if a value reduction upgrade is available for the given species ID</p>
2024-05-31 13:57:14 +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">speciesId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The ID of the species to check the value reduction of</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>true if the user has enough candies and all value reductions have not been unlocked already</p>
2024-09-01 23:05:27 +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/ac1c29facaedc572f7cdcf2c69aeb3a379c0c153/src/ui/starter-select-ui-handler.ts#L1098">src/ui/starter-select-ui-handler.ts:1098</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="moveStarterIconsCursor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>move<wbr/>Starter<wbr/>Icons<wbr/>Cursor</span><a href="#moveStarterIconsCursor" 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="moveStarterIconsCursor.moveStarterIconsCursor-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">move<wbr/>Starter<wbr/>Icons<wbr/>Cursor</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">index</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#moveStarterIconsCursor.moveStarterIconsCursor-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">index</span>: <span class="tsd-signature-type">number</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/ac1c29facaedc572f7cdcf2c69aeb3a379c0c153/src/ui/starter-select-ui-handler.ts#L2656">src/ui/starter-select-ui-handler.ts:2656</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="onCandyUpgradeDisplayChanged" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>on<wbr/>Candy<wbr/>Upgrade<wbr/>Display<wbr/>Changed</span><a href="#onCandyUpgradeDisplayChanged" 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="onCandyUpgradeDisplayChanged.onCandyUpgradeDisplayChanged-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">on<wbr/>Candy<wbr/>Upgrade<wbr/>Display<wbr/>Changed</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#onCandyUpgradeDisplayChanged.onCandyUpgradeDisplayChanged-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>Processes an <a href="events_battle_scene.CandyUpgradeNotificationChangedEvent.html" class="tsd-kind-class"><code>CandyUpgradeNotificationChangedEvent</code></a> sent when the corresponding setting changes</p>
2024-05-31 13:57:14 +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">event</span>: <span class="tsd-signature-type">Event</span></span><div class="tsd-comment tsd-typography"><p>Event sent by the callback</p>
2024-09-01 23:05:27 +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"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/ac1c29facaedc572f7cdcf2c69aeb3a379c0c153/src/ui/starter-select-ui-handler.ts#L1207">src/ui/starter-select-ui-handler.ts:1207</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="popStarter" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>pop<wbr/>Starter</span><a href="#popStarter" 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="popStarter.popStarter-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">pop<wbr/>Starter</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">index</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#popStarter.popStarter-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">index</span>: <span class="tsd-signature-type">number</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/ac1c29facaedc572f7cdcf2c69aeb3a379c0c153/src/ui/starter-select-ui-handler.ts#L3182">src/ui/starter-select-ui-handler.ts:3182</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/ac1c29facaedc572f7cdcf2c69aeb3a379c0c153/src/ui/starter-select-ui-handler.ts#L1230">src/ui/starter-select-ui-handler.ts:1230</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="#processTutorialInput" 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-
</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/ac1c29facaedc572f7cdcf2c69aeb3a379c0c153/src/ui/starter-select-ui-handler.ts#L1037">src/ui/starter-select-ui-handler.ts:1037</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-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></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#setCursor">setCursor</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/ac1c29facaedc572f7cdcf2c69aeb3a379c0c153/src/ui/starter-select-ui-handler.ts#L2603">src/ui/starter-select-ui-handler.ts:2603</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="setFilterMode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Filter<wbr/>Mode</span><a href="#setFilterMode" 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="setFilterMode.setFilterMode-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set<wbr/>Filter<wbr/>Mode</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">filterMode</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#setFilterMode.setFilterMode-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">filterMode</span>: <span class="tsd-signature-type">boolean</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/ac1c29facaedc572f7cdcf2c69aeb3a379c0c153/src/ui/starter-select-ui-handler.ts#L2638">src/ui/starter-select-ui-handler.ts:2638</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="setSpecies" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Species</span><a href="#setSpecies" 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="setSpecies.setSpecies-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set<wbr/>Species</span><span class="tsd-signature-sym
2024-05-31 13:57:14 +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">icon</span>: <span class="tsd-signature-type">Sprite</span></span><div class="tsd-comment tsd-typography"><p>Phaser.GameObjects.GameObject to animate</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">species</span>: <a href="data_pokemon_species.default.html" class="tsd-signature-type tsd-kind-class">default</a></span><div class="tsd-comment tsd-typography"><p><a href="data_pokemon_species.default.html" class="tsd-kind-class"><code>PokemonSpecies</code></a> of the icon used to check for upgrades</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">startPaused</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span><div class="tsd-comment tsd-typography"><p>Should this animation be paused after it is added?</p>
2024-09-01 23:05:27 +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"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/ac1c29facaedc572f7cdcf2c69aeb3a379c0c153/src/ui/starter-select-ui-handler.ts#L1124">src/ui/starter-select-ui-handler.ts:1124</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="setUpgradeIcon" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Upgrade<wbr/>Icon</span><a href="#setUpgradeIcon" 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="setUpgradeIcon.setUpgradeIcon-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set<wbr/>Upgrade<wbr/>Icon</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">starter</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setUpgradeIcon.setUpgradeIcon-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>Sets the visibility of a Candy Upgrade Icon</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">starter</span>: <a href="ui_starter_container.StarterContainer.html" class="tsd-signature-type tsd-kind-class">StarterContainer</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/ac1c29facaedc572f7cdcf2c69aeb3a379c0c153/src/ui/starter-select-ui-handler.ts#L1176">src/ui/starter-select-ui-handler.ts:1176</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/ac1c29facaedc572f7cdcf2c69aeb3a379c0c153/src/ui/starter-select-ui-handler.ts#L355">src/ui/starter-select-ui-handler.ts:355</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/ac1c29facaedc572f7cdcf2c69aeb3a379c0c153/src/ui/starter-select-ui-handler.ts#L901">src/ui/starter-select-ui-handler.ts:901</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="showDialogue" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>show<wbr/>Dialogue</span><a href="#showDialogue" 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="showDialogue.showDialogue-1" class="tsd-anchor"></a><span class="tsd-kind