mika/pokerogue
1
0
Fork 0
mirror of https://github.com/pagefaultgames/pokerogue.git synced 2025-08-07 07:59:26 +02:00
Code Issues Packages Projects Releases Wiki Activity
gh-pages
pokerogue/main/classes/data_pokemon-species.PokemonForm.html
github-actions[bot] 48f7010711 [skip ci] Deploy docs
2025-06-19 01:22:42 +00:00

81 lines
126 KiB
HTML
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>PokemonForm | 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><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">pokemon-rogue-battle</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/data_pokemon-species.html">data/pokemon-species</a></li><li><a href="" aria-current="page">PokemonForm</a></li></ul><h1>Class PokemonForm</h1></div><section class="tsd-panel tsd-hierarchy" data-refl="29063"><h4>Hierarchy (<a href="../hierarchy.html#data/pokemon-species.PokemonForm">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="data_pokemon-species.PokemonSpeciesForm.html" class="tsd-signature-type tsd-kind-class">PokemonSpeciesForm</a><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">PokemonForm</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/pokemon-species.ts#L1344">src/data/pokemon-species.ts:1344</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"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg><h5 class="tsd-index-heading uppercase">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="#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#_formindex" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_form<wbr/>Index</span></a>
<a href="#_generation" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_generation</span></a>
<a href="#ability1" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ability1</span></a>
<a href="#ability2" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ability2</span></a>
<a href="#abilityhidden" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ability<wbr/>Hidden</span></a>
<a href="#baseexp" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>base<wbr/>Exp</span></a>
<a href="#basefriendship" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>base<wbr/>Friendship</span></a>
<a href="#basestats" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>base<wbr/>Stats</span></a>
<a href="#basetotal" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>base<wbr/>Total</span></a>
<a href="#catchrate" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>catch<wbr/>Rate</span></a>
<a href="#formkey" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>form<wbr/>Key</span></a>
<a href="#formname" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>form<wbr/>Name</span></a>
<a href="#formspritekey" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>form<wbr/>Sprite<wbr/>Key</span></a>
<a href="#genderdiffs" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>gender<wbr/>Diffs</span></a>
<a href="#height" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>height</span></a>
<a href="#isstarterselectable" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Starter<wbr/>Selectable</span></a>
<a href="#isunobtainable" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Unobtainable</span></a>
<a href="#speciesid" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>species<wbr/>Id</span></a>
<a href="#type1" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type1</span></a>
<a href="#type2" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type2</span></a>
<a href="#weight" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>weight</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Accessors</h3><div class="tsd-index-list"><a href="#formindex" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>form<wbr/>Index</span></a>
<a href="#generation" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>generation</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="#cry" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>cry</span></a>
<a href="#generatecandycolors" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>generate<wbr/>Candy<wbr/>Colors</span></a>
<a href="#getability" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Ability</span></a>
<a href="#getabilitycount" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Ability<wbr/>Count</span></a>
<a href="#getbaseexp" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Base<wbr/>Exp</span></a>
<a href="#getbasespritekey" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Base<wbr/>Sprite<wbr/>Key</span></a>
<a href="#getbasestat" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Base<wbr/>Stat</span></a>
<a href="#getbasestattotal" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Base<wbr/>Stat<wbr/>Total</span></a>
<a href="#getcrykey" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Cry<wbr/>Key</span></a>
<a href="#getformspritekey" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Form<wbr/>Sprite<wbr/>Key</span></a>
<a href="#geticonatlaskey" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Icon<wbr/>Atlas<wbr/>Key</span></a>
<a href="#geticonid" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Icon<wbr/>Id</span></a>
<a href="#getlevelmoves" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Level<wbr/>Moves</span></a>
<a href="#getpassiveability" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Passive<wbr/>Ability</span></a>
<a href="#getregion" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Region</span></a>
<a href="#getrootspeciesid" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Root<wbr/>Species<wbr/>Id</span></a>
<a href="#getspriteatlaspath" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Sprite<wbr/>Atlas<wbr/>Path</span></a>
<a href="#getspriteid" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Sprite<wbr/>Id</span></a>
<a href="#getspritekey" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Sprite<wbr/>Key</span></a>
<a href="#getvariantdataindex" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Variant<wbr/>Data<wbr/>Index</span></a>
<a href="#iscatchable" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Catchable</span></a>
<a href="#isobtainable" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Obtainable</span></a>
<a href="#isoftype" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Of<wbr/>Type</span></a>
<a href="#israreregional" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Rare<wbr/>Regional</span></a>
<a href="#isregional" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Regional</span></a>
<a href="#istrainerforbidden" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Trainer<wbr/>Forbidden</span></a>
<a href="#loadassets" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>load<wbr/>Assets</span></a>
<a href="#loadvariantcolors" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>load<wbr/>Variant<wbr/>Colors</span></a>
<a href="#validatestartermoveset" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>validate<wbr/>Starter<wbr/>Moveset</span></a>
</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"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Constructors</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="constructor"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="constructorpokemonform"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">PokemonForm</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">formName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">formKey</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">type1</span><span class="tsd-signature-symbol">:</span> <a href="../enums/enums_pokemon-type.PokemonType.html" class="tsd-signature-type tsd-kind-enum">PokemonType</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">type2</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a href="../enums/enums_pokemon-type.PokemonType.html" class="tsd-signature-type tsd-kind-enum">PokemonType</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">height</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">weight</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">ability1</span><span class="tsd-signature-symbol">:</span> <a href="../enums/enums_abilities.Abilities.html" class="tsd-signature-type tsd-kind-enum">Abilities</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">ability2</span><span class="tsd-signature-symbol">:</span> <a href="../enums/enums_abilities.Abilities.html" class="tsd-signature-type tsd-kind-enum">Abilities</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">abilityHidden</span><span class="tsd-signature-symbol">:</span> <a href="../enums/enums_abilities.Abilities.html" class="tsd-signature-type tsd-kind-enum">Abilities</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">baseTotal</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">baseHp</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">baseAtk</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">baseDef</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">baseSpatk</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">baseSpdef</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">baseSpd</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">catchRate</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">baseFriendship</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">baseExp</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">genderDiffs</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">formSpriteKey</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">isStarterSelectable</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">isUnobtainable</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">PokemonForm</a><a href="#constructorpokemonform" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div 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">formName</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">formKey</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">type1</span>: <a href="../enums/enums_pokemon-type.PokemonType.html" class="tsd-signature-type tsd-kind-enum">PokemonType</a></span></li><li><span><span class="tsd-kind-parameter">type2</span>: <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a href="../enums/enums_pokemon-type.PokemonType.html" class="tsd-signature-type tsd-kind-enum">PokemonType</a></span></li><li><span><span class="tsd-kind-parameter">height</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">weight</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">ability1</span>: <a href="../enums/enums_abilities.Abilities.html" class="tsd-signature-type tsd-kind-enum">Abilities</a></span></li><li><span><span class="tsd-kind-parameter">ability2</span>: <a href="../enums/enums_abilities.Abilities.html" class="tsd-signature-type tsd-kind-enum">Abilities</a></span></li><li><span><span class="tsd-kind-parameter">abilityHidden</span>: <a href="../enums/enums_abilities.Abilities.html" class="tsd-signature-type tsd-kind-enum">Abilities</a></span></li><li><span><span class="tsd-kind-parameter">baseTotal</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">baseHp</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">baseAtk</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">baseDef</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">baseSpatk</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">baseSpdef</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">baseSpd</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">catchRate</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">baseFriendship</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">baseExp</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">genderDiffs</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span></li><li><span><span class="tsd-kind-parameter">formSpriteKey</span>: <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = null</span></span></li><li><span><span class="tsd-kind-parameter">isStarterSelectable</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span></li><li><span><span class="tsd-kind-parameter">isUnobtainable</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 <a href="" class="tsd-signature-type tsd-kind-class">PokemonForm</a></h4><aside class="tsd-sources"><p>Overrides <a href="data_pokemon-species.PokemonSpeciesForm.html">PokemonSpeciesForm</a>.<a href="data_pokemon-species.PokemonSpeciesForm.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/pokemon-species.ts#L1365">src/data/pokemon-species.ts:1365</a></li></ul></aside></div></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"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><h3 class="tsd-anchor-link" id="_formindex"><code class="tsd-tag">Protected</code><span>_form<wbr/>Index</span><a href="#_formindex" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">_formIndex</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="data_pokemon-species.PokemonSpeciesForm.html">PokemonSpeciesForm</a>.<a href="data_pokemon-species.PokemonSpeciesForm.html#_formindex">_formIndex</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/pokemon-species.ts#L175">src/data/pokemon-species.ts:175</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><h3 class="tsd-anchor-link" id="_generation"><code class="tsd-tag">Protected</code><span>_generation</span><a href="#_generation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">_generation</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="data_pokemon-species.PokemonSpeciesForm.html">PokemonSpeciesForm</a>.<a href="data_pokemon-species.PokemonSpeciesForm.html#_generation">_generation</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/pokemon-species.ts#L176">src/data/pokemon-species.ts:176</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="ability1"><code class="tsd-tag">Readonly</code><span>ability1</span><a href="#ability1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ability1</span><span class="tsd-signature-symbol">:</span> <a href="../enums/enums_abilities.Abilities.html" class="tsd-signature-type tsd-kind-enum">Abilities</a></div><aside class="tsd-sources"><p>Inherited from <a href="data_pokemon-species.PokemonSpeciesForm.html">PokemonSpeciesForm</a>.<a href="data_pokemon-species.PokemonSpeciesForm.html#ability1">ability1</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/pokemon-species.ts#L181">src/data/pokemon-species.ts:181</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="ability2"><code class="tsd-tag">Readonly</code><span>ability2</span><a href="#ability2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ability2</span><span class="tsd-signature-symbol">:</span> <a href="../enums/enums_abilities.Abilities.html" class="tsd-signature-type tsd-kind-enum">Abilities</a></div><aside class="tsd-sources"><p>Inherited from <a href="data_pokemon-species.PokemonSpeciesForm.html">PokemonSpeciesForm</a>.<a href="data_pokemon-species.PokemonSpeciesForm.html#ability2">ability2</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/pokemon-species.ts#L182">src/data/pokemon-species.ts:182</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="abilityhidden"><code class="tsd-tag">Readonly</code><span>ability<wbr/>Hidden</span><a href="#abilityhidden" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">abilityHidden</span><span class="tsd-signature-symbol">:</span> <a href="../enums/enums_abilities.Abilities.html" class="tsd-signature-type tsd-kind-enum">Abilities</a></div><aside class="tsd-sources"><p>Inherited from <a href="data_pokemon-species.PokemonSpeciesForm.html">PokemonSpeciesForm</a>.<a href="data_pokemon-species.PokemonSpeciesForm.html#abilityhidden">abilityHidden</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/pokemon-species.ts#L183">src/data/pokemon-species.ts:183</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="baseexp"><code class="tsd-tag">Readonly</code><span>base<wbr/>Exp</span><a href="#baseexp" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">baseExp</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="data_pokemon-species.PokemonSpeciesForm.html">PokemonSpeciesForm</a>.<a href="data_pokemon-species.PokemonSpeciesForm.html#baseexp">baseExp</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/pokemon-species.ts#L188">src/data/pokemon-species.ts:188</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="basefriendship"><code class="tsd-tag">Readonly</code><span>base<wbr/>Friendship</span><a href="#basefriendship" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">baseFriendship</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="data_pokemon-species.PokemonSpeciesForm.html">PokemonSpeciesForm</a>.<a href="data_pokemon-species.PokemonSpeciesForm.html#basefriendship">baseFriendship</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/pokemon-species.ts#L187">src/data/pokemon-species.ts:187</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="basestats"><code class="tsd-tag">Readonly</code><span>base<wbr/>Stats</span><a href="#basestats" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">baseStats</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><p>Inherited from <a href="data_pokemon-species.PokemonSpeciesForm.html">PokemonSpeciesForm</a>.<a href="data_pokemon-species.PokemonSpeciesForm.html#basestats">baseStats</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/pokemon-species.ts#L185">src/data/pokemon-species.ts:185</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="basetotal"><code class="tsd-tag">Readonly</code><span>base<wbr/>Total</span><a href="#basetotal" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">baseTotal</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="data_pokemon-species.PokemonSpeciesForm.html">PokemonSpeciesForm</a>.<a href="data_pokemon-species.PokemonSpeciesForm.html#basetotal">baseTotal</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/pokemon-species.ts#L184">src/data/pokemon-species.ts:184</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="catchrate"><code class="tsd-tag">Readonly</code><span>catch<wbr/>Rate</span><a href="#catchrate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">catchRate</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="data_pokemon-species.PokemonSpeciesForm.html">PokemonSpeciesForm</a>.<a href="data_pokemon-species.PokemonSpeciesForm.html#catchrate">catchRate</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/pokemon-species.ts#L186">src/data/pokemon-species.ts:186</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="formkey"><span>form<wbr/>Key</span><a href="#formkey" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">formKey</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/pokemon-species.ts#L1346">src/data/pokemon-species.ts:1346</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="formname"><span>form<wbr/>Name</span><a href="#formname" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">formName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/pokemon-species.ts#L1345">src/data/pokemon-species.ts:1345</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="formspritekey"><span>form<wbr/>Sprite<wbr/>Key</span><a href="#formspritekey" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">formSpriteKey</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/pokemon-species.ts#L1347">src/data/pokemon-species.ts:1347</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="genderdiffs"><code class="tsd-tag">Readonly</code><span>gender<wbr/>Diffs</span><a href="#genderdiffs" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">genderDiffs</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="data_pokemon-species.PokemonSpeciesForm.html">PokemonSpeciesForm</a>.<a href="data_pokemon-species.PokemonSpeciesForm.html#genderdiffs">genderDiffs</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/pokemon-species.ts#L189">src/data/pokemon-species.ts:189</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="height"><code class="tsd-tag">Readonly</code><span>height</span><a href="#height" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">height</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="data_pokemon-species.PokemonSpeciesForm.html">PokemonSpeciesForm</a>.<a href="data_pokemon-species.PokemonSpeciesForm.html#height">height</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/pokemon-species.ts#L179">src/data/pokemon-species.ts:179</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="isstarterselectable"><code class="tsd-tag">Readonly</code><span>is<wbr/>Starter<wbr/>Selectable</span><a href="#isstarterselectable" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">isStarterSelectable</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="data_pokemon-species.PokemonSpeciesForm.html">PokemonSpeciesForm</a>.<a href="data_pokemon-species.PokemonSpeciesForm.html#isstarterselectable">isStarterSelectable</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/pokemon-species.ts#L190">src/data/pokemon-species.ts:190</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="isunobtainable"><span>is<wbr/>Unobtainable</span><a href="#isunobtainable" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">isUnobtainable</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/pokemon-species.ts#L1348">src/data/pokemon-species.ts:1348</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="speciesid"><span>species<wbr/>Id</span><a href="#speciesid" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">speciesId</span><span class="tsd-signature-symbol">:</span> <a href="../enums/enums_species.Species.html" class="tsd-signature-type tsd-kind-enum">Species</a></div><aside class="tsd-sources"><p>Inherited from <a href="data_pokemon-species.PokemonSpeciesForm.html">PokemonSpeciesForm</a>.<a href="data_pokemon-species.PokemonSpeciesForm.html#speciesid">speciesId</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/pokemon-species.ts#L174">src/data/pokemon-species.ts:174</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="type1"><code class="tsd-tag">Readonly</code><span>type1</span><a href="#type1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">type1</span><span class="tsd-signature-symbol">:</span> <a href="../enums/enums_pokemon-type.PokemonType.html" class="tsd-signature-type tsd-kind-enum">PokemonType</a></div><aside class="tsd-sources"><p>Inherited from <a href="data_pokemon-species.PokemonSpeciesForm.html">PokemonSpeciesForm</a>.<a href="data_pokemon-species.PokemonSpeciesForm.html#type1">type1</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/pokemon-species.ts#L177">src/data/pokemon-species.ts:177</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="type2"><code class="tsd-tag">Readonly</code><span>type2</span><a href="#type2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">type2</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a href="../enums/enums_pokemon-type.PokemonType.html" class="tsd-signature-type tsd-kind-enum">PokemonType</a></div><aside class="tsd-sources"><p>Inherited from <a href="data_pokemon-species.PokemonSpeciesForm.html">PokemonSpeciesForm</a>.<a href="data_pokemon-species.PokemonSpeciesForm.html#type2">type2</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/pokemon-species.ts#L178">src/data/pokemon-species.ts:178</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="weight"><code class="tsd-tag">Readonly</code><span>weight</span><a href="#weight" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">weight</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="data_pokemon-species.PokemonSpeciesForm.html">PokemonSpeciesForm</a>.<a href="data_pokemon-species.PokemonSpeciesForm.html#weight">weight</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/pokemon-species.ts#L180">src/data/pokemon-species.ts:180</a></li></ul></aside></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Accessors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Accessors</h2></summary><section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="formindex"><span>form<wbr/>Index</span><a href="#formindex" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li><div class="tsd-signature" id="formindexformindex"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">formIndex</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources"><p>Inherited from PokemonSpeciesForm.formIndex</p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/pokemon-species.ts#L252">src/data/pokemon-species.ts:252</a></li></ul></aside></div></li><li><div class="tsd-signature" id="formindexformindex-1"><span class="tsd-signature-keyword">set</span> <span class="tsd-kind-set-signature">formIndex</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">formIndex</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span></div><div 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">formIndex</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"><p>Inherited from PokemonSpeciesForm.formIndex</p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/pokemon-species.ts#L256">src/data/pokemon-species.ts:256</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="generation"><span>generation</span><a href="#generation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li><div class="tsd-signature" id="generationgeneration"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">generation</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources"><p>Inherited from PokemonSpeciesForm.generation</p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/pokemon-species.ts#L244">src/data/pokemon-species.ts:244</a></li></ul></aside></div></li><li><div class="tsd-signature" id="generationgeneration-1"><span class="tsd-signature-keyword">set</span> <span class="tsd-kind-set-signature">generation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">generation</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span></div><div 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">generation</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"><p>Inherited from PokemonSpeciesForm.generation</p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/pokemon-species.ts#L248">src/data/pokemon-species.ts:248</a></li></ul></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Methods</h2></summary><section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="cry"><span>cry</span><a href="#cry" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="cry-1"><span class="tsd-kind-call-signature">cry</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">soundConfig</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">SoundConfig</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">ignorePlay</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="../types/battle-scene.AnySound.html" class="tsd-signature-type tsd-kind-type-alias">AnySound</a><a href="#cry-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">soundConfig</span>: <span class="tsd-signature-type">SoundConfig</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">ignorePlay</span>: <span class="tsd-signature-type">boolean</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../types/battle-scene.AnySound.html" class="tsd-signature-type tsd-kind-type-alias">AnySound</a></h4><aside class="tsd-sources"><p>Inherited from <a href="data_pokemon-species.PokemonSpeciesForm.html">PokemonSpeciesForm</a>.<a href="data_pokemon-species.PokemonSpeciesForm.html#cry">cry</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/pokemon-species.ts#L691">src/data/pokemon-species.ts:691</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="generatecandycolors"><span>generate<wbr/>Candy<wbr/>Colors</span><a href="#generatecandycolors" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="generatecandycolors-1"><span class="tsd-kind-call-signature">generateCandyColors</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">[]</span><a href="#generatecandycolors-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources"><p>Inherited from <a href="data_pokemon-species.PokemonSpeciesForm.html">PokemonSpeciesForm</a>.<a href="data_pokemon-species.PokemonSpeciesForm.html#generatecandycolors">generateCandyColors</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/pokemon-species.ts#L704">src/data/pokemon-species.ts:704</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getability"><span>get<wbr/>Ability</span><a href="#getability" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="getability-1"><span class="tsd-kind-call-signature">getAbility</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">abilityIndex</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="../enums/enums_abilities.Abilities.html" class="tsd-signature-type tsd-kind-enum">Abilities</a><a href="#getability-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Method to get the ability of a Pokemon species.</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">abilityIndex</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>Which ability to get (should only be 0-2)</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../enums/enums_abilities.Abilities.html" class="tsd-signature-type tsd-kind-enum">Abilities</a></h4><p>The id of the Ability</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="data_pokemon-species.PokemonSpeciesForm.html">PokemonSpeciesForm</a>.<a href="data_pokemon-species.PokemonSpeciesForm.html#getability">getAbility</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/pokemon-species.ts#L277">src/data/pokemon-species.ts:277</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getabilitycount"><span>get<wbr/>Ability<wbr/>Count</span><a href="#getabilitycount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="getabilitycount-1"><span class="tsd-kind-call-signature">getAbilityCount</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><a href="#getabilitycount-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Method to get the total number of abilities a Pokemon species has.</p>
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>Number of abilities</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="data_pokemon-species.PokemonSpeciesForm.html">PokemonSpeciesForm</a>.<a href="data_pokemon-species.PokemonSpeciesForm.html#getabilitycount">getAbilityCount</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/pokemon-species.ts#L268">src/data/pokemon-species.ts:268</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getbaseexp"><span>get<wbr/>Base<wbr/>Exp</span><a href="#getbaseexp" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="getbaseexp-1"><span class="tsd-kind-call-signature">getBaseExp</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><a href="#getbaseexp-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div 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="data_pokemon-species.PokemonSpeciesForm.html">PokemonSpeciesForm</a>.<a href="data_pokemon-species.PokemonSpeciesForm.html#getbaseexp">getBaseExp</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/pokemon-species.ts#L373">src/data/pokemon-species.ts:373</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getbasespritekey"><span>get<wbr/>Base<wbr/>Sprite<wbr/>Key</span><a href="#getbasespritekey" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="getbasespritekey-1"><span class="tsd-kind-call-signature">getBaseSpriteKey</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">female</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">formIndex</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#getbasespritekey-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div 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">female</span>: <span class="tsd-signature-type">boolean</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">formIndex</span>: <span class="tsd-signature-type">number</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="data_pokemon-species.PokemonSpeciesForm.html">PokemonSpeciesForm</a>.<a href="data_pokemon-species.PokemonSpeciesForm.html#getbasespritekey">getBaseSpriteKey</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/pokemon-species.ts#L393">src/data/pokemon-species.ts:393</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getbasestat"><span>get<wbr/>Base<wbr/>Stat</span><a href="#getbasestat" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="getbasestat-1"><span class="tsd-kind-call-signature">getBaseStat</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">stat</span><span class="tsd-signature-symbol">:</span> <a href="../enums/enums_stat.Stat.html" class="tsd-signature-type tsd-kind-enum">Stat</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><a href="#getbasestat-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets the species' base stat amount for the given stat.</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">stat</span>: <a href="../enums/enums_stat.Stat.html" class="tsd-signature-type tsd-kind-enum">Stat</a></span><div class="tsd-comment tsd-typography"><p>The desired stat.</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>The species' base stat amount.</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="data_pokemon-species.PokemonSpeciesForm.html">PokemonSpeciesForm</a>.<a href="data_pokemon-species.PokemonSpeciesForm.html#getbasestat">getBaseStat</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/pokemon-species.ts#L369">src/data/pokemon-species.ts:369</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getbasestattotal"><span>get<wbr/>Base<wbr/>Stat<wbr/>Total</span><a href="#getbasestattotal" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="getbasestattotal-1"><span class="tsd-kind-call-signature">getBaseStatTotal</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><a href="#getbasestattotal-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets the BST for the species</p>
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>The species' BST.</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="data_pokemon-species.PokemonSpeciesForm.html">PokemonSpeciesForm</a>.<a href="data_pokemon-species.PokemonSpeciesForm.html#getbasestattotal">getBaseStatTotal</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/pokemon-species.ts#L360">src/data/pokemon-species.ts:360</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getcrykey"><span>get<wbr/>Cry<wbr/>Key</span><a href="#getcrykey" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="getcrykey-1"><span class="tsd-kind-call-signature">getCryKey</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">formIndex</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#getcrykey-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">formIndex</span>: <span class="tsd-signature-type">number</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="data_pokemon-species.PokemonSpeciesForm.html">PokemonSpeciesForm</a>.<a href="data_pokemon-species.PokemonSpeciesForm.html#getcrykey">getCryKey</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/pokemon-species.ts#L506">src/data/pokemon-species.ts:506</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getformspritekey"><span>get<wbr/>Form<wbr/>Sprite<wbr/>Key</span><a href="#getformspritekey" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getformspritekey-1"><span class="tsd-kind-call-signature">getFormSpriteKey</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">_formIndex</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#getformspritekey-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">_formIndex</span>: <span class="tsd-signature-type">number</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources"><p>Overrides <a href="data_pokemon-species.PokemonSpeciesForm.html">PokemonSpeciesForm</a>.<a href="data_pokemon-species.PokemonSpeciesForm.html#getformspritekey">getFormSpriteKey</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/pokemon-species.ts#L1417">src/data/pokemon-species.ts:1417</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="geticonatlaskey"><span>get<wbr/>Icon<wbr/>Atlas<wbr/>Key</span><a href="#geticonatlaskey" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="geticonatlaskey-1"><span class="tsd-kind-call-signature">getIconAtlasKey</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">formIndex</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">shiny</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">variant</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#geticonatlaskey-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">formIndex</span>: <span class="tsd-signature-type">number</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">shiny</span>: <span class="tsd-signature-type">boolean</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">variant</span>: <span class="tsd-signature-type">number</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="data_pokemon-species.PokemonSpeciesForm.html">PokemonSpeciesForm</a>.<a href="data_pokemon-species.PokemonSpeciesForm.html#geticonatlaskey">getIconAtlasKey</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/pokemon-species.ts#L442">src/data/pokemon-species.ts:442</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="geticonid"><span>get<wbr/>Icon<wbr/>Id</span><a href="#geticonid" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="geticonid-1"><span class="tsd-kind-call-signature">getIconId</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">female</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">formIndex</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">shiny</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">variant</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#geticonid-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div 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">female</span>: <span class="tsd-signature-type">boolean</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">formIndex</span>: <span class="tsd-signature-type">number</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">shiny</span>: <span class="tsd-signature-type">boolean</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">variant</span>: <span class="tsd-signature-type">number</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="data_pokemon-species.PokemonSpeciesForm.html">PokemonSpeciesForm</a>.<a href="data_pokemon-species.PokemonSpeciesForm.html#geticonid">getIconId</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/pokemon-species.ts#L449">src/data/pokemon-species.ts:449</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getlevelmoves"><span>get<wbr/>Level<wbr/>Moves</span><a href="#getlevelmoves" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="getlevelmoves-1"><span class="tsd-kind-call-signature">getLevelMoves</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="../types/data_balance_pokemon-level-moves.LevelMoves.html" class="tsd-signature-type tsd-kind-type-alias">LevelMoves</a><a href="#getlevelmoves-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="../types/data_balance_pokemon-level-moves.LevelMoves.html" class="tsd-signature-type tsd-kind-type-alias">LevelMoves</a></h4><aside class="tsd-sources"><p>Inherited from <a href="data_pokemon-species.PokemonSpeciesForm.html">PokemonSpeciesForm</a>.<a href="data_pokemon-species.PokemonSpeciesForm.html#getlevelmoves">getLevelMoves</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/pokemon-species.ts#L317">src/data/pokemon-species.ts:317</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getpassiveability"><span>get<wbr/>Passive<wbr/>Ability</span><a href="#getpassiveability" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="getpassiveability-1"><span class="tsd-kind-call-signature">getPassiveAbility</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">formIndex</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="../enums/enums_abilities.Abilities.html" class="tsd-signature-type tsd-kind-enum">Abilities</a><a href="#getpassiveability-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Method to get the passive ability of a Pokemon species</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">formIndex</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The form index to use, defaults to form for this species instance</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../enums/enums_abilities.Abilities.html" class="tsd-signature-type tsd-kind-enum">Abilities</a></h4><p>The id of the ability</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="data_pokemon-species.PokemonSpeciesForm.html">PokemonSpeciesForm</a>.<a href="data_pokemon-species.PokemonSpeciesForm.html#getpassiveability">getPassiveAbility</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/pokemon-species.ts#L294">src/data/pokemon-species.ts:294</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getregion"><span>get<wbr/>Region</span><a href="#getregion" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="getregion-1"><span class="tsd-kind-call-signature">getRegion</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="../enums/data_pokemon-species.Region.html" class="tsd-signature-type tsd-kind-enum">Region</a><a href="#getregion-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="../enums/data_pokemon-species.Region.html" class="tsd-signature-type tsd-kind-enum">Region</a></h4><aside class="tsd-sources"><p>Inherited from <a href="data_pokemon-species.PokemonSpeciesForm.html">PokemonSpeciesForm</a>.<a href="data_pokemon-species.PokemonSpeciesForm.html#getregion">getRegion</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/pokemon-species.ts#L327">src/data/pokemon-species.ts:327</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getrootspeciesid"><span>get<wbr/>Root<wbr/>Species<wbr/>Id</span><a href="#getrootspeciesid" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="getrootspeciesid-1"><span class="tsd-kind-call-signature">getRootSpeciesId</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">forStarter</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="../enums/enums_species.Species.html" class="tsd-signature-type tsd-kind-enum">Species</a><a href="#getrootspeciesid-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Method to get the root species id of a Pokemon.
Magmortar.getRootSpeciesId(true) =&gt; Magmar
Magmortar.getRootSpeciesId(false) =&gt; Magby</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">forStarter</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span><div class="tsd-comment tsd-typography"><p>boolean to get the nonbaby form of a starter</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../enums/enums_species.Species.html" class="tsd-signature-type tsd-kind-enum">Species</a></h4><p>The species</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="data_pokemon-species.PokemonSpeciesForm.html">PokemonSpeciesForm</a>.<a href="data_pokemon-species.PokemonSpeciesForm.html#getrootspeciesid">getRootSpeciesId</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/pokemon-species.ts#L236">src/data/pokemon-species.ts:236</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getspriteatlaspath"><span>get<wbr/>Sprite<wbr/>Atlas<wbr/>Path</span><a href="#getspriteatlaspath" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="getspriteatlaspath-1"><span class="tsd-kind-call-signature">getSpriteAtlasPath</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">female</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">formIndex</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">shiny</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">variant</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">back</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#getspriteatlaspath-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div 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">female</span>: <span class="tsd-signature-type">boolean</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">formIndex</span>: <span class="tsd-signature-type">number</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">shiny</span>: <span class="tsd-signature-type">boolean</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">variant</span>: <span class="tsd-signature-type">number</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">back</span>: <span class="tsd-signature-type">boolean</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="data_pokemon-species.PokemonSpeciesForm.html">PokemonSpeciesForm</a>.<a href="data_pokemon-species.PokemonSpeciesForm.html#getspriteatlaspath">getSpriteAtlasPath</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/pokemon-species.ts#L388">src/data/pokemon-species.ts:388</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getspriteid"><span>get<wbr/>Sprite<wbr/>Id</span><a href="#getspriteid" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="getspriteid-1"><span class="tsd-kind-call-signature">getSpriteId</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">female</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">formIndex</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">shiny</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">variant</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">back</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#getspriteid-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Compute the sprite ID of the pokemon form.</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">female</span>: <span class="tsd-signature-type">boolean</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">formIndex</span>: <span class="tsd-signature-type">number</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">shiny</span>: <span class="tsd-signature-type">boolean</span></span></li><li><span><span class="tsd-kind-parameter">variant</span>: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></span></li><li><span><span class="tsd-kind-parameter">back</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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="data_pokemon-species.PokemonSpeciesForm.html">PokemonSpeciesForm</a>.<a href="data_pokemon-species.PokemonSpeciesForm.html#getspriteid">getSpriteId</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/pokemon-species.ts#L408">src/data/pokemon-species.ts:408</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getspritekey"><span>get<wbr/>Sprite<wbr/>Key</span><a href="#getspritekey" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="getspritekey-1"><span class="tsd-kind-call-signature">getSpriteKey</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">female</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">formIndex</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">shiny</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">variant</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">back</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#getspritekey-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div 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">female</span>: <span class="tsd-signature-type">boolean</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">formIndex</span>: <span class="tsd-signature-type">number</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">shiny</span>: <span class="tsd-signature-type">boolean</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">variant</span>: <span class="tsd-signature-type">number</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">back</span>: <span class="tsd-signature-type">boolean</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="data_pokemon-species.PokemonSpeciesForm.html">PokemonSpeciesForm</a>.<a href="data_pokemon-species.PokemonSpeciesForm.html#getspritekey">getSpriteKey</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/pokemon-species.ts#L418">src/data/pokemon-species.ts:418</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getvariantdataindex"><span>get<wbr/>Variant<wbr/>Data<wbr/>Index</span><a href="#getvariantdataindex" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="getvariantdataindex-1"><span class="tsd-kind-call-signature">getVariantDataIndex</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">formIndex</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span><a href="#getvariantdataindex-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Variant Data key/index is either species id or species id followed by -formkey</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">formIndex</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>optional form index for pokemon with different forms</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span></h4><p>species id if no additional forms, index with formkey if a pokemon with a form</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="data_pokemon-species.PokemonSpeciesForm.html">PokemonSpeciesForm</a>.<a href="data_pokemon-species.PokemonSpeciesForm.html#getvariantdataindex">getVariantDataIndex</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/pokemon-species.ts#L429">src/data/pokemon-species.ts:429</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="iscatchable"><span>is<wbr/>Catchable</span><a href="#iscatchable" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="iscatchable-1"><span class="tsd-kind-call-signature">isCatchable</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#iscatchable-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources"><p>Inherited from <a href="data_pokemon-species.PokemonSpeciesForm.html">PokemonSpeciesForm</a>.<a href="data_pokemon-species.PokemonSpeciesForm.html#iscatchable">isCatchable</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/pokemon-species.ts#L335">src/data/pokemon-species.ts:335</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="isobtainable"><span>is<wbr/>Obtainable</span><a href="#isobtainable" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="isobtainable-1"><span class="tsd-kind-call-signature">isObtainable</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#isobtainable-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources"><p>Inherited from <a href="data_pokemon-species.PokemonSpeciesForm.html">PokemonSpeciesForm</a>.<a href="data_pokemon-species.PokemonSpeciesForm.html#isobtainable">isObtainable</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/pokemon-species.ts#L331">src/data/pokemon-species.ts:331</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="isoftype"><span>is<wbr/>Of<wbr/>Type</span><a href="#isoftype" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="isoftype-1"><span class="tsd-kind-call-signature">isOfType</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">type</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#isoftype-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div 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">type</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>Inherited from <a href="data_pokemon-species.PokemonSpeciesForm.html">PokemonSpeciesForm</a>.<a href="data_pokemon-species.PokemonSpeciesForm.html#isoftype">isOfType</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/pokemon-species.ts#L260">src/data/pokemon-species.ts:260</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="israreregional"><span>is<wbr/>Rare<wbr/>Regional</span><a href="#israreregional" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="israreregional-1"><span class="tsd-kind-call-signature">isRareRegional</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#israreregional-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources"><p>Inherited from <a href="data_pokemon-species.PokemonSpeciesForm.html">PokemonSpeciesForm</a>.<a href="data_pokemon-species.PokemonSpeciesForm.html#israreregional">isRareRegional</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/pokemon-species.ts#L347">src/data/pokemon-species.ts:347</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="isregional"><span>is<wbr/>Regional</span><a href="#isregional" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="isregional-1"><span class="tsd-kind-call-signature">isRegional</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#isregional-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources"><p>Inherited from <a href="data_pokemon-species.PokemonSpeciesForm.html">PokemonSpeciesForm</a>.<a href="data_pokemon-species.PokemonSpeciesForm.html#isregional">isRegional</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/pokemon-species.ts#L339">src/data/pokemon-species.ts:339</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="istrainerforbidden"><span>is<wbr/>Trainer<wbr/>Forbidden</span><a href="#istrainerforbidden" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="istrainerforbidden-1"><span class="tsd-kind-call-signature">isTrainerForbidden</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#istrainerforbidden-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources"><p>Inherited from <a href="data_pokemon-species.PokemonSpeciesForm.html">PokemonSpeciesForm</a>.<a href="data_pokemon-species.PokemonSpeciesForm.html#istrainerforbidden">isTrainerForbidden</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/pokemon-species.ts#L343">src/data/pokemon-species.ts:343</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="loadassets"><span>load<wbr/>Assets</span><a href="#loadassets" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="loadassets-1"><span class="tsd-kind-call-signature">loadAssets</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">female</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">formIndex</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">shiny</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">variant</span><span class="tsd-signature-symbol">?:</span> <a href="../types/sprites_variant.Variant.html" class="tsd-signature-type tsd-kind-type-alias">Variant</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">startLoad</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">back</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#loadassets-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div 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">female</span>: <span class="tsd-signature-type">boolean</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">formIndex</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">shiny</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">variant</span>: <a href="../types/sprites_variant.Variant.html" class="tsd-signature-type tsd-kind-type-alias">Variant</a></span></li><li><span><span class="tsd-kind-parameter">startLoad</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span></li><li><span><span class="tsd-kind-parameter">back</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">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><p>Inherited from <a href="data_pokemon-species.PokemonSpeciesForm.html">PokemonSpeciesForm</a>.<a href="data_pokemon-species.PokemonSpeciesForm.html#loadassets">loadAssets</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/pokemon-species.ts#L637">src/data/pokemon-species.ts:637</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="loadvariantcolors"><span>load<wbr/>Variant<wbr/>Colors</span><a href="#loadvariantcolors" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="loadvariantcolors-1"><span class="tsd-kind-call-signature">loadVariantColors</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">spriteKey</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">female</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">variant</span><span class="tsd-signature-symbol">:</span> <a href="../types/sprites_variant.Variant.html" class="tsd-signature-type tsd-kind-type-alias">Variant</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">back</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">formIndex</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#loadvariantcolors-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Load the variant colors for the species into the variant color cache</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">spriteKey</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The sprite key to use</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">female</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>Whether to load female instead of male</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">variant</span>: <a href="../types/sprites_variant.Variant.html" class="tsd-signature-type tsd-kind-type-alias">Variant</a></span></li><li><span><span class="tsd-kind-parameter">back</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span><div class="tsd-comment tsd-typography"><p>Whether the back sprite is being loaded</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">formIndex</span>: <span class="tsd-signature-type">number</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="data_pokemon-species.PokemonSpeciesForm.html">PokemonSpeciesForm</a>.<a href="data_pokemon-species.PokemonSpeciesForm.html#loadvariantcolors">loadVariantColors</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/pokemon-species.ts#L607">src/data/pokemon-species.ts:607</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="validatestartermoveset"><span>validate<wbr/>Starter<wbr/>Moveset</span><a href="#validatestartermoveset" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="validatestartermoveset-1"><span class="tsd-kind-call-signature">validateStarterMoveset</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">moveset</span><span class="tsd-signature-symbol">:</span> <a href="../types/system_game-data.StarterMoveset.html" class="tsd-signature-type tsd-kind-type-alias">StarterMoveset</a><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">eggMoves</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#validatestartermoveset-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div 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">moveset</span>: <a href="../types/system_game-data.StarterMoveset.html" class="tsd-signature-type tsd-kind-type-alias">StarterMoveset</a></span></li><li><span><span class="tsd-kind-parameter">eggMoves</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>Inherited from <a href="data_pokemon-species.PokemonSpeciesForm.html">PokemonSpeciesForm</a>.<a href="data_pokemon-species.PokemonSpeciesForm.html#validatestartermoveset">validateStarterMoveset</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/pokemon-species.ts#L575">src/data/pokemon-species.ts:575</a></li></ul></aside></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#_formindex" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_form<wbr/>Index</span></a><a href="#_generation" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_generation</span></a><a href="#ability1" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ability1</span></a><a href="#ability2" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ability2</span></a><a href="#abilityhidden" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ability<wbr/>Hidden</span></a><a href="#baseexp" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>base<wbr/>Exp</span></a><a href="#basefriendship" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>base<wbr/>Friendship</span></a><a href="#basestats" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>base<wbr/>Stats</span></a><a href="#basetotal" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>base<wbr/>Total</span></a><a href="#catchrate" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>catch<wbr/>Rate</span></a><a href="#formkey"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>form<wbr/>Key</span></a><a href="#formname"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>form<wbr/>Name</span></a><a href="#formspritekey"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>form<wbr/>Sprite<wbr/>Key</span></a><a href="#genderdiffs" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>gender<wbr/>Diffs</span></a><a href="#height" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>height</span></a><a href="#isstarterselectable" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Starter<wbr/>Selectable</span></a><a href="#isunobtainable"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Unobtainable</span></a><a href="#speciesid" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>species<wbr/>Id</span></a><a href="#type1" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type1</span></a><a href="#type2" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type2</span></a><a href="#weight" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>weight</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Accessors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Accessors</summary><div><a href="#formindex" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>form<wbr/>Index</span></a><a href="#generation" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>generation</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#cry" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>cry</span></a><a href="#generatecandycolors" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>generate<wbr/>Candy<wbr/>Colors</span></a><a href="#getability" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Ability</span></a><a href="#getabilitycount" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Ability<wbr/>Count</span></a><a href="#getbaseexp" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Base<wbr/>Exp</span></a><a href="#getbasespritekey" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Base<wbr/>Sprite<wbr/>Key</span></a><a href="#getbasestat" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Base<wbr/>Stat</span></a><a href="#getbasestattotal" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Base<wbr/>Stat<wbr/>Total</span></a><a href="#getcrykey" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Cry<wbr/>Key</span></a><a href="#getformspritekey"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Form<wbr/>Sprite<wbr/>Key</span></a><a href="#geticonatlaskey" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Icon<wbr/>Atlas<wbr/>Key</span></a><a href="#geticonid" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Icon<wbr/>Id</span></a><a href="#getlevelmoves" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Level<wbr/>Moves</span></a><a href="#getpassiveability" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Passive<wbr/>Ability</span></a><a href="#getregion" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Region</span></a><a href="#getrootspeciesid" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Root<wbr/>Species<wbr/>Id</span></a><a href="#getspriteatlaspath" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Sprite<wbr/>Atlas<wbr/>Path</span></a><a href="#getspriteid" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Sprite<wbr/>Id</span></a><a href="#getspritekey" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Sprite<wbr/>Key</span></a><a href="#getvariantdataindex" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Variant<wbr/>Data<wbr/>Index</span></a><a href="#iscatchable" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Catchable</span></a><a href="#isobtainable" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Obtainable</span></a><a href="#isoftype" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Of<wbr/>Type</span></a><a href="#israreregional" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Rare<wbr/>Regional</span></a><a href="#isregional" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Regional</span></a><a href="#istrainerforbidden" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Trainer<wbr/>Forbidden</span></a><a href="#loadassets" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>load<wbr/>Assets</span></a><a href="#loadvariantcolors" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>load<wbr/>Variant<wbr/>Colors</span></a><a href="#validatestartermoveset" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>validate<wbr/>Starter<wbr/>Moveset</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">pokemon-rogue-battle</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
Reference in New Issue View Git Blame Copy Permalink