pokerogue/main/classes/ui_party_ui_handler.default.html

81 lines
124 KiB
HTML
Raw Normal View History

2024-06-08 06:08:50 +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_party_ui_handler.html">ui/party-ui-handler</a></li><li><a href="ui_party_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-06-15 00:52:49 +01:00
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#ui/party-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/bce4c91c4297d414597f7be06945842fbf717ac4/src/ui/party-ui-handler.ts#L70">src/ui/party-ui-handler.ts:70</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="ui_party_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-05-31 14:57:14 +01:00
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="ui_party_ui_handler.default.html#active" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>active</span></a>
<a href="ui_party_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_party_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_party_ui_handler.default.html#fieldIndex" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>field<wbr/>Index</span></a>
<a href="ui_party_ui_handler.default.html#iconAnimHandler" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>icon<wbr/>Anim<wbr/>Handler</span></a>
<a href="ui_party_ui_handler.default.html#lastCursor" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>last<wbr/>Cursor</span></a>
2024-06-07 20:09:45 +01:00
<a href="ui_party_ui_handler.default.html#localizedOptions" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>localized<wbr/>Options</span></a>
2024-05-31 14:57:14 +01:00
<a href="ui_party_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_party_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>
2024-06-06 02:29:19 +01:00
<a href="ui_party_ui_handler.default.html#moveInfoOverlay" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>move<wbr/>Info<wbr/>Overlay</span></a>
2024-05-31 14:57:14 +01:00
<a href="ui_party_ui_handler.default.html#moveSelectFilter" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>move<wbr/>Select<wbr/>Filter</span></a>
<a href="ui_party_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_party_ui_handler.default.html#options" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>options</span></a>
<a href="ui_party_ui_handler.default.html#optionsBg" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>options<wbr/>Bg</span></a>
<a href="ui_party_ui_handler.default.html#optionsContainer" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>options<wbr/>Container</span></a>
<a href="ui_party_ui_handler.default.html#optionsCursor" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>options<wbr/>Cursor</span></a>
<a href="ui_party_ui_handler.default.html#optionsCursorObj" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>options<wbr/>Cursor<wbr/>Obj</span></a>
<a href="ui_party_ui_handler.default.html#optionsMode" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>options<wbr/>Mode</span></a>
<a href="ui_party_ui_handler.default.html#optionsScroll" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>options<wbr/>Scroll</span></a>
<a href="ui_party_ui_handler.default.html#optionsScrollCursor" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>options<wbr/>Scroll<wbr/>Cursor</span></a>
<a href="ui_party_ui_handler.default.html#optionsScrollTotal" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>options<wbr/>Scroll<wbr/>Total</span></a>
<a href="ui_party_ui_handler.default.html#partyBg" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>party<wbr/>Bg</span></a>
<a href="ui_party_ui_handler.default.html#partyCancelButton" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>party<wbr/>Cancel<wbr/>Button</span></a>
<a href="ui_party_ui_handler.default.html#partyContainer" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>party<wbr/>Container</span></a>
<a href="ui_party_ui_handler.default.html#partyMessageBox" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>party<wbr/>Message<wbr/>Box</span></a>
<a href="ui_party_ui_handler.default.html#partySlots" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>party<wbr/>Slots</span></a>
<a href="ui_party_ui_handler.default.html#partySlotsContainer" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>party<wbr/>Slots<wbr/>Container</span></a>
<a href="ui_party_ui_handler.default.html#partyUiMode" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>party<wbr/>Ui<wbr/>Mode</span></a>
<a href="ui_party_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_party_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_party_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_party_ui_handler.default.html#selectCallback" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>select<wbr/>Callback</span></a>
<a href="ui_party_ui_handler.default.html#selectFilter" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>select<wbr/>Filter</span></a>
<a href="ui_party_ui_handler.default.html#showMovePp" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>show<wbr/>Move<wbr/>Pp</span></a>
<a href="ui_party_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_party_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_party_ui_handler.default.html#tmMoveId" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tm<wbr/>Move<wbr/>Id</span></a>
<a href="ui_party_ui_handler.default.html#transferCursor" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>transfer<wbr/>Cursor</span></a>
<a href="ui_party_ui_handler.default.html#transferMode" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>transfer<wbr/>Mode</span></a>
<a href="ui_party_ui_handler.default.html#transferOptionCursor" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>transfer<wbr/>Option<wbr/>Cursor</span></a>
<a href="ui_party_ui_handler.default.html#transferQuantities" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>transfer<wbr/>Quantities</span></a>
<a href="ui_party_ui_handler.default.html#transferQuantitiesMax" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>transfer<wbr/>Quantities<wbr/>Max</span></a>
<a href="ui_party_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>
<a href="ui_party_ui_handler.default.html#NoEffectMessage" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>No<wbr/>Effect<wbr/>Message</span></a>
2024-06-08 06:08:50 +01:00
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="ui_party_ui_handler.default.html#FilterChallengeLegal" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>Filter<wbr/>Challenge<wbr/>Legal</span></a>
<a href="ui_party_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>
2024-05-31 14:57:14 +01:00
<a href="ui_party_ui_handler.default.html#clearOptions" 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/>Options</span></a>
<a href="ui_party_ui_handler.default.html#clearPartySlots" 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/>Party<wbr/>Slots</span></a>
<a href="ui_party_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_party_ui_handler.default.html#clearTransfer" 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/>Transfer</span></a>
<a href="ui_party_ui_handler.default.html#doRelease" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>do<wbr/>Release</span></a>
<a href="ui_party_ui_handler.default.html#eraseOptionsCursor" 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/>Options<wbr/>Cursor</span></a>
<a href="ui_party_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_party_ui_handler.default.html#getOptionsCursorWithScroll" 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/>Options<wbr/>Cursor<wbr/>With<wbr/>Scroll</span></a>
<a href="ui_party_ui_handler.default.html#getReleaseMessage" 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/>Release<wbr/>Message</span></a>
<a href="ui_party_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_party_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_party_ui_handler.default.html#populatePartySlots" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>populate<wbr/>Party<wbr/>Slots</span></a>
<a href="ui_party_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_party_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_party_ui_handler.default.html#setCursor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Cursor</span></a>
<a href="ui_party_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_party_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_party_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_party_ui_handler.default.html#showOptions" 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/>Options</span></a>
<a href="ui_party_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_party_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_party_ui_handler.default.html#startTransfer" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>start<wbr/>Transfer</span></a>
<a href="ui_party_ui_handler.default.html#updateOptions" 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/>Options</span></a>
<a href="ui_party_ui_handler.default.html#FilterAll" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>Filter<wbr/>All</span></a>
<a href="ui_party_ui_handler.default.html#FilterAllMoves" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>Filter<wbr/>All<wbr/>Moves</span></a>
<a href="ui_party_ui_handler.default.html#FilterFainted" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>Filter<wbr/>Fainted</span></a>
<a href="ui_party_ui_handler.default.html#FilterItemMaxStacks" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>Filter<wbr/>Item<wbr/>Max<wbr/>Stacks</span></a>
<a href="ui_party_ui_handler.default.html#FilterNonFainted" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>Filter<wbr/>Non<wbr/>Fainted</span></a>
2024-06-15 00:52:49 +01:00
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_default" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new default</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scene</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ui_party_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_party_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/bce4c91c4297d414597f7be06945842fbf717ac4/src/ui/party-ui-handler.ts#L153">src/ui/party-ui-handler.ts:153</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-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/bce4c91c4297d414597f7be06945842fbf717ac4/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 ts-flagProtected">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#awaitingActionInput">awaitingActionInput</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/bce4c91c4297d414597f7be06945842fbf717ac4/src/ui/awaitable-ui-handler.ts#L7">src/ui/awaitable-ui-handler.ts:7</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="cursor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>cursor</span><a href="#cur
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/bce4c91c4297d414597f7be06945842fbf717ac4/src/ui/party-ui-handler.ts#L96">src/ui/party-ui-handler.ts:96</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="transferQuantitiesMax" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>transfer<wbr/>Quantities<wbr/>Max</span><a href="#transferQuantitiesMax" 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">transfer<wbr/>Quantities<wbr/>Max</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>Stack size of every item that the selected pokemon is holding</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/bce4c91c4297d414597f7be06945842fbf717ac4/src/ui/party-ui-handler.ts#L98">src/ui/party-ui-handler.ts:98</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="tutorialActive" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>tutorial<wbr/>Active</span><a href="#tutorialActive" 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">tutorial<wbr/>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#tutorialActive">tutorialActive</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/bce4c91c4297d414597f7be06945842fbf717ac4/src/ui/awaitable-ui-handler.ts#L9">src/ui/awaitable-ui-handler.ts:9</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="NoEffectMessage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>No<wbr/>Effect<wbr/>Message</span><a href="#NoEffectMessage" 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">No<wbr/>Effect<wbr/>Message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;It won&#39;t have any effect.&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/bce4c91c4297d414597f7be06945842fbf717ac4/src/ui/party-ui-handler.ts#L149">src/ui/party-ui-handler.ts:149</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-is-private"><a id="FilterChallengeLegal" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>Filter<wbr/>Challenge<wbr/>Legal</span><a href="#FilterChallengeLegal" 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-private"><li class="tsd-signature tsd-anchor-link"><a id="FilterChallengeLegal.FilterChallengeLegal-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">Filter<wbr/>Challenge<wbr/>Legal</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">pokemon</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#FilterChallengeLegal.FilterChallengeLegal-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>For consistency reasons, this looks like the above filters. However this is used only internally and is always enforced for switching.</p>
2024-06-08 06:08:50 +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">pokemon</span>: <a href="field_pokemon.PlayerPokemon.html" class="tsd-signature-type tsd-kind-class">PlayerPokemon</a></span><div class="tsd-comment tsd-typography"><p>The pokemon to check.</p>
2024-06-15 00:52:49 +01:00
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</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/bce4c91c4297d414597f7be06945842fbf717ac4/src/ui/party-ui-handler.ts#L130">src/ui/party-ui-handler.ts:130</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="clear" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>clear</span><a href="#clear" 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="clear.clear-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">clear</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="#clear.clear-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#clear">clear</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/bce4c91c4297d414597f7be06945842fbf717ac4/src/ui/party-ui-handler.ts#L958">src/ui/party-ui-handler.ts:958</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="clearOptions" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>clear<wbr/>Options</span><a href="#clearOptions" 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="clearOptions.clearOptions-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">clear<wbr/>Options</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="#clearOptions.clearOptions-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/bce4c91c4297d414597f7be06945842fbf717ac4/src/ui/party-ui-handler.ts#L936">src/ui/party-ui-handler.ts:936</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="clearPartySlots" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>clear<wbr/>Party<wbr/>Slots</span><a href="#clearPartySlots" 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="clearPartySlots.clearPartySlots-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">clear<wbr/>Party<wbr/>Slots</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="#clearPartySlots.clearPartySlots-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/bce4c91c4297d414597f7be06945842fbf717ac4/src/ui/party-ui-handl