<!DOCTYPE html><htmlclass="default"lang="en"><head><metacharSet="utf-8"/><metahttp-equiv="x-ua-compatible"content="IE=edge"/><title>default | pokemon-rogue-battle</title><metaname="description"content="Documentation for pokemon-rogue-battle"/><metaname="viewport"content="width=device-width, initial-scale=1"/><linkrel="stylesheet"href="../assets/style.css"/><linkrel="stylesheet"href="../assets/highlight.css"/><scriptdefersrc="../assets/main.js"></script><scriptasyncsrc="../assets/icons.js"id="tsd-icons-script"></script><scriptasyncsrc="../assets/search.js"id="tsd-search-script"></script><scriptasyncsrc="../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><headerclass="tsd-page-toolbar"><divclass="tsd-toolbar-contents container"><divclass="table-cell"id="tsd-search"data-base=".."><divclass="field"><labelfor="tsd-search-field"class="tsd-widget tsd-toolbar-icon search no-caption"><svgwidth="16"height="16"viewBox="0 0 16 16"fill="none"><usehref="../assets/icons.svg#icon-search"></use></svg></label><inputtype="text"id="tsd-search-field"aria-label="Search"/></div><divclass="field"><divid="tsd-toolbar-links"></div></div><ulclass="results"><liclass="state loading">Preparing search index...</li><liclass="state failure">The search index is not available</li></ul><ahref="../index.html"class="title">pokemon-rogue-battle</a></div><divclass="table-cell"id="tsd-widgets"><ahref="#"class="tsd-widget tsd-toolbar-icon menu no-caption"data-toggle="menu"aria-label="Menu"><svgwidth="16"height="16"viewBox="0 0 16 16"fill="none"><usehref="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><divclass="container container-main"><divclass="col-content"><divclass="tsd-page-title"><ulclass="tsd-breadcrumb"><li><ahref="../index.html">pokemon-rogue-battle</a></li><li><ahref="../modules/ui_party_ui_handler.html">ui/party-ui-handler</a></li><li><ahref="ui_party_ui_handler.default.html">default</a></li></ul><h1>Class default</h1></div><sectionclass="tsd-panel tsd-comment"><divclass="tsd-comment tsd-typography"><p>A basic abstract class to act as a holder and processor for UI elements.</p>
</div></section></div></details></section></section><sectionclass="tsd-panel-group tsd-member-group"><h2>Constructors</h2><sectionclass="tsd-panel tsd-member"><aid="constructor"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>constructor</span><ahref="#constructor"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass="tsd-signature tsd-anchor-link"><aid="constructor.new_default"class="tsd-anchor"></a><spanclass="tsd-kind-constructor-signature">new default</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">scene</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><ahref="ui_party_ui_handler.default.html"class="tsd-signature-type tsd-kind-class">default</a><ahref="#constructor.new_default"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">scene</span>: <ahref="battle_scene.default.html"class="tsd-signature-type tsd-kind-class">default</a></span></li></ul></div><h4class="tsd-returns-title">Returns <ahref="ui_party_ui_handler.default.html"class="tsd-signature-type tsd-kind-class">default</a></h4><asideclass="tsd-sources"><p>Overrides <ahref="ui_message_ui_handler.default.html">default</a>.<ahref="ui_message_ui_handler.default.html#constructor">constructor</a></p><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/e21b91858b3251e3e40094cb9b7153d87b63bc12/src/ui/party-ui-handler.ts#L158">src/ui/party-ui-handler.ts:158</a></li></ul></aside></li></ul></section></section><sectionclass="tsd-panel-group tsd-member-group"><h2>Properties</h2><sectionclass="tsd-panel tsd-member tsd-is-inherited"><aid="active"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>active</span><ahref="#active"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">active</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">boolean</span><spanclass="tsd-signature-symbol"> = false</span></div><asideclass="tsd-sources"><p>Inherited from <ahref="ui_message_ui_handler.default.html">default</a>.<ahref="ui_message_ui_handler.default.html#active">active</a></p><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/e21b91858b3251e3e40094cb9b7153d87b63bc12/src/ui/ui-handler.ts#L13">src/ui/ui-handler.ts:13</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><aid="awaitingActionInput"class="tsd-anchor"></a><h3class="tsd-anchor-link"><codeclass="tsd-tag ts-flagProtected">Protected</code><span>awaiting<wbr/>Action<wbr/>Input</span><ahref="#awaitingActionInput"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">awaiting<wbr/>Action<wbr/>Input</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">boolean</span></div><asideclass="tsd-sources"><p>Inherited from <ahref="ui_message_ui_handler.default.html">default</a>.<ahref="ui_message_ui_handler.default.html#awaitingActionInput">awaitingActionInput</a></p><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/e21b91858b3251e3e40094cb9b7153d87b63bc12/src/ui/awaitable-ui-handler.ts#L7">src/ui/awaitable-ui-handler.ts:7</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><aid="cursor"class="tsd-anchor"></a><h3class="tsd-anchor-link"><codeclass="tsd-tag ts-flagProtected">Protected</code><span>cursor</span><ahref="#cur
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/e21b91858b3251e3e40094cb9b7153d87b63bc12/src/ui/party-ui-handler.ts#L90">src/ui/party-ui-handler.ts:90</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-private"><aid="optionsCursor"class="tsd-anchor"></a><h3class="tsd-anchor-link"><codeclass="tsd-tag ts-flagPrivate">Private</code><span>options<wbr/>Cursor</span><ahref="#optionsCursor"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">options<wbr/>Cursor</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">number</span><spanclass="tsd-signature-symbol"> = 0</span></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/e21b91858b3251e3e40094cb9b7153d87b63bc12/src/ui/party-ui-handler.ts#L86">src/ui/party-ui-handler.ts:86</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-private"><aid="optionsCursorObj"class="tsd-anchor"></a><h3class="tsd-anchor-link"><codeclass="tsd-tag ts-flagPrivate">Private</code><span>options<wbr/>Cursor<wbr/>Obj</span><ahref="#optionsCursorObj"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">options<wbr/>Cursor<wbr/>Obj</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">Image</span></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/e21b91858b3251e3e40094cb9b7153d87b63bc12/src/ui/party-ui-handler.ts#L92">src/ui/party-ui-handler.ts:92</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-private"><aid="optionsMode"class="tsd-anchor"></a><h3class="tsd-anchor-link"><codeclass="tsd-tag ts-flagPrivate">Private</code><span>options<wbr/>Mode</span><ahref="#optionsMode"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">options<wbr/>Mode</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">boolean</span></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/e21b91858b3251e3e40094cb9b7153d87b63bc12/src/ui/party-ui-handler.ts#L84">src/ui/party-ui-handler.ts:84</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-private"><aid="optionsScroll"class="tsd-anchor"></a><h3class="tsd-anchor-link"><codeclass="tsd-tag ts-flagPrivate">Private</code><span>options<wbr/>Scroll</span><ahref="#optionsScroll"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">options<wbr/>Scroll</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">boolean</span></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/e21b91858b3251e3e40094cb9b7153d87b63bc12/src/ui/party-ui-handler.ts#L85">src/ui/party-ui-handler.ts:85</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-private"><aid="optionsScrollCursor"class="tsd-anchor"></a><h3class="tsd-anchor-link"><codeclass="tsd-tag ts-flagPrivate">Private</code><span>options<wbr/>Scroll<wbr/>Cursor</span><ahref="#optionsScrollCursor"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">options<wbr/>Scroll<wbr/>Cursor</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">number</
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/e21b91858b3251e3e40094cb9b7153d87b63bc12/src/ui/party-ui-handler.ts#L103">src/ui/party-ui-handler.ts:103</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-private"><aid="transferCursor"class="tsd-anchor"></a><h3class="tsd-anchor-link"><codeclass="tsd-tag ts-flagPrivate">Private</code><span>transfer<wbr/>Cursor</span><ahref="#transferCursor"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">transfer<wbr/>Cursor</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">number</span></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/e21b91858b3251e3e40094cb9b7153d87b63bc12/src/ui/party-ui-handler.ts#L97">src/ui/party-ui-handler.ts:97</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-private"><aid="transferMode"class="tsd-anchor"></a><h3class="tsd-anchor-link"><codeclass="tsd-tag ts-flagPrivate">Private</code><span>transfer<wbr/>Mode</span><ahref="#transferMode"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">transfer<wbr/>Mode</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">boolean</span></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/e21b91858b3251e3e40094cb9b7153d87b63bc12/src/ui/party-ui-handler.ts#L95">src/ui/party-ui-handler.ts:95</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-private"><aid="transferOptionCursor"class="tsd-anchor"></a><h3class="tsd-anchor-link"><codeclass="tsd-tag ts-flagPrivate">Private</code><span>transfer<wbr/>Option<wbr/>Cursor</span><ahref="#transferOptionCursor"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">transfer<wbr/>Option<wbr/>Cursor</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">number</span></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/e21b91858b3251e3e40094cb9b7153d87b63bc12/src/ui/party-ui-handler.ts#L96">src/ui/party-ui-handler.ts:96</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-private"><aid="transferQuantities"class="tsd-anchor"></a><h3class="tsd-anchor-link"><codeclass="tsd-tag ts-flagPrivate">Private</code><span>transfer<wbr/>Quantities</span><ahref="#transferQuantities"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">transfer<wbr/>Quantities</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">number</span><spanclass="tsd-signature-symbol">[]</span></div><divclass="tsd-comment tsd-typography"><p>Current quantity selection for every item held by the pokemon selected for the transfer</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/e21b91858b3251e3e40094cb9b7153d87b63bc12/src/ui/party-ui-handler.ts#L99">src/ui/party-ui-handler.ts:99</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-private"><aid="transferQuantitiesMax"class="tsd-anchor"></a><h3class="tsd-anchor-link"><codeclass="tsd-tag ts-flagPrivate">Private</code><span>transfer<wbr/>Quantities<wbr/>Max</span><ahref="#transferQuantitiesMax"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">transfer<wbr/>Quantities<wbr/>Max</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">number</span><spanclass="tsd-signature-symbol">[]</span></div><divclass="tsd-comment tsd-typography"><p>Stack size of every item that the selected pokemon is holding</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/e21b91858b3251e3e40094cb9b7153d87b63bc12/src/ui/party-ui-handler.ts#L101">src/ui/party-ui-handler.ts:101</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited"><aid="tutorialActive"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>tutorial<wbr/>Active</span><ahref="#tutorialActive"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">tutorial<wbr/>Active</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">boolean</span><spanclass="tsd-signature-symbol"> = false</span></div><asideclass="tsd-sources"><p>Inherited from <ahref="ui_message_ui_handler.default.html">default</a>.<ahref="ui_message_ui_handler.default.html#tutorialActive">tutorialActive</a></p><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/e21b91858b3251e3e40094cb9b7153d87b63bc12/src/ui/awaitable-ui-handler.ts#L9">src/ui/awaitable-ui-handler.ts:9</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><aid="NoEffectMessage"class="tsd-anchor"></a><h3class="tsd-anchor-link"><codeclass="tsd-tag ts-flagStatic">Static</code><span>No<wbr/>Effect<wbr/>Message</span><ahref="#NoEffectMessage"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">No<wbr/>Effect<wbr/>Message</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">never</span><spanclass="tsd-signature-symbol"> = ...</span></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/e21b91858b3251e3e40094cb9b7153d87b63bc12/src/ui/party-ui-handler.ts#L154">src/ui/party-ui-handler.ts:154</a></li></ul></aside></section></section><sectionclass="tsd-panel-group tsd-member-group"><h2>Methods</h2><sectionclass="tsd-panel tsd-member tsd-is-private"><aid="FilterChallengeLegal"class="tsd-anchor"></a><h3class="tsd-anchor-link"><codeclass="tsd-tag ts-flagPrivate">Private</code><span>Filter<wbr/>Challenge<wbr/>Legal</span><ahref="#FilterChallengeLegal"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-private"><liclass="tsd-signature tsd-anchor-link"><aid="FilterChallengeLegal.FilterChallengeLegal-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">Filter<wbr/>Challenge<wbr/>Legal</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">pokemon</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">any</span><ahref="#FilterChallengeLegal.FilterChallengeLegal-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="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>
