<!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_starter_select_ui_handler.html">ui/starter-select-ui-handler</a></li><li><ahref="ui_starter_select_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>
and to display the correct shiny, variant, and form based on the StarterPreferences</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">speciesId</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>the id of the species to get props for</p>
<divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/86fe4dd888c1ad54e4939fb24a30f477fd0b1133/src/ui/starter-select-ui-handler.ts#L3430">src/ui/starter-select-ui-handler.ts:3430</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited"><aid="getCursor"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>get<wbr/>Cursor</span><ahref="#getCursor"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-inherited"><liclass="tsd-signature tsd-anchor-link"><aid="getCursor.getCursor-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">get<wbr/>Cursor</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">number</span><ahref="#getCursor.getCursor-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"><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">number</span></h4><asideclass="tsd-sources"><p>Inherited from <ahref="ui_message_ui_handler.default.html">default</a>.<ahref="ui_message_ui_handler.default.html#getCursor">getCursor</a></p><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/86fe4dd888c1ad54e4939fb24a30f477fd0b1133/src/ui/ui-handler.ts#L42">src/ui/ui-handler.ts:42</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited"><aid="getTextColor"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>get<wbr/>Text<wbr/>Color</span><ahref="#getTextColor"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-inherited"><liclass="tsd-signature tsd-anchor-link"><aid="getTextColor.getTextColor-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">get<wbr/>Text<wbr/>Color</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">style</span>, <spanclass="tsd-kind-parameter">shadow</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">string</span><ahref="#getTextColor.getTextColor-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-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">style</span>: <ahref="../enums/ui_text.TextStyle.html"class="tsd-signature-type tsd-kind-enum">TextStyle</a></span></li><li><span><spanclass="tsd-kind-parameter">shadow</span>: <spanclass="tsd-signature-type">boolean</span><spanclass="tsd-signature-symbol"> = false</span></span></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">string</span></h4><asideclass="tsd-sources"><p>Inherited from <ahref="ui_message_ui_handler.default.html">default</a>.<ahref="ui_message_ui_handler.default.html#getTextColor">getTextColor</a></p><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/86fe4dd888c1ad54e4939fb24a30f477fd0b1133/src/ui/ui-handler.ts#L38">src/ui/ui-handler.ts:38</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited"><aid="getUi"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>get<wbr/>Ui</span><ahref="#getUi"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-inherited"><liclass="tsd-signature tsd-anchor-link"><aid="getUi.getUi-1"class="tsd-anchor"></a><spanclass=
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><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">species</span>: <ahref="data_pokemon_species.default.html"class="tsd-signature-type tsd-kind-class">default</a></span><divclass="tsd-comment tsd-typography"><p>The species to get Starter Preferences for</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <ahref="../interfaces/system_game_data.StarterAttributes.html"class="tsd-signature-type tsd-kind-interface">StarterAttributes</a></h4><p>StarterAttributes for the species</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">speciesId</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>The ID of the species to check the passive of</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">boolean</span></h4><p>true if the user has enough candies and a passive has not been unlocked already</p>
<divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/86fe4dd888c1ad54e4939fb24a30f477fd0b1133/src/ui/starter-select-ui-handler.ts#L1085">src/ui/starter-select-ui-handler.ts:1085</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="isSameSpeciesEggAvailable"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>is<wbr/>Same<wbr/>Species<wbr/>Egg<wbr/>Available</span><ahref="#isSameSpeciesEggAvailable"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="isSameSpeciesEggAvailable.isSameSpeciesEggAvailable-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">is<wbr/>Same<wbr/>Species<wbr/>Egg<wbr/>Available</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">speciesId</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">boolean</span><ahref="#isSameSpeciesEggAvailable.isSameSpeciesEggAvailable-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>Determines if an same species egg can be bought for the given species ID</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">speciesId</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>The ID of the species to check the value reduction of</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">boolean</span></h4><p>true if the user has enough candies</p>
<divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/86fe4dd888c1ad54e4939fb24a30f477fd0b1133/src/ui/starter-select-ui-handler.ts#L1111">src/ui/starter-select-ui-handler.ts:1111</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="isUpgradeAnimationEnabled"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>is<wbr/>Upgrade<wbr/>Animation<wbr/>Enabled</span><ahref="#isUpgradeAnimationEnabled"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="isUpgradeAnimationEnabled.isUpgradeAnimationEnabled-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">is<wbr/>Upgrade<wbr/>Animation<wbr/>Enabled</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">boolean</span><ahref="#isUpgradeAnimationEnabled.isUpgradeAnimationEnabled-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>Determines if 'Animation' based upgrade notifications should be shown</p>
</div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">boolean</span></h4><p>true if upgrade notifications are enabled and set to display an 'Animation'</p>
<divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/86fe4dd888c1ad54e4939fb24a30f477fd0b1133/src/ui/starter-select-ui-handler.ts#L1076">src/ui/starter-select-ui-handler.ts:1076</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="isUpgradeIconEnabled"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>is<wbr/>Upgrade<wbr/>Icon<wbr/>Enabled</span><ahref="#isUpgradeIconEnabled"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="isUpgradeIconEnabled.isUpgradeIconEnabled-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">is<wbr/>Upgrade<wbr/>Icon<wbr/>Enabled</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">boolean</span><ahref="#isUpgradeIconEnabled.isUpgradeIconEnabled-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>Determines if 'Icon' based upgrade notifications should be shown</p>
</div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">boolean</span></h4><p>true if upgrade notifications are enabled and set to display an 'Icon'</p>
<divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/86fe4dd888c1ad54e4939fb24a30f477fd0b1133/src/ui/starter-select-ui-handler.ts#L1069">src/ui/starter-select-ui-handler.ts:1069</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="isValueReductionAvailable"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>is<wbr/>Value<wbr/>Reduction<wbr/>Available</span><ahref="#isValueReductionAvailable"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="isValueReductionAvailable.isValueReductionAvailable-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">is<wbr/>Value<wbr/>Reduction<wbr/>Available</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">speciesId</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">boolean</span><ahref="#isValueReductionAvailable.isValueReductionAvailable-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>Determines if a value reduction upgrade is available for the given species ID</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">speciesId</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>The ID of the species to check the value reduction of</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">boolean</span></h4><p>true if the user has enough candies and all value reductions have not been unlocked already</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">event</span>: <spanclass="tsd-signature-type">Event</span></span><divclass="tsd-comment tsd-typography"><p>Event sent by the callback</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">icon</span>: <spanclass="tsd-signature-type">Sprite</span></span><divclass="tsd-comment tsd-typography"><p>Phaser.GameObjects.GameObject to animate</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">species</span>: <ahref="data_pokemon_species.default.html"class="tsd-signature-type tsd-kind-class">default</a></span><divclass="tsd-comment tsd-typography"><p><ahref="data_pokemon_species.default.html"class="tsd-kind-class"><code>PokemonSpecies</code></a> of the icon used to check for upgrades</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">startPaused</span>: <spanclass="tsd-signature-type">boolean</span><spanclass="tsd-signature-symbol"> = false</span></span><divclass="tsd-comment tsd-typography"><p>Should this animation be paused after it is added?</p>
