pokerogue/main/classes/data_pokemon_species.Pokemo...

59 lines
99 KiB
HTML
Raw Normal View History

2024-06-28 04:58:34 +00:00
<!DOCTYPE html><html class="default" lang="en"><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></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">pokemon-rogue-battle</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">pokemon-rogue-battle</a></li><li><a href="../modules/data_pokemon_species.html">data/pokemon-species</a></li><li><a href="data_pokemon_species.PokemonForm.html">PokemonForm</a></li></ul><h1>Class PokemonForm</h1></div><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#data/pokemon-species.PokemonForm">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="data_pokemon_species.PokemonSpeciesForm.html" class="tsd-signature-type tsd-kind-class">PokemonSpeciesForm</a><ul class="tsd-hierarchy"><li><span class="target">PokemonForm</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/d4856c34f1569863b012613185a691beaf88fc2b/src/data/pokemon-species.ts#L837">src/data/pokemon-species.ts:837</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="data_pokemon_species.PokemonForm.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
2024-05-31 13:57:14 +00:00
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="data_pokemon_species.PokemonForm.html#ability1" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ability1</span></a>
<a href="data_pokemon_species.PokemonForm.html#ability2" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ability2</span></a>
<a href="data_pokemon_species.PokemonForm.html#abilityHidden" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ability<wbr/>Hidden</span></a>
<a href="data_pokemon_species.PokemonForm.html#baseExp" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>base<wbr/>Exp</span></a>
<a href="data_pokemon_species.PokemonForm.html#baseFriendship" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>base<wbr/>Friendship</span></a>
<a href="data_pokemon_species.PokemonForm.html#baseStats" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>base<wbr/>Stats</span></a>
<a href="data_pokemon_species.PokemonForm.html#baseTotal" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>base<wbr/>Total</span></a>
<a href="data_pokemon_species.PokemonForm.html#catchRate" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>catch<wbr/>Rate</span></a>
<a href="data_pokemon_species.PokemonForm.html#formIndex" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>form<wbr/>Index</span></a>
<a href="data_pokemon_species.PokemonForm.html#formKey" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>form<wbr/>Key</span></a>
<a href="data_pokemon_species.PokemonForm.html#formName" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>form<wbr/>Name</span></a>
<a href="data_pokemon_species.PokemonForm.html#formSpriteKey" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>form<wbr/>Sprite<wbr/>Key</span></a>
<a href="data_pokemon_species.PokemonForm.html#genderDiffs" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>gender<wbr/>Diffs</span></a>
<a href="data_pokemon_species.PokemonForm.html#generation" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>generation</span></a>
<a href="data_pokemon_species.PokemonForm.html#height" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>height</span></a>
<a href="data_pokemon_species.PokemonForm.html#isStarterSelectable" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Starter<wbr/>Selectable</span></a>
<a href="data_pokemon_species.PokemonForm.html#speciesId" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>species<wbr/>Id</span></a>
<a href="data_pokemon_species.PokemonForm.html#starterSelectableKeys" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>starter<wbr/>Selectable<wbr/>Keys</span></a>
<a href="data_pokemon_species.PokemonForm.html#type1" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type1</span></a>
<a href="data_pokemon_species.PokemonForm.html#type2" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type2</span></a>
<a href="data_pokemon_species.PokemonForm.html#weight" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>weight</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="data_pokemon_species.PokemonForm.html#cry" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>cry</span></a>
<a href="data_pokemon_species.PokemonForm.html#generateCandyColors" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>generate<wbr/>Candy<wbr/>Colors</span></a>
<a href="data_pokemon_species.PokemonForm.html#getAbility" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Ability</span></a>
<a href="data_pokemon_species.PokemonForm.html#getAbilityCount" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Ability<wbr/>Count</span></a>
<a href="data_pokemon_species.PokemonForm.html#getBaseExp" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Base<wbr/>Exp</span></a>
<a href="data_pokemon_species.PokemonForm.html#getBaseStat" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Base<wbr/>Stat</span></a>
<a href="data_pokemon_species.PokemonForm.html#getCryKey" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Cry<wbr/>Key</span></a>
<a href="data_pokemon_species.PokemonForm.html#getFormSpriteKey" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Form<wbr/>Sprite<wbr/>Key</span></a>
<a href="data_pokemon_species.PokemonForm.html#getIconAtlasKey" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Icon<wbr/>Atlas<wbr/>Key</span></a>
<a href="data_pokemon_species.PokemonForm.html#getIconId" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Icon<wbr/>Id</span></a>
<a href="data_pokemon_species.PokemonForm.html#getLevelMoves" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Level<wbr/>Moves</span></a>
<a href="data_pokemon_species.PokemonForm.html#getRegion" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Region</span></a>
<a href="data_pokemon_species.PokemonForm.html#getRootSpeciesId" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Root<wbr/>Species<wbr/>Id</span></a>
<a href="data_pokemon_species.PokemonForm.html#getSpriteAtlasPath" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Sprite<wbr/>Atlas<wbr/>Path</span></a>
<a href="data_pokemon_species.PokemonForm.html#getSpriteId" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Sprite<wbr/>Id</span></a>
<a href="data_pokemon_species.PokemonForm.html#getSpriteKey" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Sprite<wbr/>Key</span></a>
<a href="data_pokemon_species.PokemonForm.html#getVariantDataIndex" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Variant<wbr/>Data<wbr/>Index</span></a>
<a href="data_pokemon_species.PokemonForm.html#isCatchable" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Catchable</span></a>
<a href="data_pokemon_species.PokemonForm.html#isObtainable" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Obtainable</span></a>
<a href="data_pokemon_species.PokemonForm.html#isOfType" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Of<wbr/>Type</span></a>
<a href="data_pokemon_species.PokemonForm.html#isRareRegional" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Rare<wbr/>Regional</span></a>
<a href="data_pokemon_species.PokemonForm.html#isRegional" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Regional</span></a>
<a href="data_pokemon_species.PokemonForm.html#isTrainerForbidden" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Trainer<wbr/>Forbidden</span></a>
<a href="data_pokemon_species.PokemonForm.html#loadAssets" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>load<wbr/>Assets</span></a>
<a href="data_pokemon_species.PokemonForm.html#validateStarterMoveset" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>validate<wbr/>Starter<wbr/>Moveset</span></a>
2024-06-28 04:58:34 +00:00
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_PokemonForm" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Pokemon<wbr/>Form</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">formName</span>, <span class="tsd-kind-parameter">formKey</span>, <span class="tsd-kind-parameter">type1</span>, <span class="tsd-kind-parameter">type2</span>, <span class="tsd-kind-parameter">height</span>, <span class="tsd-kind-parameter">weight</span>, <span class="tsd-kind-parameter">ability1</span>, <span class="tsd-kind-parameter">ability2</span>, <span class="tsd-kind-parameter">abilityHidden</span>, <span class="tsd-kind-parameter">baseTotal</span>, <span class="tsd-kind-parameter">baseHp</span>, <span class="tsd-kind-parameter">baseAtk</span>, <span class="tsd-kind-parameter">baseDef</span>, <span class="tsd-kind-parameter">baseSpatk</span>, <span class="tsd-kind-parameter">baseSpdef</span>, <span class="tsd-kind-parameter">baseSpd</span>, <span class="tsd-kind-parameter">catchRate</span>, <span class="tsd-kind-parameter">baseFriendship</span>, <span class="tsd-kind-parameter">baseExp</span>, <span class="tsd-kind-parameter">genderDiffs</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">formSpriteKey</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">isStarterSelectable</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="data_pokemon_species.PokemonForm.html" class="tsd-signature-type tsd-kind-class">PokemonForm</a><a href="#constructor.new_PokemonForm" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">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/data_type.Type.html" class="tsd-signature-type tsd-kind-enum">Type</a></span></li><li><span><span class="tsd-kind-parameter">type2</span>: <a href="../enums/data_type.Type.html" class="tsd-signature-type tsd-kind-enum">Type</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
2024-05-31 13:57:14 +00:00
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">stat</span>: <a href="../enums/data_pokemon_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&#39; base stat amount.</p>
2024-06-28 04:58:34 +00:00
<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/d4856c34f1569863b012613185a691beaf88fc2b/src/data/pokemon-species.ts#L229">src/data/pokemon-species.ts:229</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="getCryKey" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Cry<wbr/>Key</span><a href="#getCryKey" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="getCryKey.getCryKey-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Cry<wbr/>Key</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">formIndex</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getCryKey.getCryKey-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">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/d4856c34f1569863b012613185a691beaf88fc2b/src/data/pokemon-species.ts#L349">src/data/pokemon-species.ts:349</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getFormSpriteKey" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getFormSpriteKey.getFormSpriteKey-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Form<wbr/>Sprite<wbr/>Key</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">_formIndex</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getFormSpriteKey.getFormSpriteKey-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">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/d4856c34f1569863b012613185a691beaf88fc2b/src/data/pokemon-species.ts#L855">src/data/pokemon-species.ts:855</a></li></ul></as
2024-05-31 13:57:14 +00:00
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>
2024-06-13 22:45:37 +00:00
</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>
2024-06-28 04:58:34 +00:00
<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/d4856c34f1569863b012613185a691beaf88fc2b/src/data/pokemon-species.ts#L168">src/data/pokemon-species.ts:168</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="getSpriteAtlasPath" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="getSpriteAtlasPath.getSpriteAtlasPath-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Sprite<wbr/>Atlas<wbr/>Path</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">female</span>, <span class="tsd-kind-parameter">formIndex</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">shiny</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">variant</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getSpriteAtlasPath.getSpriteAtlasPath-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">female</span>: <span class="tsd-signature-type">boolean</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">formIndex</span>: <span class="tsd-signature-type">number</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">shiny</span>: <span class="tsd-signature-type">boolean</span></span></li><li><span><code class="tsd-tag ts-flagOptional">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#getSpriteAtlasPath">getSpriteAtlasPath</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/d4856c34f1569863b012613185a691beaf88fc2b/src/data/pokemon-species.ts#L248">src/data/pokemon-species.ts:248</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="getSpriteId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Sprite<wbr/>Id</span><a href="#getSpriteId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="getSpriteId.getSpriteId-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Sprite<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">female</span>, <span class="tsd-kind-parameter">formIndex</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">shiny</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">variant</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">back</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symb
2024-05-31 13:57:14 +00:00
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">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>
2024-06-28 04:58:34 +00:00
<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/d4856c34f1569863b012613185a691beaf88fc2b/src/data/pokemon-species.ts#L282">src/data/pokemon-species.ts:282</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="isCatchable" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Catchable</span><a href="#isCatchable" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="isCatchable.isCatchable-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">is<wbr/>Catchable</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#isCatchable.isCatchable-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources"><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/d4856c34f1569863b012613185a691beaf88fc2b/src/data/pokemon-species.ts#L203">src/data/pokemon-species.ts:203</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="isObtainable" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Obtainable</span><a href="#isObtainable" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="isObtainable.isObtainable-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">is<wbr/>Obtainable</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#isObtainable.isObtainable-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources"><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/d4856c34f1569863b012613185a691beaf88fc2b/src/data/pokemon-species.ts#L199">src/data/pokemon-species.ts:199</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="isOfType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Of<wbr/>Type</span><a href="#isOfType" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="isOfType.isOfType-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">is<wbr/>Of<wbr/>Type</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">type</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a hr