mirror of
https://github.com/pagefaultgames/pokerogue.git
synced 2025-08-07 16:09:27 +02:00
1600 lines
1.0 MiB
1600 lines
1.0 MiB
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>EnemyPokemon | 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/field_pokemon.html">field/pokemon</a></li><li><a href="" aria-current="page">EnemyPokemon</a></li></ul><h1>Class EnemyPokemon</h1></div><section class="tsd-panel tsd-hierarchy" data-refl="35515"><h4>Hierarchy (<a href="../hierarchy.html#field/pokemon.EnemyPokemon">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="field_pokemon.default.html" class="tsd-signature-type tsd-kind-class">default</a><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">EnemyPokemon</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L7048">src/field/pokemon.ts:7048</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="#abilityindex" 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/>Index</span></a>
|
||
<a href="#active" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>active</span></a>
|
||
<a href="#aitype" 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>ai<wbr/>Type</span></a>
|
||
<a href="#alpha" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>alpha</span></a>
|
||
<a href="#angle" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>angle</span></a>
|
||
<a href="#battledata" 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>battle<wbr/>Data</span></a>
|
||
<a href="#battleinfo" 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>battle<wbr/>Info</span></a>
|
||
<a href="#blendmode" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>blend<wbr/>Mode</span></a>
|
||
<a href="#body" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>body</span></a>
|
||
<a href="#bosssegmentindex" 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>boss<wbr/>Segment<wbr/>Index</span></a>
|
||
<a href="#bosssegments" 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>boss<wbr/>Segments</span></a>
|
||
<a href="#camerafilter" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>camera<wbr/>Filter</span></a>
|
||
<a href="#custompokemondata" 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>custom<wbr/>Pokemon<wbr/>Data</span></a>
|
||
<a href="#data" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data</span></a>
|
||
<a href="#depth" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>depth</span></a>
|
||
<a href="#displayheight" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>display<wbr/>Height</span></a>
|
||
<a href="#displaylist" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>display<wbr/>List</span></a>
|
||
<a href="#displayoriginx" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>display<wbr/>OriginX</span></a>
|
||
<a href="#displayoriginy" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>display<wbr/>OriginY</span></a>
|
||
<a href="#displaywidth" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>display<wbr/>Width</span></a>
|
||
<a href="#evocounter" 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>evo<wbr/>Counter</span></a>
|
||
<a href="#exclusive" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>exclusive</span></a>
|
||
<a href="#exp" 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>exp</span></a>
|
||
<a href="#fieldposition" 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>field<wbr/>Position</span></a>
|
||
<a href="#first" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>first</span></a>
|
||
<a href="#formindex" 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>form<wbr/>Index</span></a>
|
||
<a href="#friendship" 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>friendship</span></a>
|
||
<a href="#fusionabilityindex" 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>fusion<wbr/>Ability<wbr/>Index</span></a>
|
||
<a href="#fusioncustompokemondata" 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>fusion<wbr/>Custom<wbr/>Pokemon<wbr/>Data</span></a>
|
||
<a href="#fusionformindex" 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>fusion<wbr/>Form<wbr/>Index</span></a>
|
||
<a href="#fusiongender" 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>fusion<wbr/>Gender</span></a>
|
||
<a href="#fusionluck" 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>fusion<wbr/>Luck</span></a>
|
||
<a href="#fusionshiny" 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>fusion<wbr/>Shiny</span></a>
|
||
<a href="#fusionspecies" 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>fusion<wbr/>Species</span></a>
|
||
<a href="#fusionteratype" 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>fusion<wbr/>Tera<wbr/>Type</span></a>
|
||
<a href="#fusionvariant" 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>fusion<wbr/>Variant</span></a>
|
||
<a href="#gender" 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</span></a>
|
||
<a href="#haspostpipeline" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>has<wbr/>Post<wbr/>Pipeline</span></a>
|
||
<a href="#hastransformcomponent" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>has<wbr/>Transform<wbr/>Component</span></a>
|
||
<a href="#height" class="tsd-index-link tsd-is-inherited tsd-is-external"><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="#hp" 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>hp</span></a>
|
||
<a href="#id" 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>id</span></a>
|
||
<a href="#ignoredestroy" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ignore<wbr/>Destroy</span></a>
|
||
<a href="#initialteamindex" 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>initial<wbr/>Team<wbr/>Index</span></a>
|
||
<a href="#input" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>input</span></a>
|
||
<a href="#ispopulatedfromdatasource" 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/>Populated<wbr/>From<wbr/>Data<wbr/>Source</span></a>
|
||
<a href="#isterastallized" 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/>Terastallized</span></a>
|
||
<a href="#ivs" 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>ivs</span></a>
|
||
<a href="#last" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>last</span></a>
|
||
<a href="#length" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>length</span></a>
|
||
<a href="#level" 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>level</span></a>
|
||
<a href="#levelexp" 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>level<wbr/>Exp</span></a>
|
||
<a href="#list" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>list</span></a>
|
||
<a href="#localtransform" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>local<wbr/>Transform</span></a>
|
||
<a href="#luck" 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>luck</span></a>
|
||
<a href="#mask" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>mask</span></a>
|
||
<a href="#maskenabled" 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>mask<wbr/>Enabled</span></a>
|
||
<a href="#masksprite" 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>mask<wbr/>Sprite</span></a>
|
||
<a href="#maxsize" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>max<wbr/>Size</span></a>
|
||
<a href="#metbiome" 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>met<wbr/>Biome</span></a>
|
||
<a href="#metlevel" 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>met<wbr/>Level</span></a>
|
||
<a href="#metspecies" 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>met<wbr/>Species</span></a>
|
||
<a href="#metwave" 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>met<wbr/>Wave</span></a>
|
||
<a href="#moveset" 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>moveset</span></a>
|
||
<a href="#mysteryencounterbattleeffects" 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>mystery<wbr/>Encounter<wbr/>Battle<wbr/>Effects?</span></a>
|
||
<a href="#name" 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>name</span></a>
|
||
<a href="#nature" 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>nature</span></a>
|
||
<a href="#next" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>next</span></a>
|
||
<a href="#nickname" 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>nickname</span></a>
|
||
<a href="#originx" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>originX</span></a>
|
||
<a href="#originy" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>originY</span></a>
|
||
<a href="#parentcontainer" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>parent<wbr/>Container</span></a>
|
||
<a href="#passive" 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>passive</span></a>
|
||
<a href="#pauseevolutions" 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>pause<wbr/>Evolutions</span></a>
|
||
<a href="#pokeball" 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>pokeball</span></a>
|
||
<a href="#pokerus" 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>pokerus</span></a>
|
||
<a href="#position" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>position</span></a>
|
||
<a href="#postfx" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>postFX</span></a>
|
||
<a href="#postpipelinedata" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>post<wbr/>Pipeline<wbr/>Data</span></a>
|
||
<a href="#postpipelines" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>post<wbr/>Pipelines</span></a>
|
||
<a href="#prefx" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>preFX</span></a>
|
||
<a href="#previous" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>previous</span></a>
|
||
<a href="#renderflags" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>render<wbr/>Flags</span></a>
|
||
<a href="#rotation" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>rotation</span></a>
|
||
<a href="#scale" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>scale</span></a>
|
||
<a href="#scalex" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>scaleX</span></a>
|
||
<a href="#scaley" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>scaleY</span></a>
|
||
<a href="#scene" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>scene</span></a>
|
||
<a href="#scrollfactorx" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>scroll<wbr/>FactorX</span></a>
|
||
<a href="#scrollfactory" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>scroll<wbr/>FactorY</span></a>
|
||
<a href="#shiny" 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>shiny</span></a>
|
||
<a href="#species" 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</span></a>
|
||
<a href="#state" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>state</span></a>
|
||
<a href="#stats" 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>stats</span></a>
|
||
<a href="#status" 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>status</span></a>
|
||
<a href="#stellartypesboosted" 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>stellar<wbr/>Types<wbr/>Boosted</span></a>
|
||
<a href="#summondata" 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>summon<wbr/>Data</span></a>
|
||
<a href="#switchoutstatus" 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>switch<wbr/>Out<wbr/>Status</span></a>
|
||
<a href="#tabindex" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tab<wbr/>Index</span></a>
|
||
<a href="#tempsummondata" 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>temp<wbr/>Summon<wbr/>Data</span></a>
|
||
<a href="#teratype" 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>tera<wbr/>Type</span></a>
|
||
<a href="#trainerslot" 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>trainer<wbr/>Slot</span></a>
|
||
<a href="#turndata" 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>turn<wbr/>Data</span></a>
|
||
<a href="#type" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a>
|
||
<a href="#usedtms" 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>usedTMs</span></a>
|
||
<a href="#variant" 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>variant</span></a>
|
||
<a href="#visible" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>visible</span></a>
|
||
<a href="#w" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>w</span></a>
|
||
<a href="#wavedata" 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>wave<wbr/>Data</span></a>
|
||
<a href="#width" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>width</span></a>
|
||
<a href="#x" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>x</span></a>
|
||
<a href="#y" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>y</span></a>
|
||
<a href="#z" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>z</span></a>
|
||
<a href="#render_mask" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>RENDER_<wbr/>MASK</span></a>
|
||
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="#add" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add</span></a>
|
||
<a href="#addat" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>At</span></a>
|
||
<a href="#addedtoscene" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>added<wbr/>To<wbr/>Scene</span></a>
|
||
<a href="#addexp" 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>add<wbr/>Exp</span></a>
|
||
<a href="#addlistener" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Listener</span></a>
|
||
<a href="#addtag" 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>add<wbr/>Tag</span></a>
|
||
<a href="#addtodisplaylist" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>To<wbr/>Display<wbr/>List</span></a>
|
||
<a href="#addtoparty" 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>add<wbr/>To<wbr/>Party</span></a>
|
||
<a href="#addtoupdatelist" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>To<wbr/>Update<wbr/>List</span></a>
|
||
<a href="#breakillusion" 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>break<wbr/>Illusion</span></a>
|
||
<a href="#bringtotop" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>bring<wbr/>To<wbr/>Top</span></a>
|
||
<a href="#calculatebasestats" 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>calculate<wbr/>Base<wbr/>Stats</span></a>
|
||
<a href="#calculatestabmultiplier" 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>calculate<wbr/>Stab<wbr/>Multiplier</span></a>
|
||
<a href="#calculatestats" 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>calculate<wbr/>Stats</span></a>
|
||
<a href="#canaddtag" 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>can<wbr/>Add<wbr/>Tag</span></a>
|
||
<a href="#canapplyability" 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>can<wbr/>Apply<wbr/>Ability</span></a>
|
||
<a href="#canbypassbosssegments" 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>can<wbr/>Bypass<wbr/>Boss<wbr/>Segments</span></a>
|
||
<a href="#cansetstatus" 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>can<wbr/>Set<wbr/>Status</span></a>
|
||
<a href="#changeform" 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>change<wbr/>Form</span></a>
|
||
<a href="#checkifplayerhasabilityofstarter" 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>check<wbr/>If<wbr/>Player<wbr/>Has<wbr/>Ability<wbr/>Of<wbr/>Starter</span></a>
|
||
<a href="#clearalpha" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>clear<wbr/>Alpha</span></a>
|
||
<a href="#clearfusionspecies" 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>clear<wbr/>Fusion<wbr/>Species</span></a>
|
||
<a href="#clearfx" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>clearFX</span></a>
|
||
<a href="#clearmask" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>clear<wbr/>Mask</span></a>
|
||
<a href="#clearstatus" 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>clear<wbr/>Status</span></a>
|
||
<a href="#copyposition" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>copy<wbr/>Position</span></a>
|
||
<a href="#count" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>count</span></a>
|
||
<a href="#createbitmapmask" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Bitmap<wbr/>Mask</span></a>
|
||
<a href="#creategeometrymask" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Geometry<wbr/>Mask</span></a>
|
||
<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="#damage" 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>damage</span></a>
|
||
<a href="#damageandupdate" 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>damage<wbr/>And<wbr/>Update</span></a>
|
||
<a href="#destroy" 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>destroy</span></a>
|
||
<a href="#destroysubstitute" 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>destroy<wbr/>Substitute</span></a>
|
||
<a href="#disableinteractive" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>disable<wbr/>Interactive</span></a>
|
||
<a href="#disablemask" 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>disable<wbr/>Mask</span></a>
|
||
<a href="#each" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>each</span></a>
|
||
<a href="#emit" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>emit</span></a>
|
||
<a href="#enablemask" 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>enable<wbr/>Mask</span></a>
|
||
<a href="#eventnames" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>event<wbr/>Names</span></a>
|
||
<a href="#exists" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>exists</span></a>
|
||
<a href="#faintcry" 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>faint<wbr/>Cry</span></a>
|
||
<a href="#fallbackvariantcolor" 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>fallback<wbr/>Variant<wbr/>Color</span></a>
|
||
<a href="#fieldsetup" 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>field<wbr/>Setup</span></a>
|
||
<a href="#findandremovetags" 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>find<wbr/>And<wbr/>Remove<wbr/>Tags</span></a>
|
||
<a href="#findtag" 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>find<wbr/>Tag</span></a>
|
||
<a href="#findtags" 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>find<wbr/>Tags</span></a>
|
||
<a href="#generateandpopulatemoveset" 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>generate<wbr/>And<wbr/>Populate<wbr/>Moveset</span></a>
|
||
<a href="#generatefusionspecies" 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/>Fusion<wbr/>Species</span></a>
|
||
<a href="#generategender" 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/>Gender</span></a>
|
||
<a href="#generatename" 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/>Name</span></a>
|
||
<a href="#generatenature" 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/>Nature</span></a>
|
||
<a href="#generateshinyvariant" class="tsd-index-link tsd-is-protected 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/>Shiny<wbr/>Variant</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="#getabilityattrs" 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/>Attrs</span></a>
|
||
<a href="#getaccuracymultiplier" 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/>Accuracy<wbr/>Multiplier</span></a>
|
||
<a href="#getall" class="tsd-index-link tsd-is-inherited tsd-is-external"><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/>All</span></a>
|
||
<a href="#getalliedfield" 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/>Allied<wbr/>Field</span></a>
|
||
<a href="#getally" 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/>Ally</span></a>
|
||
<a href="#getat" class="tsd-index-link tsd-is-inherited tsd-is-external"><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/>At</span></a>
|
||
<a href="#getattackdamage" 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/>Attack<wbr/>Damage</span></a>
|
||
<a href="#getattacktypeeffectiveness" 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/>Attack<wbr/>Type<wbr/>Effectiveness</span></a>
|
||
<a href="#getbasedamage" 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/>Damage</span></a>
|
||
<a href="#getbasevariant" 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/>Variant</span></a>
|
||
<a href="#getbattleinfo" 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/>Battle<wbr/>Info</span></a>
|
||
<a href="#getbattlerindex" 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/>Battler<wbr/>Index</span></a>
|
||
<a href="#getbattlespriteatlaspath" 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/>Battle<wbr/>Sprite<wbr/>Atlas<wbr/>Path</span></a>
|
||
<a href="#getbattlespriteid" 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/>Battle<wbr/>Sprite<wbr/>Id</span></a>
|
||
<a href="#getbattlespritekey" 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/>Battle<wbr/>Sprite<wbr/>Key</span></a>
|
||
<a href="#getbosssegmentindex" 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/>Boss<wbr/>Segment<wbr/>Index</span></a>
|
||
<a href="#getbounds" class="tsd-index-link tsd-is-inherited tsd-is-external"><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/>Bounds</span></a>
|
||
<a href="#getboundstransformmatrix" class="tsd-index-link tsd-is-inherited tsd-is-external"><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/>Bounds<wbr/>Transform<wbr/>Matrix</span></a>
|
||
<a href="#getbyname" class="tsd-index-link tsd-is-inherited tsd-is-external"><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/>By<wbr/>Name</span></a>
|
||
<a href="#getcriticalhitresult" 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/>Critical<wbr/>Hit<wbr/>Result</span></a>
|
||
<a href="#getcritstage" 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/>Crit<wbr/>Stage</span></a>
|
||
<a href="#getdata" class="tsd-index-link tsd-is-inherited tsd-is-external"><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/>Data</span></a>
|
||
<a href="#getdexattr" 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/>Dex<wbr/>Attr</span></a>
|
||
<a href="#getdisplaylist" class="tsd-index-link tsd-is-inherited tsd-is-external"><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/>Display<wbr/>List</span></a>
|
||
<a href="#geteffectivestat" 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/>Effective<wbr/>Stat</span></a>
|
||
<a href="#geteggmoves" 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/>Egg<wbr/>Moves</span></a>
|
||
<a href="#getevolution" 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/>Evolution</span></a>
|
||
<a href="#getexpvalue" 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/>Exp<wbr/>Value</span></a>
|
||
<a href="#getfieldindex" 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/>Field<wbr/>Index</span></a>
|
||
<a href="#getfieldpositionoffset" 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/>Field<wbr/>Position<wbr/>Offset</span></a>
|
||
<a href="#getfirst" class="tsd-index-link tsd-is-inherited tsd-is-external"><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/>First</span></a>
|
||
<a href="#getformkey" 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/>Form<wbr/>Key</span></a>
|
||
<a href="#getfusionbattlespriteatlaspath" 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/>Fusion<wbr/>Battle<wbr/>Sprite<wbr/>Atlas<wbr/>Path</span></a>
|
||
<a href="#getfusionbattlespriteid" 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/>Fusion<wbr/>Battle<wbr/>Sprite<wbr/>Id</span></a>
|
||
<a href="#getfusionbattlespritekey" 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/>Fusion<wbr/>Battle<wbr/>Sprite<wbr/>Key</span></a>
|
||
<a href="#getfusionformkey" 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/>Fusion<wbr/>Form<wbr/>Key</span></a>
|
||
<a href="#getfusiongender" 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/>Fusion<wbr/>Gender</span></a>
|
||
<a href="#getfusioniconatlaskey" 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/>Fusion<wbr/>Icon<wbr/>Atlas<wbr/>Key</span></a>
|
||
<a href="#getfusioniconid" 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/>Fusion<wbr/>Icon<wbr/>Id</span></a>
|
||
<a href="#getfusionspeciesform" 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/>Fusion<wbr/>Species<wbr/>Form</span></a>
|
||
<a href="#getfusionspriteid" 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/>Fusion<wbr/>Sprite<wbr/>Id</span></a>
|
||
<a href="#getgender" 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/>Gender</span></a>
|
||
<a href="#gethelditems" 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/>Held<wbr/>Items</span></a>
|
||
<a href="#gethpratio" 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/>Hp<wbr/>Ratio</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="#getindex" class="tsd-index-link tsd-is-inherited tsd-is-external"><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/>Index</span></a>
|
||
<a href="#getindexlist" class="tsd-index-link tsd-is-inherited tsd-is-external"><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/>Index<wbr/>List</span></a>
|
||
<a href="#getinversehp" 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/>Inverse<wbr/>Hp</span></a>
|
||
<a href="#getlastxmoves" 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/>LastXMoves</span></a>
|
||
<a href="#getlearnablelevelmoves" 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/>Learnable<wbr/>Level<wbr/>Moves</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="#getlocalpoint" class="tsd-index-link tsd-is-inherited tsd-is-external"><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/>Local<wbr/>Point</span></a>
|
||
<a href="#getlocaltransformmatrix" class="tsd-index-link tsd-is-inherited tsd-is-external"><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/>Local<wbr/>Transform<wbr/>Matrix</span></a>
|
||
<a href="#getluck" 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/>Luck</span></a>
|
||
<a href="#getmatchupscore" 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/>Matchup<wbr/>Score</span></a>
|
||
<a href="#getmaxhp" 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/>Max<wbr/>Hp</span></a>
|
||
<a href="#getmovecategory" 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/>Move<wbr/>Category</span></a>
|
||
<a href="#getmoveeffectiveness" 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/>Move<wbr/>Effectiveness</span></a>
|
||
<a href="#getmovehistory" 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/>Move<wbr/>History</span></a>
|
||
<a href="#getmovequeue" 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/>Move<wbr/>Queue</span></a>
|
||
<a href="#getmoveset" 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/>Moveset</span></a>
|
||
<a href="#getmovetype" 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/>Move<wbr/>Type</span></a>
|
||
<a href="#getname" 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/>Name</span></a>
|
||
<a href="#getnametorender" 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/>Name<wbr/>To<wbr/>Render</span></a>
|
||
<a href="#getnature" 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/>Nature</span></a>
|
||
<a href="#getnextmove" 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/>Next<wbr/>Move</span></a>
|
||
<a href="#getnexttargets" 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/>Next<wbr/>Targets</span></a>
|
||
<a href="#getopponent" 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/>Opponent</span></a>
|
||
<a href="#getopponentdescriptor" 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/>Opponent<wbr/>Descriptor</span></a>
|
||
<a href="#getopponents" 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/>Opponents</span></a>
|
||
<a href="#getparentrotation" class="tsd-index-link tsd-is-inherited tsd-is-external"><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/>Parent<wbr/>Rotation</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="#getpokeball" 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/>Pokeball</span></a>
|
||
<a href="#getpostpipeline" class="tsd-index-link tsd-is-inherited tsd-is-external"><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/>Post<wbr/>Pipeline</span></a>
|
||
<a href="#getrandom" class="tsd-index-link tsd-is-inherited tsd-is-external"><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/>Random</span></a>
|
||
<a href="#getrestrictingtag" 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/>Restricting<wbr/>Tag</span></a>
|
||
<a href="#getspeciesform" 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/>Species<wbr/>Form</span></a>
|
||
<a href="#getsprite" 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</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="#getspritescale" 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/>Scale</span></a>
|
||
<a href="#getstat" 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/>Stat</span></a>
|
||
<a href="#getstats" 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/>Stats</span></a>
|
||
<a href="#getstatstage" 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/>Stat<wbr/>Stage</span></a>
|
||
<a href="#getstatstagemultiplier" 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/>Stat<wbr/>Stage<wbr/>Multiplier</span></a>
|
||
<a href="#getstatstages" 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/>Stat<wbr/>Stages</span></a>
|
||
<a href="#getsubstituteoffset" 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/>Substitute<wbr/>Offset</span></a>
|
||
<a href="#gettag" 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/>Tag</span></a>
|
||
<a href="#getteratype" 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/>Tera<wbr/>Type</span></a>
|
||
<a href="#gettintsprite" 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/>Tint<wbr/>Sprite</span></a>
|
||
<a href="#gettypes" 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/>Types</span></a>
|
||
<a href="#getunlockedeggmoves" 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/>Unlocked<wbr/>Egg<wbr/>Moves</span></a>
|
||
<a href="#getvariant" 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</span></a>
|
||
<a href="#getweight" 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/>Weight</span></a>
|
||
<a href="#getworldpoint" class="tsd-index-link tsd-is-inherited tsd-is-external"><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/>World<wbr/>Point</span></a>
|
||
<a href="#getworldtransformmatrix" class="tsd-index-link tsd-is-inherited tsd-is-external"><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/>World<wbr/>Transform<wbr/>Matrix</span></a>
|
||
<a href="#handlebosssegmentcleared" 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>handle<wbr/>Boss<wbr/>Segment<wbr/>Cleared</span></a>
|
||
<a href="#hasability" 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>has<wbr/>Ability</span></a>
|
||
<a href="#hasabilitywithattr" 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>has<wbr/>Ability<wbr/>With<wbr/>Attr</span></a>
|
||
<a href="#hasfusionspecies" 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>has<wbr/>Fusion<wbr/>Species</span></a>
|
||
<a href="#haspassive" 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>has<wbr/>Passive</span></a>
|
||
<a href="#hassameabilityinrootform" 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>has<wbr/>Same<wbr/>Ability<wbr/>In<wbr/>Root<wbr/>Form</span></a>
|
||
<a href="#hasspecies" 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>has<wbr/>Species</span></a>
|
||
<a href="#hastrainer" 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>has<wbr/>Trainer</span></a>
|
||
<a href="#heal" 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>heal</span></a>
|
||
<a href="#hideinfo" 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>hide<wbr/>Info</span></a>
|
||
<a href="#incdata" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>inc<wbr/>Data</span></a>
|
||
<a href="#init" 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>init</span></a>
|
||
<a href="#initbattleinfo" 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>init<wbr/>Battle<wbr/>Info</span></a>
|
||
<a href="#initpostpipeline" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>init<wbr/>Post<wbr/>Pipeline</span></a>
|
||
<a href="#initshinysparkle" 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>init<wbr/>Shiny<wbr/>Sparkle</span></a>
|
||
<a href="#isactive" 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/>Active</span></a>
|
||
<a href="#isallowedinbattle" 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/>Allowed<wbr/>In<wbr/>Battle</span></a>
|
||
<a href="#isallowedinchallenge" 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/>Allowed<wbr/>In<wbr/>Challenge</span></a>
|
||
<a href="#isbaseshiny" 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/>Base<wbr/>Shiny</span></a>
|
||
<a href="#isboss" 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>is<wbr/>Boss</span></a>
|
||
<a href="#isbossimmune" 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/>Boss<wbr/>Immune</span></a>
|
||
<a href="#isdoubleshiny" 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/>Double<wbr/>Shiny</span></a>
|
||
<a href="#isfainted" 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/>Fainted</span></a>
|
||
<a href="#isfullhp" 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/>Full<wbr/>Hp</span></a>
|
||
<a href="#isfusion" 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/>Fusion</span></a>
|
||
<a href="#isfusionshiny" 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/>Fusion<wbr/>Shiny</span></a>
|
||
<a href="#isgrounded" 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/>Grounded</span></a>
|
||
<a href="#ismax" 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/>Max</span></a>
|
||
<a href="#ismega" 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/>Mega</span></a>
|
||
<a href="#ismoverestricted" 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/>Move<wbr/>Restricted</span></a>
|
||
<a href="#ismovetargetrestricted" 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/>Move<wbr/>Target<wbr/>Restricted</span></a>
|
||
<a href="#isoffsetbysubstitute" 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/>Offset<wbr/>By<wbr/>Substitute</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="#isonfield" 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/>On<wbr/>Field</span></a>
|
||
<a href="#isopponent" 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/>Opponent</span></a>
|
||
<a href="#isoppositegender" 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/>Opposite<wbr/>Gender</span></a>
|
||
<a href="#isplayer" 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>is<wbr/>Player</span></a>
|
||
<a href="#issafeguarded" 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/>Safeguarded</span></a>
|
||
<a href="#isshiny" 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/>Shiny</span></a>
|
||
<a href="#istrapped" 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/>Trapped</span></a>
|
||
<a href="#iterate" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>iterate</span></a>
|
||
<a href="#lapsetag" 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>lapse<wbr/>Tag</span></a>
|
||
<a href="#lapsetags" 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>lapse<wbr/>Tags</span></a>
|
||
<a href="#leavefield" 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>leave<wbr/>Field</span></a>
|
||
<a href="#listenercount" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>listener<wbr/>Count</span></a>
|
||
<a href="#listeners" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>listeners</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="#losehelditem" 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>lose<wbr/>Held<wbr/>Item</span></a>
|
||
<a href="#moveabove" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>move<wbr/>Above</span></a>
|
||
<a href="#movebelow" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>move<wbr/>Below</span></a>
|
||
<a href="#movedown" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>move<wbr/>Down</span></a>
|
||
<a href="#moveto" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>move<wbr/>To</span></a>
|
||
<a href="#moveup" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>move<wbr/>Up</span></a>
|
||
<a href="#off" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>off</span></a>
|
||
<a href="#on" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>on</span></a>
|
||
<a href="#once" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>once</span></a>
|
||
<a href="#onchilddestroyed" class="tsd-index-link tsd-is-protected tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>on<wbr/>Child<wbr/>Destroyed</span></a>
|
||
<a href="#playanim" 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>play<wbr/>Anim</span></a>
|
||
<a href="#pointtocontainer" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>point<wbr/>To<wbr/>Container</span></a>
|
||
<a href="#populatevariantcolorcache" 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>populate<wbr/>Variant<wbr/>Color<wbr/>Cache</span></a>
|
||
<a href="#predestroy" class="tsd-index-link tsd-is-protected tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>pre<wbr/>Destroy</span></a>
|
||
<a href="#pushmovehistory" 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>push<wbr/>Move<wbr/>History</span></a>
|
||
<a href="#queueimmunemessage" 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>queue<wbr/>Immune<wbr/>Message</span></a>
|
||
<a href="#randbattleseedint" 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>rand<wbr/>Battle<wbr/>Seed<wbr/>Int</span></a>
|
||
<a href="#randbattleseedintrange" 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>rand<wbr/>Battle<wbr/>Seed<wbr/>Int<wbr/>Range</span></a>
|
||
<a href="#recordeatenberry" 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>record<wbr/>Eaten<wbr/>Berry</span></a>
|
||
<a href="#remove" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove</span></a>
|
||
<a href="#removeall" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>All</span></a>
|
||
<a href="#removealllisteners" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>All<wbr/>Listeners</span></a>
|
||
<a href="#removeat" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>At</span></a>
|
||
<a href="#removebetween" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>Between</span></a>
|
||
<a href="#removedfromscene" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>removed<wbr/>From<wbr/>Scene</span></a>
|
||
<a href="#removefromdisplaylist" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>From<wbr/>Display<wbr/>List</span></a>
|
||
<a href="#removefromupdatelist" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>From<wbr/>Update<wbr/>List</span></a>
|
||
<a href="#removeinteractive" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>Interactive</span></a>
|
||
<a href="#removelistener" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>Listener</span></a>
|
||
<a href="#removepostpipeline" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>Post<wbr/>Pipeline</span></a>
|
||
<a href="#removetag" 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>remove<wbr/>Tag</span></a>
|
||
<a href="#removetagsbysourceid" 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>remove<wbr/>Tags<wbr/>By<wbr/>Source<wbr/>Id</span></a>
|
||
<a href="#replace" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>replace</span></a>
|
||
<a href="#resetbattleandwavedata" 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>reset<wbr/>Battle<wbr/>And<wbr/>Wave<wbr/>Data</span></a>
|
||
<a href="#resetpostpipeline" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>reset<wbr/>Post<wbr/>Pipeline</span></a>
|
||
<a href="#resetsprite" 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>reset<wbr/>Sprite</span></a>
|
||
<a href="#resetstatus" 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>reset<wbr/>Status</span></a>
|
||
<a href="#resetsummondata" 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>reset<wbr/>Summon<wbr/>Data</span></a>
|
||
<a href="#resettera" 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>reset<wbr/>Tera</span></a>
|
||
<a href="#resetturndata" 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>reset<wbr/>Turn<wbr/>Data</span></a>
|
||
<a href="#resetwavedata" 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>reset<wbr/>Wave<wbr/>Data</span></a>
|
||
<a href="#reverse" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>reverse</span></a>
|
||
<a href="#sendtoback" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>To<wbr/>Back</span></a>
|
||
<a href="#setabove" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Above</span></a>
|
||
<a href="#setactive" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Active</span></a>
|
||
<a href="#setall" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>All</span></a>
|
||
<a href="#setalpha" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Alpha</span></a>
|
||
<a href="#setangle" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Angle</span></a>
|
||
<a href="#setbelow" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Below</span></a>
|
||
<a href="#setblendmode" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Blend<wbr/>Mode</span></a>
|
||
<a href="#setboss" 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>set<wbr/>Boss</span></a>
|
||
<a href="#setcustomnature" 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>set<wbr/>Custom<wbr/>Nature</span></a>
|
||
<a href="#setdata" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Data</span></a>
|
||
<a href="#setdataenabled" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Data<wbr/>Enabled</span></a>
|
||
<a href="#setdepth" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Depth</span></a>
|
||
<a href="#setdisplaysize" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Display<wbr/>Size</span></a>
|
||
<a href="#setexclusive" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Exclusive</span></a>
|
||
<a href="#setfieldposition" 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>set<wbr/>Field<wbr/>Position</span></a>
|
||
<a href="#setframerate" 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>set<wbr/>Frame<wbr/>Rate</span></a>
|
||
<a href="#setillusion" 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>set<wbr/>Illusion</span></a>
|
||
<a href="#setinteractive" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Interactive</span></a>
|
||
<a href="#setmask" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Mask</span></a>
|
||
<a href="#setmove" 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>set<wbr/>Move</span></a>
|
||
<a href="#setname" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Name</span></a>
|
||
<a href="#setnature" 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>set<wbr/>Nature</span></a>
|
||
<a href="#setposition" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Position</span></a>
|
||
<a href="#setpositionrelative" 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>set<wbr/>Position<wbr/>Relative</span></a>
|
||
<a href="#setpostpipeline" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Post<wbr/>Pipeline</span></a>
|
||
<a href="#setpostpipelinedata" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Post<wbr/>Pipeline<wbr/>Data</span></a>
|
||
<a href="#setrandomposition" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Random<wbr/>Position</span></a>
|
||
<a href="#setrotation" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Rotation</span></a>
|
||
<a href="#setscale" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Scale</span></a>
|
||
<a href="#setscrollfactor" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Scroll<wbr/>Factor</span></a>
|
||
<a href="#setsize" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Size</span></a>
|
||
<a href="#setstat" 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>set<wbr/>Stat</span></a>
|
||
<a href="#setstate" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>State</span></a>
|
||
<a href="#setstatstage" 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>set<wbr/>Stat<wbr/>Stage</span></a>
|
||
<a href="#setswitchoutstatus" 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>set<wbr/>Switch<wbr/>Out<wbr/>Status</span></a>
|
||
<a href="#settempability" 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>set<wbr/>Temp<wbr/>Ability</span></a>
|
||
<a href="#settoback" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>To<wbr/>Back</span></a>
|
||
<a href="#settotop" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>To<wbr/>Top</span></a>
|
||
<a href="#setvisible" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Visible</span></a>
|
||
<a href="#setw" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>setW</span></a>
|
||
<a href="#setx" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>setX</span></a>
|
||
<a href="#sety" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>setY</span></a>
|
||
<a href="#setz" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>setZ</span></a>
|
||
<a href="#showinfo" 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>show<wbr/>Info</span></a>
|
||
<a href="#shuffle" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>shuffle</span></a>
|
||
<a href="#shutdown" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>shutdown</span></a>
|
||
<a href="#sort" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>sort</span></a>
|
||
<a href="#sparkle" 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>sparkle</span></a>
|
||
<a href="#suppressability" 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>suppress<wbr/>Ability</span></a>
|
||
<a href="#swap" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>swap</span></a>
|
||
<a href="#tint" 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>tint</span></a>
|
||
<a href="#toggledata" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>toggle<wbr/>Data</span></a>
|
||
<a href="#toggleflyout" 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>toggle<wbr/>Flyout</span></a>
|
||
<a href="#togglestats" 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>toggle<wbr/>Stats</span></a>
|
||
<a href="#tojson" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>toJSON</span></a>
|
||
<a href="#transfersummon" 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>transfer<wbr/>Summon</span></a>
|
||
<a href="#transfertagsbysourceid" 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>transfer<wbr/>Tags<wbr/>By<wbr/>Source<wbr/>Id</span></a>
|
||
<a href="#tryplaysprite" 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>try<wbr/>Play<wbr/>Sprite</span></a>
|
||
<a href="#tryrerollhiddenabilityseed" 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>try<wbr/>Reroll<wbr/>Hidden<wbr/>Ability<wbr/>Seed</span></a>
|
||
<a href="#tryselectmove" 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>try<wbr/>Select<wbr/>Move</span></a>
|
||
<a href="#trysetshiny" 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>try<wbr/>Set<wbr/>Shiny</span></a>
|
||
<a href="#trysetshinyseed" 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>try<wbr/>Set<wbr/>Shiny<wbr/>Seed</span></a>
|
||
<a href="#trysetstatus" 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>try<wbr/>Set<wbr/>Status</span></a>
|
||
<a href="#untint" 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>untint</span></a>
|
||
<a href="#update" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update</span></a>
|
||
<a href="#updateeffectiveness" 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>update<wbr/>Effectiveness</span></a>
|
||
<a href="#updatefusionpalette" 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>update<wbr/>Fusion<wbr/>Palette</span></a>
|
||
<a href="#updateinfo" 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>update<wbr/>Info</span></a>
|
||
<a href="#updatescale" 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>update<wbr/>Scale</span></a>
|
||
<a href="#updatespritepipelinedata" 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>update<wbr/>Sprite<wbr/>Pipeline<wbr/>Data</span></a>
|
||
<a href="#willrender" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>will<wbr/>Render</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="constructorenemypokemon"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">EnemyPokemon</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">species</span><span class="tsd-signature-symbol">:</span> <a href="data_pokemon-species.default.html" class="tsd-signature-type tsd-kind-class">default</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">level</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">trainerSlot</span><span class="tsd-signature-symbol">:</span> <a href="../enums/enums_trainer-slot.TrainerSlot.html" class="tsd-signature-type tsd-kind-enum">TrainerSlot</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">boss</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">shinyLock</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">dataSource</span><span class="tsd-signature-symbol">?:</span> <a href="system_pokemon-data.default.html" class="tsd-signature-type tsd-kind-class">default</a><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">EnemyPokemon</a><a href="#constructorenemypokemon" 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">species</span>: <a href="data_pokemon-species.default.html" class="tsd-signature-type tsd-kind-class">default</a></span></li><li><span><span class="tsd-kind-parameter">level</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">trainerSlot</span>: <a href="../enums/enums_trainer-slot.TrainerSlot.html" class="tsd-signature-type tsd-kind-enum">TrainerSlot</a></span></li><li><span><span class="tsd-kind-parameter">boss</span>: <span class="tsd-signature-type">boolean</span></span></li><li><span><span class="tsd-kind-parameter">shinyLock</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">dataSource</span>: <a href="system_pokemon-data.default.html" class="tsd-signature-type tsd-kind-class">default</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">EnemyPokemon</a></h4><aside class="tsd-sources"><p>Overrides <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L7057">src/field/pokemon.ts:7057</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-inherited"><h3 class="tsd-anchor-link" id="abilityindex"><span>ability<wbr/>Index</span><a href="#abilityindex" 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">abilityIndex</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#abilityindex">abilityIndex</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L321">src/field/pokemon.ts:321</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="active"><span>active</span><a href="#active" 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">active</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>The active state of this Game Object.
|
||
A Game Object with an active state of <code>true</code> is processed by the Scenes UpdateList, if added to it.
|
||
An active object is one which is having its logic and internal systems updated.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#active">active</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:19965</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="aitype"><span>ai<wbr/>Type</span><a href="#aitype" 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">aiType</span><span class="tsd-signature-symbol">:</span> <a href="../enums/field_pokemon.AiType.html" class="tsd-signature-type tsd-kind-enum">AiType</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L7050">src/field/pokemon.ts:7050</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="alpha"><span>alpha</span><a href="#alpha" 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">alpha</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The alpha value of the Game Object.</p>
|
||
<p>This is a global value, impacting the entire Game Object, not just a region of it.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#alpha">alpha</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17326</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="angle"><span>angle</span><a href="#angle" 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">angle</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The angle of this Game Object as expressed in degrees.</p>
|
||
<p>Phaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left
|
||
and -90 is up.</p>
|
||
<p>If you prefer to work in radians, see the <code>rotation</code> property instead.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#angle">angle</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17764</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="battledata"><span>battle<wbr/>Data</span><a href="#battledata" 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">battleData</span><span class="tsd-signature-symbol">:</span> <a href="field_pokemon.PokemonBattleData.html" class="tsd-signature-type tsd-kind-class">PokemonBattleData</a><span class="tsd-signature-symbol"> = ...</span></div><div class="tsd-comment tsd-typography"><p>Data that resets only on <em>battle</em> end (hit count, harvest berries, etc.)
|
||
Kept between waves.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#battledata">battleData</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L369">src/field/pokemon.ts:369</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><h3 class="tsd-anchor-link" id="battleinfo"><code class="tsd-tag">Protected</code><span>battle<wbr/>Info</span><a href="#battleinfo" 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">battleInfo</span><span class="tsd-signature-symbol">:</span> <a href="ui_battle-info.default.html" class="tsd-signature-type tsd-kind-class">default</a></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#battleinfo">battleInfo</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L326">src/field/pokemon.ts:326</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="blendmode"><span>blend<wbr/>Mode</span><a href="#blendmode" 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">blendMode</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> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">BlendModes</span></div><div class="tsd-comment tsd-typography"><p>Sets the Blend Mode being used by this Game Object.</p>
|
||
<p>This can be a const, such as <code>Phaser.BlendModes.SCREEN</code>, or an integer, such as 4 (for Overlay)</p>
|
||
<p>Under WebGL only the following Blend Modes are available:</p>
|
||
<ul>
|
||
<li>NORMAL</li>
|
||
<li>ADD</li>
|
||
<li>MULTIPLY</li>
|
||
<li>SCREEN</li>
|
||
<li>ERASE</li>
|
||
</ul>
|
||
<p>Canvas has more available depending on browser support.</p>
|
||
<p>You can also create your own custom Blend Modes in WebGL.</p>
|
||
<p>Blend modes have different effects under Canvas and WebGL, and from browser to browser, depending
|
||
on support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these
|
||
reasons try to be careful about the construction of your Scene and the frequency of which blend modes
|
||
are used.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#blendmode">blendMode</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17350</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="body"><span>body</span><a href="#body" 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">body</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">BodyType</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Body</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">StaticBody</span></div><div class="tsd-comment tsd-typography"><p>If this Game Object is enabled for Arcade or Matter Physics then this property will contain a reference to a Physics Body.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#body">body</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:20003</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="bosssegmentindex"><span>boss<wbr/>Segment<wbr/>Index</span><a href="#bosssegmentindex" 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">bossSegmentIndex</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L7052">src/field/pokemon.ts:7052</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="bosssegments"><span>boss<wbr/>Segments</span><a href="#bosssegments" 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">bossSegments</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L7051">src/field/pokemon.ts:7051</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="camerafilter"><span>camera<wbr/>Filter</span><a href="#camerafilter" 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">cameraFilter</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>A bitmask that controls if this Game Object is drawn by a Camera or not.
|
||
Not usually set directly, instead call <code>Camera.ignore</code>, however you can
|
||
set this property directly using the <a href="http://Camera.id">Camera.id</a> property:</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#camerafilter">cameraFilter</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:19992</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="custompokemondata"><span>custom<wbr/>Pokemon<wbr/>Data</span><a href="#custompokemondata" 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">customPokemonData</span><span class="tsd-signature-symbol">:</span> <a href="data_custom-pokemon-data.CustomPokemonData.html" class="tsd-signature-type tsd-kind-class">CustomPokemonData</a><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#custompokemondata">customPokemonData</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L361">src/field/pokemon.ts:361</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="data"><span>data</span><a href="#data" 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">data</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">DataManager</span></div><div class="tsd-comment tsd-typography"><p>A Data Manager.
|
||
It allows you to store, query and get key/value paired information specific to this Game Object.
|
||
<code>null</code> by default. Automatically created if you use <code>getData</code> or <code>setData</code> or <code>setDataEnabled</code>.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#data">data</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:19978</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="depth"><span>depth</span><a href="#depth" 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">depth</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The depth of this Game Object within the Scene. Ensure this value is only ever set to a number data-type.</p>
|
||
<p>The depth is also known as the 'z-index' in some environments, and allows you to change the rendering order
|
||
of Game Objects, without actually moving their position in the display list.</p>
|
||
<p>The default depth is zero. A Game Object with a higher depth
|
||
value will always render in front of one with a lower value.</p>
|
||
<p>Setting the depth will queue a depth sort event within the Scene.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#depth">depth</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17448</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="displayheight"><span>display<wbr/>Height</span><a href="#displayheight" 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">displayHeight</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The displayed height of this Game Object.</p>
|
||
<p>This value takes into account the scale factor.</p>
|
||
<p>Setting this value will adjust the Game Object's scale property.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#displayheight">displayHeight</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17411</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="displaylist"><span>display<wbr/>List</span><a href="#displaylist" 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">displayList</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Layer</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">DisplayList</span></div><div class="tsd-comment tsd-typography"><p>Holds a reference to the Display List that contains this Game Object.</p>
|
||
<p>This is set automatically when this Game Object is added to a Scene or Layer.</p>
|
||
<p>You should treat this property as being read-only.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#displaylist">displayList</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:19929</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="displayoriginx"><code class="tsd-tag">Readonly</code><span>display<wbr/>OriginX</span><a href="#displayoriginx" 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">displayOriginX</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>Internal value to allow Containers to be used for input and physics.
|
||
Do not change this value. It has no effect other than to break things.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#displayoriginx">displayOriginX</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:16914</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="displayoriginy"><code class="tsd-tag">Readonly</code><span>display<wbr/>OriginY</span><a href="#displayoriginy" 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">displayOriginY</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>Internal value to allow Containers to be used for input and physics.
|
||
Do not change this value. It has no effect other than to break things.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#displayoriginy">displayOriginY</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:16920</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="displaywidth"><span>display<wbr/>Width</span><a href="#displaywidth" 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">displayWidth</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The displayed width of this Game Object.</p>
|
||
<p>This value takes into account the scale factor.</p>
|
||
<p>Setting this value will adjust the Game Object's scale property.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#displaywidth">displayWidth</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17402</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="evocounter"><span>evo<wbr/>Counter</span><a href="#evocounter" 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">evoCounter</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#evocounter">evoCounter</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L346">src/field/pokemon.ts:346</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="exclusive"><span>exclusive</span><a href="#exclusive" 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">exclusive</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Does this Container exclusively manage its children?</p>
|
||
<p>The default is <code>true</code> which means a child added to this Container cannot
|
||
belong in another Container, which includes the Scene display list.</p>
|
||
<p>If you disable this then this Container will no longer exclusively manage its children.
|
||
This allows you to create all kinds of interesting graphical effects, such as replicating
|
||
Game Objects without reparenting them all over the Scene.
|
||
However, doing so will prevent children from receiving any kind of input event or have
|
||
their physics bodies work by default, as they're no longer a single entity on the
|
||
display list, but are being replicated where-ever this Container is.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#exclusive">exclusive</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:16835</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="exp"><span>exp</span><a href="#exp" 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">exp</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#exp">exp</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L328">src/field/pokemon.ts:328</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="fieldposition"><span>field<wbr/>Position</span><a href="#fieldposition" 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">fieldPosition</span><span class="tsd-signature-symbol">:</span> <a href="../enums/field_pokemon.FieldPosition.html" class="tsd-signature-type tsd-kind-enum">FieldPosition</a></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#fieldposition">fieldPosition</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L382">src/field/pokemon.ts:382</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="first"><code class="tsd-tag">Readonly</code><span>first</span><a href="#first" 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">first</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">GameObject</span></div><div class="tsd-comment tsd-typography"><p>Returns the first Game Object within the Container, or <code>null</code> if it is empty.</p>
|
||
<p>You can move the cursor by calling <code>Container.next</code> and <code>Container.previous</code>.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#first">first</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17274</li></ul></aside></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><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="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#formindex">formIndex</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L320">src/field/pokemon.ts:320</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="friendship"><span>friendship</span><a href="#friendship" 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">friendship</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#friendship">friendship</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L337">src/field/pokemon.ts:337</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="fusionabilityindex"><span>fusion<wbr/>Ability<wbr/>Index</span><a href="#fusionabilityindex" 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">fusionAbilityIndex</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#fusionabilityindex">fusionAbilityIndex</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L353">src/field/pokemon.ts:353</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="fusioncustompokemondata"><span>fusion<wbr/>Custom<wbr/>Pokemon<wbr/>Data</span><a href="#fusioncustompokemondata" 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">fusionCustomPokemonData</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a href="data_custom-pokemon-data.CustomPokemonData.html" class="tsd-signature-type tsd-kind-class">CustomPokemonData</a></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#fusioncustompokemondata">fusionCustomPokemonData</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L358">src/field/pokemon.ts:358</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="fusionformindex"><span>fusion<wbr/>Form<wbr/>Index</span><a href="#fusionformindex" 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">fusionFormIndex</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#fusionformindex">fusionFormIndex</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L352">src/field/pokemon.ts:352</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="fusiongender"><span>fusion<wbr/>Gender</span><a href="#fusiongender" 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">fusionGender</span><span class="tsd-signature-symbol">:</span> <a href="../enums/data_gender.Gender.html" class="tsd-signature-type tsd-kind-enum">Gender</a></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#fusiongender">fusionGender</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L356">src/field/pokemon.ts:356</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="fusionluck"><span>fusion<wbr/>Luck</span><a href="#fusionluck" 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">fusionLuck</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#fusionluck">fusionLuck</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L357">src/field/pokemon.ts:357</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="fusionshiny"><span>fusion<wbr/>Shiny</span><a href="#fusionshiny" 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">fusionShiny</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#fusionshiny">fusionShiny</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L354">src/field/pokemon.ts:354</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="fusionspecies"><span>fusion<wbr/>Species</span><a href="#fusionspecies" 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">fusionSpecies</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a href="data_pokemon-species.default.html" class="tsd-signature-type tsd-kind-class">default</a></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#fusionspecies">fusionSpecies</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L351">src/field/pokemon.ts:351</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="fusionteratype"><span>fusion<wbr/>Tera<wbr/>Type</span><a href="#fusionteratype" 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">fusionTeraType</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="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#fusionteratype">fusionTeraType</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L359">src/field/pokemon.ts:359</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="fusionvariant"><span>fusion<wbr/>Variant</span><a href="#fusionvariant" 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">fusionVariant</span><span class="tsd-signature-symbol">:</span> <a href="../types/sprites_variant.Variant.html" class="tsd-signature-type tsd-kind-type-alias">Variant</a></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#fusionvariant">fusionVariant</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L355">src/field/pokemon.ts:355</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="gender"><span>gender</span><a href="#gender" 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">gender</span><span class="tsd-signature-symbol">:</span> <a href="../enums/data_gender.Gender.html" class="tsd-signature-type tsd-kind-enum">Gender</a></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#gender">gender</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L330">src/field/pokemon.ts:330</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="haspostpipeline"><span>has<wbr/>Post<wbr/>Pipeline</span><a href="#haspostpipeline" 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">hasPostPipeline</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Does this Game Object have any Post Pipelines set?</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#haspostpipeline">hasPostPipeline</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17572</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="hastransformcomponent"><code class="tsd-tag">Readonly</code><span>has<wbr/>Transform<wbr/>Component</span><a href="#hastransformcomponent" 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">hasTransformComponent</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>A property indicating that a Game Object has this component.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#hastransformcomponent">hasTransformComponent</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17712</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="height"><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><div class="tsd-comment tsd-typography"><p>The native (un-scaled) height of this Game Object.</p>
|
||
<p>Changing this value will not change the size that the Game Object is rendered in-game.
|
||
For that you need to either set the scale of the Game Object (<code>setScale</code>) or use
|
||
the <code>displayHeight</code> property.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#height">height</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17393</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="hp"><span>hp</span><a href="#hp" 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">hp</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#hp">hp</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L331">src/field/pokemon.ts:331</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="id"><span>id</span><a href="#id" 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">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>This pokemon's <a href="https://bulbapedia.bulbagarden.net/wiki/Personality_value">Personality value/PID</a>,
|
||
used to determine various parameters of this Pokemon.
|
||
Represented as a random 32-bit unsigned integer.
|
||
TODO: Stop treating this like a unique ID and stop treating 0 as no pokemon</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#id">id</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L316">src/field/pokemon.ts:316</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="ignoredestroy"><span>ignore<wbr/>Destroy</span><a href="#ignoredestroy" 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">ignoreDestroy</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>This Game Object will ignore all calls made to its destroy method if this flag is set to <code>true</code>.
|
||
This includes calls that may come from a Group, Container or the Scene itself.
|
||
While it allows you to persist a Game Object across Scenes, please understand you are entirely
|
||
responsible for managing references to and from this Game Object.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#ignoredestroy">ignoreDestroy</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:20011</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="initialteamindex"><span>initial<wbr/>Team<wbr/>Index</span><a href="#initialteamindex" 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">initialTeamIndex</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L7053">src/field/pokemon.ts:7053</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="input"><span>input</span><a href="#input" 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">input</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">InteractiveObject</span></div><div class="tsd-comment tsd-typography"><p>If this Game Object is enabled for input then this property will contain an InteractiveObject instance.
|
||
Not usually set directly. Instead call <code>GameObject.setInteractive()</code>.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#input">input</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:19998</li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="ispopulatedfromdatasource"><code class="tsd-tag">Readonly</code><span>is<wbr/>Populated<wbr/>From<wbr/>Data<wbr/>Source</span><a href="#ispopulatedfromdatasource" 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">isPopulatedFromDataSource</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>To indicate if the instance was populated with a dataSource -> e.g. loaded & populated from session data</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L7055">src/field/pokemon.ts:7055</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="isterastallized"><span>is<wbr/>Terastallized</span><a href="#isterastallized" 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">isTerastallized</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#isterastallized">isTerastallized</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L348">src/field/pokemon.ts:348</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="ivs"><span>ivs</span><a href="#ivs" 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">ivs</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="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#ivs">ivs</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L333">src/field/pokemon.ts:333</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="last"><code class="tsd-tag">Readonly</code><span>last</span><a href="#last" 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">last</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">GameObject</span></div><div class="tsd-comment tsd-typography"><p>Returns the last Game Object within the Container, or <code>null</code> if it is empty.</p>
|
||
<p>You can move the cursor by calling <code>Container.next</code> and <code>Container.previous</code>.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#last">last</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17281</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="length"><code class="tsd-tag">Readonly</code><span>length</span><a href="#length" 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">length</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The number of Game Objects inside this Container.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#length">length</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17267</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="level"><span>level</span><a href="#level" 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">level</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#level">level</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L327">src/field/pokemon.ts:327</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="levelexp"><span>level<wbr/>Exp</span><a href="#levelexp" 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">levelExp</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#levelexp">levelExp</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L329">src/field/pokemon.ts:329</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="list"><span>list</span><a href="#list" 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">list</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">GameObject</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>An array holding the children of this Container.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#list">list</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:16820</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="localtransform"><span>local<wbr/>Transform</span><a href="#localtransform" 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">localTransform</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">TransformMatrix</span></div><div class="tsd-comment tsd-typography"><p>Internal Transform Matrix used for local space conversion.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#localtransform">localTransform</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:16852</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="luck"><span>luck</span><a href="#luck" 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">luck</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#luck">luck</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L342">src/field/pokemon.ts:342</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="mask"><span>mask</span><a href="#mask" 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">mask</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">BitmapMask</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">GeometryMask</span></div><div class="tsd-comment tsd-typography"><p>The Mask this Game Object is using during render.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#mask">mask</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17509</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="maskenabled"><span>mask<wbr/>Enabled</span><a href="#maskenabled" 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">maskEnabled</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#maskenabled">maskEnabled</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L384">src/field/pokemon.ts:384</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="masksprite"><span>mask<wbr/>Sprite</span><a href="#masksprite" 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">maskSprite</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">Sprite</span></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#masksprite">maskSprite</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L385">src/field/pokemon.ts:385</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="maxsize"><span>max<wbr/>Size</span><a href="#maxsize" 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">maxSize</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>Containers can have an optional maximum size. If set to anything above 0 it
|
||
will constrict the addition of new Game Objects into the Container, capping off
|
||
the maximum limit the Container can grow in size to.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#maxsize">maxSize</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:16842</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="metbiome"><span>met<wbr/>Biome</span><a href="#metbiome" 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">metBiome</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">-1</span> <span class="tsd-signature-symbol">|</span> <a href="../enums/enums_biome.Biome.html" class="tsd-signature-type tsd-kind-enum">Biome</a></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#metbiome">metBiome</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L339">src/field/pokemon.ts:339</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="metlevel"><span>met<wbr/>Level</span><a href="#metlevel" 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">metLevel</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#metlevel">metLevel</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L338">src/field/pokemon.ts:338</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="metspecies"><span>met<wbr/>Species</span><a href="#metspecies" 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">metSpecies</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="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#metspecies">metSpecies</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L340">src/field/pokemon.ts:340</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="metwave"><span>met<wbr/>Wave</span><a href="#metwave" 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">metWave</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#metwave">metWave</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L341">src/field/pokemon.ts:341</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="moveset"><span>moveset</span><a href="#moveset" 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">moveset</span><span class="tsd-signature-symbol">:</span> <a href="field_pokemon.PokemonMove.html" class="tsd-signature-type tsd-kind-class">PokemonMove</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#moveset">moveset</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L335">src/field/pokemon.ts:335</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="mysteryencounterbattleeffects"><code class="tsd-tag">Optional</code><span>mystery<wbr/>Encounter<wbr/>Battle<wbr/>Effects</span><a href="#mysteryencounterbattleeffects" 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">mysteryEncounterBattleEffects</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">pokemon</span><span class="tsd-signature-symbol">:</span> <a href="field_pokemon.default.html" class="tsd-signature-type tsd-kind-class">default</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">void</span></div><div class="tsd-comment tsd-typography"><p>Used by Mystery Encounters to execute pokemon-specific logic (such as stat boosts) at start of battle</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#mysteryencounterbattleeffects">mysteryEncounterBattleEffects</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L380">src/field/pokemon.ts:380</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="name"><span>name</span><a href="#name" 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">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The name of this Game Object.
|
||
Empty by default and never populated by Phaser, this is left for developers to use.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L317">src/field/pokemon.ts:317</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="nature"><span>nature</span><a href="#nature" 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">nature</span><span class="tsd-signature-symbol">:</span> <a href="../enums/enums_nature.Nature.html" class="tsd-signature-type tsd-kind-enum">Nature</a></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#nature">nature</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L334">src/field/pokemon.ts:334</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="next"><code class="tsd-tag">Readonly</code><span>next</span><a href="#next" 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">next</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">GameObject</span></div><div class="tsd-comment tsd-typography"><p>Returns the next Game Object within the Container, or <code>null</code> if it is empty.</p>
|
||
<p>You can move the cursor by calling <code>Container.next</code> and <code>Container.previous</code>.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#next">next</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17288</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="nickname"><span>nickname</span><a href="#nickname" 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">nickname</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#nickname">nickname</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L318">src/field/pokemon.ts:318</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="originx"><code class="tsd-tag">Readonly</code><span>originX</span><a href="#originx" 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">originX</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>Internal value to allow Containers to be used for input and physics.
|
||
Do not change this value. It has no effect other than to break things.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#originx">originX</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:16902</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="originy"><code class="tsd-tag">Readonly</code><span>originY</span><a href="#originy" 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">originY</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>Internal value to allow Containers to be used for input and physics.
|
||
Do not change this value. It has no effect other than to break things.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#originy">originY</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:16908</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="parentcontainer"><span>parent<wbr/>Container</span><a href="#parentcontainer" 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">parentContainer</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Container</span></div><div class="tsd-comment tsd-typography"><p>The parent Container of this Game Object, if it has one.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#parentcontainer">parentContainer</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:19952</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="passive"><span>passive</span><a href="#passive" 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">passive</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#passive">passive</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L322">src/field/pokemon.ts:322</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="pauseevolutions"><span>pause<wbr/>Evolutions</span><a href="#pauseevolutions" 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">pauseEvolutions</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#pauseevolutions">pauseEvolutions</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L343">src/field/pokemon.ts:343</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="pokeball"><span>pokeball</span><a href="#pokeball" 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">pokeball</span><span class="tsd-signature-symbol">:</span> <a href="../enums/enums_pokeball.PokeballType.html" class="tsd-signature-type tsd-kind-enum">PokeballType</a></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#pokeball">pokeball</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L325">src/field/pokemon.ts:325</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="pokerus"><span>pokerus</span><a href="#pokerus" 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">pokerus</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#pokerus">pokerus</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L344">src/field/pokemon.ts:344</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="position"><span>position</span><a href="#position" 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">position</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The cursor position.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#position">position</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:16847</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="postfx"><span>postFX</span><a href="#postfx" 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">postFX</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">FX</span></div><div class="tsd-comment tsd-typography"><p>The Post FX component of this Game Object.</p>
|
||
<p>This component allows you to apply a variety of built-in effects to this Game Object, such
|
||
as glow, blur, bloom, displacements, vignettes and more. You access them via this property,
|
||
for example:</p>
|
||
<pre><code class="js"><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">player</span><span class="hl-1"> = </span><span class="hl-4">this</span><span class="hl-1">.</span><span class="hl-2">add</span><span class="hl-1">.</span><span class="hl-6">sprite</span><span class="hl-1">();</span><br/><span class="hl-2">player</span><span class="hl-1">.</span><span class="hl-2">postFX</span><span class="hl-1">.</span><span class="hl-6">addBloom</span><span class="hl-1">();</span>
|
||
</code><button type="button">Copy</button></pre>
|
||
|
||
<p>All FX are WebGL only and do not have Canvas counterparts.</p>
|
||
<p>Please see the FX Class for more details and available methods.</p>
|
||
<p>This property is always <code>null</code> until the <code>initPostPipeline</code> method is called.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#postfx">postFX</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17634</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="postpipelinedata"><span>post<wbr/>Pipeline<wbr/>Data</span><a href="#postpipelinedata" 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">postPipelineData</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div><div class="tsd-comment tsd-typography"><p>An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#postpipelinedata">postPipelineData</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17587</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="postpipelines"><span>post<wbr/>Pipelines</span><a href="#postpipelines" 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">postPipelines</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">PostFXPipeline</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>The WebGL Post FX Pipelines this Game Object uses for post-render effects.</p>
|
||
<p>The pipelines are processed in the order in which they appear in this array.</p>
|
||
<p>If you modify this array directly, be sure to set the
|
||
<code>hasPostPipeline</code> property accordingly.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#postpipelines">postPipelines</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17582</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="prefx"><span>preFX</span><a href="#prefx" 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">preFX</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">FX</span></div><div class="tsd-comment tsd-typography"><p>The Pre FX component of this Game Object.</p>
|
||
<p>This component allows you to apply a variety of built-in effects to this Game Object, such
|
||
as glow, blur, bloom, displacements, vignettes and more. You access them via this property,
|
||
for example:</p>
|
||
<pre><code class="js"><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">player</span><span class="hl-1"> = </span><span class="hl-4">this</span><span class="hl-1">.</span><span class="hl-2">add</span><span class="hl-1">.</span><span class="hl-6">sprite</span><span class="hl-1">();</span><br/><span class="hl-2">player</span><span class="hl-1">.</span><span class="hl-2">preFX</span><span class="hl-1">.</span><span class="hl-6">addBloom</span><span class="hl-1">();</span>
|
||
</code><button type="button">Copy</button></pre>
|
||
|
||
<p>Only the following Game Objects support Pre FX:</p>
|
||
<ul>
|
||
<li>Image</li>
|
||
<li>Sprite</li>
|
||
<li>TileSprite</li>
|
||
<li>Text</li>
|
||
<li>RenderTexture</li>
|
||
<li>Video</li>
|
||
</ul>
|
||
<p>All FX are WebGL only and do not have Canvas counterparts.</p>
|
||
<p>Please see the FX Class for more details and available methods.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#prefx">preFX</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17614</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="previous"><code class="tsd-tag">Readonly</code><span>previous</span><a href="#previous" 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">previous</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">GameObject</span></div><div class="tsd-comment tsd-typography"><p>Returns the previous Game Object within the Container, or <code>null</code> if it is empty.</p>
|
||
<p>You can move the cursor by calling <code>Container.next</code> and <code>Container.previous</code>.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#previous">previous</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17295</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="renderflags"><span>render<wbr/>Flags</span><a href="#renderflags" 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">renderFlags</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The flags that are compared against <code>RENDER_MASK</code> to determine if this Game Object will render or not.
|
||
The bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.
|
||
If those components are not used by your custom class then you can use this bitmask as you wish.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#renderflags">renderFlags</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:19985</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="rotation"><span>rotation</span><a href="#rotation" 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">rotation</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The angle of this Game Object in radians.</p>
|
||
<p>Phaser uses a right-hand clockwise rotation system, where 0 is right, PI/2 is down, +-PI is left
|
||
and -PI/2 is up.</p>
|
||
<p>If you prefer to work in degrees, see the <code>angle</code> property instead.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#rotation">rotation</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17774</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="scale"><span>scale</span><a href="#scale" 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">scale</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object
|
||
to the same value, at the same time. When reading this value the result returned is <code>(scaleX + scaleY) / 2</code>.</p>
|
||
<p>Use of this property implies you wish the horizontal and vertical scales to be equal to each other. If this
|
||
isn't the case, use the <code>scaleX</code> or <code>scaleY</code> properties instead.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#scale">scale</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17744</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="scalex"><span>scaleX</span><a href="#scalex" 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">scaleX</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The horizontal scale of this Game Object.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#scalex">scaleX</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17749</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="scaley"><span>scaleY</span><a href="#scaley" 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">scaleY</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The vertical scale of this Game Object.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#scaley">scaleY</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17754</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="scene"><span>scene</span><a href="#scene" 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">scene</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Scene</span></div><div class="tsd-comment tsd-typography"><p>A reference to the Scene to which this Game Object belongs.</p>
|
||
<p>Game Objects can only belong to one Scene.</p>
|
||
<p>You should consider this property as being read-only. You cannot move a
|
||
Game Object to another Scene by simply changing it.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#scene">scene</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:19920</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="scrollfactorx"><span>scroll<wbr/>FactorX</span><a href="#scrollfactorx" 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">scrollFactorX</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The horizontal scroll factor of this Container.</p>
|
||
<p>The scroll factor controls the influence of the movement of a Camera upon this Container.</p>
|
||
<p>When a camera scrolls it will change the location at which this Container is rendered on-screen.
|
||
It does not change the Containers actual position values.</p>
|
||
<p>For a Container, setting this value will only update the Container itself, not its children.
|
||
If you wish to change the scrollFactor of the children as well, use the <code>setScrollFactor</code> method.</p>
|
||
<p>A value of 1 means it will move exactly in sync with a camera.
|
||
A value of 0 means it will not move at all, even if the camera moves.
|
||
Other values control the degree to which the camera movement is mapped to this Container.</p>
|
||
<p>Please be aware that scroll factor values other than 1 are not taken in to consideration when
|
||
calculating physics collisions. Bodies always collide based on their world position, but changing
|
||
the scroll factor is a visual adjustment to where the textures are rendered, which can offset
|
||
them from physics bodies if not accounted for in your code.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#scrollfactorx">scrollFactorX</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:16874</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="scrollfactory"><span>scroll<wbr/>FactorY</span><a href="#scrollfactory" 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">scrollFactorY</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The vertical scroll factor of this Container.</p>
|
||
<p>The scroll factor controls the influence of the movement of a Camera upon this Container.</p>
|
||
<p>When a camera scrolls it will change the location at which this Container is rendered on-screen.
|
||
It does not change the Containers actual position values.</p>
|
||
<p>For a Container, setting this value will only update the Container itself, not its children.
|
||
If you wish to change the scrollFactor of the children as well, use the <code>setScrollFactor</code> method.</p>
|
||
<p>A value of 1 means it will move exactly in sync with a camera.
|
||
A value of 0 means it will not move at all, even if the camera moves.
|
||
Other values control the degree to which the camera movement is mapped to this Container.</p>
|
||
<p>Please be aware that scroll factor values other than 1 are not taken in to consideration when
|
||
calculating physics collisions. Bodies always collide based on their world position, but changing
|
||
the scroll factor is a visual adjustment to where the textures are rendered, which can offset
|
||
them from physics bodies if not accounted for in your code.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#scrollfactory">scrollFactorY</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:16896</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="shiny"><span>shiny</span><a href="#shiny" 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">shiny</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#shiny">shiny</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L323">src/field/pokemon.ts:323</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="species"><span>species</span><a href="#species" 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">species</span><span class="tsd-signature-symbol">:</span> <a href="data_pokemon-species.default.html" class="tsd-signature-type tsd-kind-class">default</a></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#species">species</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L319">src/field/pokemon.ts:319</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="state"><span>state</span><a href="#state" 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">state</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></div><div class="tsd-comment tsd-typography"><p>The current state of this Game Object.</p>
|
||
<p>Phaser itself will never modify this value, although plugins may do so.</p>
|
||
<p>Use this property to track the state of a Game Object during its lifetime. For example, it could change from
|
||
a state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant
|
||
in your game code), or a string. These are recommended to keep it light and simple, with fast comparisons.
|
||
If you need to store complex data about your Game Object, look at using the Data Component instead.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#state">state</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:19947</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="stats"><span>stats</span><a href="#stats" 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">stats</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="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#stats">stats</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L332">src/field/pokemon.ts:332</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="status"><span>status</span><a href="#status" 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">status</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a href="data_status-effect.Status.html" class="tsd-signature-type tsd-kind-class">Status</a></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#status">status</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L336">src/field/pokemon.ts:336</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="stellartypesboosted"><span>stellar<wbr/>Types<wbr/>Boosted</span><a href="#stellartypesboosted" 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">stellarTypesBoosted</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></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#stellartypesboosted">stellarTypesBoosted</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L349">src/field/pokemon.ts:349</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="summondata"><span>summon<wbr/>Data</span><a href="#summondata" 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">summonData</span><span class="tsd-signature-symbol">:</span> <a href="field_pokemon.PokemonSummonData.html" class="tsd-signature-type tsd-kind-class">PokemonSummonData</a><span class="tsd-signature-symbol"> = ...</span></div><div class="tsd-comment tsd-typography"><p>Data that resets on switch or battle end (stat stages, battler tags, etc.)</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#summondata">summonData</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L371">src/field/pokemon.ts:371</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="switchoutstatus"><span>switch<wbr/>Out<wbr/>Status</span><a href="#switchoutstatus" 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">switchOutStatus</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#switchoutstatus">switchOutStatus</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L345">src/field/pokemon.ts:345</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="tabindex"><span>tab<wbr/>Index</span><a href="#tabindex" 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">tabIndex</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The Tab Index of the Game Object.
|
||
Reserved for future use by plugins and the Input Manager.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#tabindex">tabIndex</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:19971</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="tempsummondata"><span>temp<wbr/>Summon<wbr/>Data</span><a href="#tempsummondata" 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">tempSummonData</span><span class="tsd-signature-symbol">:</span> <a href="field_pokemon.PokemonTempSummonData.html" class="tsd-signature-type tsd-kind-class">PokemonTempSummonData</a><span class="tsd-signature-symbol"> = ...</span></div><div class="tsd-comment tsd-typography"><p>Similar to <a href="field_pokemon.PokemonSummonData.html" class="tsd-kind-class"><code>PokemonSummonData</code></a>, but is reset on reload (not saved to file).</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#tempsummondata">tempSummonData</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L373">src/field/pokemon.ts:373</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="teratype"><span>tera<wbr/>Type</span><a href="#teratype" 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">teraType</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="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#teratype">teraType</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L347">src/field/pokemon.ts:347</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="trainerslot"><span>trainer<wbr/>Slot</span><a href="#trainerslot" 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">trainerSlot</span><span class="tsd-signature-symbol">:</span> <a href="../enums/enums_trainer-slot.TrainerSlot.html" class="tsd-signature-type tsd-kind-enum">TrainerSlot</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L7049">src/field/pokemon.ts:7049</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="turndata"><span>turn<wbr/>Data</span><a href="#turndata" 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">turnData</span><span class="tsd-signature-symbol">:</span> <a href="field_pokemon.PokemonTurnData.html" class="tsd-signature-type tsd-kind-class">PokemonTurnData</a><span class="tsd-signature-symbol"> = ...</span></div><div class="tsd-comment tsd-typography"><p>Per-turn data like hit count & flinch tracking</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#turndata">turnData</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L377">src/field/pokemon.ts:377</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="type"><span>type</span><a href="#type" 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">type</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>A textual representation of this Game Object, i.e. <code>sprite</code>.
|
||
Used internally by Phaser but is available for your own custom classes to populate.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#type">type</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:19935</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="usedtms"><span>usedTMs</span><a href="#usedtms" 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">usedTMs</span><span class="tsd-signature-symbol">:</span> <a href="../enums/enums_moves.Moves.html" class="tsd-signature-type tsd-kind-enum">Moves</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#usedtms">usedTMs</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L387">src/field/pokemon.ts:387</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="variant"><span>variant</span><a href="#variant" 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">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></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#variant">variant</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L324">src/field/pokemon.ts:324</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="visible"><span>visible</span><a href="#visible" 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">visible</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>The visible state of the Game Object.</p>
|
||
<p>An invisible Game Object will skip rendering, but will still process update logic.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#visible">visible</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17901</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="w"><span>w</span><a href="#w" 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">w</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The w position of this Game Object.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#w">w</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17735</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="wavedata"><span>wave<wbr/>Data</span><a href="#wavedata" 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">waveData</span><span class="tsd-signature-symbol">:</span> <a href="field_pokemon.PokemonWaveData.html" class="tsd-signature-type tsd-kind-class">PokemonWaveData</a><span class="tsd-signature-symbol"> = ...</span></div><div class="tsd-comment tsd-typography"><p>Wave data correponding to moves/ability information revealed</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#wavedata">waveData</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L375">src/field/pokemon.ts:375</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="width"><span>width</span><a href="#width" 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">width</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The native (un-scaled) width of this Game Object.</p>
|
||
<p>Changing this value will not change the size that the Game Object is rendered in-game.
|
||
For that you need to either set the scale of the Game Object (<code>setScale</code>) or use
|
||
the <code>displayWidth</code> property.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#width">width</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17384</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="x"><span>x</span><a href="#x" 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">x</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The x position of this Game Object.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#x">x</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17717</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="y"><span>y</span><a href="#y" 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">y</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The y position of this Game Object.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#y">y</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17722</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="z"><span>z</span><a href="#z" 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">z</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The z position of this Game Object.</p>
|
||
<p>Note: The z position does not control the rendering order of 2D Game Objects. Use
|
||
Phaser.GameObjects.Components.Depth#depth instead.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#z">z</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17730</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="render_mask"><code class="tsd-tag">Static</code> <code class="tsd-tag">Readonly</code><span>RENDER_<wbr/>MASK</span><a href="#render_mask" 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">RENDER_MASK</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The bitmask that <code>GameObject.renderFlags</code> is compared against to determine if the Game Object will render or not.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#render_mask">RENDER_MASK</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:20330</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-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 tsd-is-external"><h3 class="tsd-anchor-link" id="add"><span>add</span><a href="#add" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="add-1"><span class="tsd-kind-call-signature">add</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#addt">T</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">GameObject</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">child</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="field_arena.ArenaBase.html#addt">T</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="field_arena.ArenaBase.html#addt">T</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#add-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>Adds the given Game Object, or array of Game Objects, to this Container.</p>
|
||
<p>Each Game Object must be unique within the Container.</p>
|
||
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="addt"><span class="tsd-kind-type-parameter">T</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">GameObject</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">child</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="field_arena.ArenaBase.html#addt">T</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="field_arena.ArenaBase.html#addt">T</a><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>The Game Object, or array of Game Objects, to add to the Container.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#add">add</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:16975</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="addat"><span>add<wbr/>At</span><a href="#addat" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="addat-1"><span class="tsd-kind-call-signature">addAt</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#addatt">T</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">GameObject</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">child</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="field_arena.ArenaBase.html#addatt">T</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="field_arena.ArenaBase.html#addatt">T</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">index</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">this</span><a href="#addat-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>Adds the given Game Object, or array of Game Objects, to this Container at the specified position.</p>
|
||
<p>Existing Game Objects in the Container are shifted up.</p>
|
||
<p>Each Game Object must be unique within the Container.</p>
|
||
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="addatt"><span class="tsd-kind-type-parameter">T</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">GameObject</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">child</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="field_arena.ArenaBase.html#addatt">T</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="field_arena.ArenaBase.html#addatt">T</a><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>The Game Object, or array of Game Objects, to add to the Container.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">index</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The position to insert the Game Object/s at. Default 0.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#addat">addAt</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:16986</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="addedtoscene"><span>added<wbr/>To<wbr/>Scene</span><a href="#addedtoscene" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="addedtoscene-1"><span class="tsd-kind-call-signature">addedToScene</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#addedtoscene-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>This callback is invoked when this Game Object is added to a Scene.</p>
|
||
<p>Can be overriden by custom Game Objects, but be aware of some Game Objects that
|
||
will use this, such as Sprites, to add themselves into the Update List.</p>
|
||
<p>You can also listen for the <code>ADDED_TO_SCENE</code> event from this Game Object.</p>
|
||
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#addedtoscene">addedToScene</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:20202</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="addexp"><span>add<wbr/>Exp</span><a href="#addexp" 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="addexp-1"><span class="tsd-kind-call-signature">addExp</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">exp</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">ignoreLevelCap</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> <span class="tsd-signature-type">void</span><a href="#addexp-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>Adds experience to this PlayerPokemon, subject to wave based level caps.</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">exp</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The amount of experience to add</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">ignoreLevelCap</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span><div class="tsd-comment tsd-typography"><p>Whether to ignore level caps when adding experience (defaults to false)</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#addexp">addExp</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L3900">src/field/pokemon.ts:3900</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="addlistener"><span>add<wbr/>Listener</span><a href="#addlistener" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="addlistener-1"><span class="tsd-kind-call-signature">addListener</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</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">symbol</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">fn</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">context</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#addlistener-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>Add a listener for a given event.</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">event</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">symbol</span></span><div class="tsd-comment tsd-typography"><p>The event name.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">fn</span>: <span class="tsd-signature-type">Function</span></span><div class="tsd-comment tsd-typography"><p>The listener function.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">context</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The context to invoke the listener with. Default this.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#addlistener">addListener</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:9971</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="addtag"><span>add<wbr/>Tag</span><a href="#addtag" 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="addtag-1"><span class="tsd-kind-call-signature">addTag</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">tagType</span><span class="tsd-signature-symbol">:</span> <a href="../enums/enums_battler-tag-type.BattlerTagType.html" class="tsd-signature-type tsd-kind-enum">BattlerTagType</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">turnCount</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">sourceMove</span><span class="tsd-signature-symbol">?:</span> <a href="../enums/enums_moves.Moves.html" class="tsd-signature-type tsd-kind-enum">Moves</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">sourceId</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">boolean</span><a href="#addtag-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">tagType</span>: <a href="../enums/enums_battler-tag-type.BattlerTagType.html" class="tsd-signature-type tsd-kind-enum">BattlerTagType</a></span></li><li><span><span class="tsd-kind-parameter">turnCount</span>: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">sourceMove</span>: <a href="../enums/enums_moves.Moves.html" class="tsd-signature-type tsd-kind-enum">Moves</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">sourceId</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="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#addtag">addTag</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L4868">src/field/pokemon.ts:4868</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="addtodisplaylist"><span>add<wbr/>To<wbr/>Display<wbr/>List</span><a href="#addtodisplaylist" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="addtodisplaylist-1"><span class="tsd-kind-call-signature">addToDisplayList</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">displayList</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Layer</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">DisplayList</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#addtodisplaylist-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>Adds this Game Object to the given Display List.</p>
|
||
<p>If no Display List is specified, it will default to the Display List owned by the Scene to which
|
||
this Game Object belongs.</p>
|
||
<p>A Game Object can only exist on one Display List at any given time, but may move freely between them.</p>
|
||
<p>If this Game Object is already on another Display List when this method is called, it will first
|
||
be removed from it, before being added to the new list.</p>
|
||
<p>You can query which list it is on by looking at the <code>Phaser.GameObjects.GameObject#displayList</code> property.</p>
|
||
<p>If a Game Object isn't on any display list, it will not be rendered. If you just wish to temporarly
|
||
disable it from rendering, consider using the <code>setVisible</code> method, instead.</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">displayList</span>: <span class="tsd-signature-type">Layer</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">DisplayList</span></span><div class="tsd-comment tsd-typography"><p>The Display List to add to. Defaults to the Scene Display List.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#addtodisplaylist">addToDisplayList</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:20259</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="addtoparty"><span>add<wbr/>To<wbr/>Party</span><a href="#addtoparty" 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="addtoparty-1"><span class="tsd-kind-call-signature">addToParty</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">pokeballType</span><span class="tsd-signature-symbol">:</span> <a href="../enums/enums_pokeball.PokeballType.html" class="tsd-signature-type tsd-kind-enum">PokeballType</a><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">slotIndex</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">null</span> <span class="tsd-signature-symbol">|</span> <a href="field_pokemon.PlayerPokemon.html" class="tsd-signature-type tsd-kind-class">PlayerPokemon</a><a href="#addtoparty-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>Add a new pokemon to the player's party (at <code>slotIndex</code> if set).
|
||
The new pokemon's visibility will be set to <code>false</code>.</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">pokeballType</span>: <a href="../enums/enums_pokeball.PokeballType.html" class="tsd-signature-type tsd-kind-enum">PokeballType</a></span><div class="tsd-comment tsd-typography"><p>the type of pokeball the pokemon was caught with</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">slotIndex</span>: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = -1</span></span><div class="tsd-comment tsd-typography"><p>an optional index to place the pokemon in the party</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a href="field_pokemon.PlayerPokemon.html" class="tsd-signature-type tsd-kind-class">PlayerPokemon</a></h4><p>the pokemon that was added or null if the pokemon could not be added</p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L7731">src/field/pokemon.ts:7731</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="addtoupdatelist"><span>add<wbr/>To<wbr/>Update<wbr/>List</span><a href="#addtoupdatelist" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="addtoupdatelist-1"><span class="tsd-kind-call-signature">addToUpdateList</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#addtoupdatelist-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>Adds this Game Object to the Update List belonging to the Scene.</p>
|
||
<p>When a Game Object is added to the Update List it will have its <code>preUpdate</code> method called
|
||
every game frame. This method is passed two parameters: <code>delta</code> and <code>time</code>.</p>
|
||
<p>If you wish to run your own logic within <code>preUpdate</code> then you should always call
|
||
<code>super.preUpdate(delta, time)</code> within it, or it may fail to process required operations,
|
||
such as Sprite animations.</p>
|
||
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#addtoupdatelist">addToUpdateList</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:20271</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="breakillusion"><span>break<wbr/>Illusion</span><a href="#breakillusion" 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="breakillusion-1"><span class="tsd-kind-call-signature">breakIllusion</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#breakillusion-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="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#breakillusion">breakIllusion</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L813">src/field/pokemon.ts:813</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="bringtotop"><span>bring<wbr/>To<wbr/>Top</span><a href="#bringtotop" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="bringtotop-1"><span class="tsd-kind-call-signature">bringToTop</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#bringtotopt">T</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">GameObject</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">child</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="field_arena.ArenaBase.html#bringtotopt">T</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#bringtotop-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>Brings the given Game Object to the top of this Container.
|
||
This will cause it to render on-top of any other objects in the Container.</p>
|
||
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="bringtotopt"><span class="tsd-kind-type-parameter">T</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">GameObject</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">child</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="field_arena.ArenaBase.html#bringtotopt">T</a></span><div class="tsd-comment tsd-typography"><p>The Game Object to bring to the top of the Container.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#bringtotop">bringToTop</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17156</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="calculatebasestats"><span>calculate<wbr/>Base<wbr/>Stats</span><a href="#calculatebasestats" 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="calculatebasestats-1"><span class="tsd-kind-call-signature">calculateBaseStats</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><a href="#calculatebasestats-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></h4><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#calculatebasestats">calculateBaseStats</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L1758">src/field/pokemon.ts:1758</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="calculatestabmultiplier"><span>calculate<wbr/>Stab<wbr/>Multiplier</span><a href="#calculatestabmultiplier" 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="calculatestabmultiplier-1"><span class="tsd-kind-call-signature">calculateStabMultiplier</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">source</span><span class="tsd-signature-symbol">:</span> <a href="field_pokemon.default.html" class="tsd-signature-type tsd-kind-class">default</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">move</span><span class="tsd-signature-symbol">:</span> <a href="data_moves_move.default.html" class="tsd-signature-type tsd-kind-class">default</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">ignoreSourceAbility</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">simulated</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">number</span><a href="#calculatestabmultiplier-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>Determine the STAB multiplier for a move used against this pokemon.</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">source</span>: <a href="field_pokemon.default.html" class="tsd-signature-type tsd-kind-class">default</a></span><div class="tsd-comment tsd-typography"><p>The attacking <a href="field_pokemon.default.html" class="tsd-kind-class"><code>Pokemon</code></a></p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">move</span>: <a href="data_moves_move.default.html" class="tsd-signature-type tsd-kind-class">default</a></span><div class="tsd-comment tsd-typography"><p>The <a href="data_moves_move.default.html" class="tsd-kind-class"><code>Move</code></a> used in the attack</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">ignoreSourceAbility</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>If <code>true</code>, ignores the attacking Pokemon's ability effects</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">simulated</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>If <code>true</code>, suppresses changes to game state during the calculation</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 STAB multiplier for the move used against this Pokemon</p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#calculatestabmultiplier">calculateStabMultiplier</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L4262">src/field/pokemon.ts:4262</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="calculatestats"><span>calculate<wbr/>Stats</span><a href="#calculatestats" 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="calculatestats-1"><span class="tsd-kind-call-signature">calculateStats</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#calculatestats-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">void</span></h4><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#calculatestats">calculateStats</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L1688">src/field/pokemon.ts:1688</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="canaddtag"><span>can<wbr/>Add<wbr/>Tag</span><a href="#canaddtag" 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="canaddtag-1"><span class="tsd-kind-call-signature">canAddTag</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">tagType</span><span class="tsd-signature-symbol">:</span> <a href="../enums/enums_battler-tag-type.BattlerTagType.html" class="tsd-signature-type tsd-kind-enum">BattlerTagType</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#canaddtag-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">tagType</span>: <a href="../enums/enums_battler-tag-type.BattlerTagType.html" class="tsd-signature-type tsd-kind-enum">BattlerTagType</a></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="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#canaddtag">canAddTag</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L4837">src/field/pokemon.ts:4837</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="canapplyability"><span>can<wbr/>Apply<wbr/>Ability</span><a href="#canapplyability" 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="canapplyability-1"><span class="tsd-kind-call-signature">canApplyAbility</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">passive</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> <span class="tsd-signature-type">boolean</span><a href="#canapplyability-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>Checks whether an ability of a pokemon can be currently applied. This should rarely be
|
||
directly called, as <a href="field_pokemon.default.html#hasability" class="tsd-kind-method"><code>hasAbility</code></a> and <a href="field_pokemon.default.html#hasabilitywithattr" class="tsd-kind-method"><code>hasAbilityWithAttr</code></a> already call this.</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">passive</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span><div class="tsd-comment tsd-typography"><p>If true, check if passive can be applied instead of non-passive</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p><code>true</code> if the ability can be applied</p>
|
||
<div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><h4 class="tsd-anchor-link" id="see">See<a href="#see" 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></h4><p><a href="field_pokemon.default.html#hasability" class="tsd-kind-method"><code>hasAbility</code></a> <a href="field_pokemon.default.html#hasabilitywithattr" class="tsd-kind-method"><code>hasAbilityWithAttr</code></a> Intended ways to check abilities in most cases</p>
|
||
</div></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#canapplyability">canApplyAbility</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L2396">src/field/pokemon.ts:2396</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="canbypassbosssegments"><span>can<wbr/>Bypass<wbr/>Boss<wbr/>Segments</span><a href="#canbypassbosssegments" 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="canbypassbosssegments-1"><span class="tsd-kind-call-signature">canBypassBossSegments</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">segmentCount</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="#canbypassbosssegments-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">segmentCount</span>: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 1</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L7643">src/field/pokemon.ts:7643</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="cansetstatus"><span>can<wbr/>Set<wbr/>Status</span><a href="#cansetstatus" 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="cansetstatus-1"><span class="tsd-kind-call-signature">canSetStatus</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">effect</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <a href="../enums/enums_status-effect.StatusEffect.html" class="tsd-signature-type tsd-kind-enum">StatusEffect</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">quiet</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">overrideStatus</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">sourcePokemon</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a href="field_pokemon.default.html" class="tsd-signature-type tsd-kind-class">default</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">ignoreField</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">boolean</span><a href="#cansetstatus-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>Checks if a status effect can be applied to the Pokemon.</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">effect</span>: <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <a href="../enums/enums_status-effect.StatusEffect.html" class="tsd-signature-type tsd-kind-enum">StatusEffect</a></span><div class="tsd-comment tsd-typography"><p>The <a href="../enums/enums_status-effect.StatusEffect.html" class="tsd-kind-enum"><code>StatusEffect</code></a> whose applicability is being checked</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">quiet</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span><div class="tsd-comment tsd-typography"><p>Whether in-battle messages should trigger or not</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">overrideStatus</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 Pokemon's current status can be overriden</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">sourcePokemon</span>: <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a href="field_pokemon.default.html" class="tsd-signature-type tsd-kind-class">default</a><span class="tsd-signature-symbol"> = null</span></span><div class="tsd-comment tsd-typography"><p>The Pokemon that is setting the status effect</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">ignoreField</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span><div class="tsd-comment tsd-typography"><p>Whether any field effects (weather, terrain, etc.) should be considered</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#cansetstatus">canSetStatus</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L5444">src/field/pokemon.ts:5444</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="changeform"><span>change<wbr/>Form</span><a href="#changeform" 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="changeform-1"><span class="tsd-kind-call-signature">changeForm</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">formChange</span><span class="tsd-signature-symbol">:</span> <a href="data_pokemon-forms.SpeciesFormChange.html" class="tsd-signature-type tsd-kind-class">SpeciesFormChange</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#changeform-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">formChange</span>: <a href="data_pokemon-forms.SpeciesFormChange.html" class="tsd-signature-type tsd-kind-class">SpeciesFormChange</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#changeform">changeForm</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L5164">src/field/pokemon.ts:5164</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="checkifplayerhasabilityofstarter"><span>check<wbr/>If<wbr/>Player<wbr/>Has<wbr/>Ability<wbr/>Of<wbr/>Starter</span><a href="#checkifplayerhasabilityofstarter" 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="checkifplayerhasabilityofstarter-1"><span class="tsd-kind-call-signature">checkIfPlayerHasAbilityOfStarter</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">ownedAbilityAttrs</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="#checkifplayerhasabilityofstarter-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>Helper function to check if the player already owns the starter data of the Pokemon's
|
||
current ability</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">ownedAbilityAttrs</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>the owned abilityAttr of this Pokemon's root form</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>true if the player already has it, false otherwise</p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#checkifplayerhasabilityofstarter">checkIfPlayerHasAbilityOfStarter</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L6376">src/field/pokemon.ts:6376</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="clearalpha"><span>clear<wbr/>Alpha</span><a href="#clearalpha" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="clearalpha-1"><span class="tsd-kind-call-signature">clearAlpha</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#clearalpha-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>Clears all alpha values associated with this Game Object.</p>
|
||
<p>Immediately sets the alpha levels back to 1 (fully opaque).</p>
|
||
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#clearalpha">clearAlpha</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17312</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="clearfusionspecies"><span>clear<wbr/>Fusion<wbr/>Species</span><a href="#clearfusionspecies" 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="clearfusionspecies-1"><span class="tsd-kind-call-signature">clearFusionSpecies</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#clearfusionspecies-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">void</span></h4><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#clearfusionspecies">clearFusionSpecies</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L3469">src/field/pokemon.ts:3469</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="clearfx"><span>clearFX</span><a href="#clearfx" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="clearfx-1"><span class="tsd-kind-call-signature">clearFX</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#clearfx-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>Removes all Pre and Post FX Controllers from this Game Object.</p>
|
||
<p>If you wish to remove a single controller, use the <code>preFX.remove(fx)</code> or <code>postFX.remove(fx)</code> methods instead.</p>
|
||
<p>If you wish to clear a single controller, use the <code>preFX.clear()</code> or <code>postFX.clear()</code> methods instead.</p>
|
||
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#clearfx">clearFX</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17707</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="clearmask"><span>clear<wbr/>Mask</span><a href="#clearmask" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="clearmask-1"><span class="tsd-kind-call-signature">clearMask</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">destroyMask</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> <span class="tsd-signature-type">this</span><a href="#clearmask-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>Clears the mask that this Game Object was using.</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">destroyMask</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>Destroy the mask before clearing it? Default false.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#clearmask">clearMask</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17532</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="clearstatus"><span>clear<wbr/>Status</span><a href="#clearstatus" 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="clearstatus-1"><span class="tsd-kind-call-signature">clearStatus</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">confusion</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">reloadAssets</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> <span class="tsd-signature-type">void</span><a href="#clearstatus-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>Performs the action of clearing a Pokemon's status</p>
|
||
<p>This is a helper to <a href="field_pokemon.default.html#resetstatus" class="tsd-kind-method"><code>resetStatus</code></a>, which should be called directly instead of this method</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">confusion</span>: <span class="tsd-signature-type">boolean</span></span></li><li><span><span class="tsd-kind-parameter">reloadAssets</span>: <span class="tsd-signature-type">boolean</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#clearstatus">clearStatus</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L5684">src/field/pokemon.ts:5684</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="copyposition"><span>copy<wbr/>Position</span><a href="#copyposition" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="copyposition-1"><span class="tsd-kind-call-signature">copyPosition</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">source</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Vector2Like</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Vector3Like</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Vector4Like</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#copyposition-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>Copies an object's coordinates to this Game Object's position.</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">source</span>: <span class="tsd-signature-type">Vector2Like</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Vector3Like</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Vector4Like</span></span><div class="tsd-comment tsd-typography"><p>An object with numeric 'x', 'y', 'z', or 'w' properties. Undefined values are not copied.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#copyposition">copyPosition</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17789</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="count"><span>count</span><a href="#count" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="count-1"><span class="tsd-kind-call-signature">count</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">property</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">value</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">startIndex</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">endIndex</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">number</span><a href="#count-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>Returns the total number of Game Objects in this Container that have a property
|
||
matching the given value.</p>
|
||
<p>For example: <code>count('visible', true)</code> would count all the elements that have their visible property set.</p>
|
||
<p>You can optionally limit the operation to the <code>startIndex</code> - <code>endIndex</code> range.</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">property</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The property to check.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The value to check.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">startIndex</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>An optional start index to search from. Default 0.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">endIndex</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>An optional end index to search up to (but not included) Default Container.length.</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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#count">count</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17071</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="createbitmapmask"><span>create<wbr/>Bitmap<wbr/>Mask</span><a href="#createbitmapmask" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="createbitmapmask-1"><span class="tsd-kind-call-signature">createBitmapMask</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#createbitmapmaskg">G</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">GameObject</span><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#createbitmapmaskt">T</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">DynamicTexture</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">maskObject</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">GameObject</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">DynamicTexture</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">x</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">y</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">texture</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">Texture</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">frame</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> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Frame</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">BitmapMask</span><a href="#createbitmapmask-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>Creates and returns a Bitmap Mask. This mask can be used by any Game Object,
|
||
including this one, or a Dynamic Texture.</p>
|
||
<p>Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.</p>
|
||
<p>To create the mask you need to pass in a reference to a renderable Game Object.
|
||
A renderable Game Object is one that uses a texture to render with, such as an
|
||
Image, Sprite, Render Texture or BitmapText.</p>
|
||
<p>If you do not provide a renderable object, and this Game Object has a texture,
|
||
it will use itself as the object. This means you can call this method to create
|
||
a Bitmap Mask from any renderable texture-based Game Object.</p>
|
||
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="createbitmapmaskg"><span class="tsd-kind-type-parameter">G</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">GameObject</span></span></li><li><span id="createbitmapmaskt"><span class="tsd-kind-type-parameter">T</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">DynamicTexture</span></span></li></ul></section><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">maskObject</span>: <span class="tsd-signature-type">GameObject</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">DynamicTexture</span></span><div class="tsd-comment tsd-typography"><p>The Game Object or Dynamic Texture that will be used as the mask. If <code>null</code> it will generate an Image Game Object using the rest of the arguments.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">x</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>If creating a Game Object, the horizontal position in the world.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">y</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>If creating a Game Object, the vertical position in the world.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">texture</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Texture</span></span><div class="tsd-comment tsd-typography"><p>If creating a Game Object, the key, or instance of the Texture it will use to render with, as stored in the Texture Manager.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">frame</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Frame</span></span><div class="tsd-comment tsd-typography"><p>If creating a Game Object, an optional frame from the Texture this Game Object is rendering with.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">BitmapMask</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#createbitmapmask">createBitmapMask</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17553</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="creategeometrymask"><span>create<wbr/>Geometry<wbr/>Mask</span><a href="#creategeometrymask" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="creategeometrymask-1"><span class="tsd-kind-call-signature">createGeometryMask</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#creategeometrymaskg">G</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">Graphics</span><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#creategeometrymasks">S</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">Shape</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">graphics</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Graphics</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Shape</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">GeometryMask</span><a href="#creategeometrymask-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>Creates and returns a Geometry Mask. This mask can be used by any Game Object,
|
||
including this one.</p>
|
||
<p>To create the mask you need to pass in a reference to a Graphics Game Object.</p>
|
||
<p>If you do not provide a graphics object, and this Game Object is an instance
|
||
of a Graphics object, then it will use itself to create the mask.</p>
|
||
<p>This means you can call this method to create a Geometry Mask from any Graphics Game Object.</p>
|
||
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="creategeometrymaskg"><span class="tsd-kind-type-parameter">G</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">Graphics</span></span></li><li><span id="creategeometrymasks"><span class="tsd-kind-type-parameter">S</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">Shape</span></span></li></ul></section><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">graphics</span>: <span class="tsd-signature-type">Graphics</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Shape</span></span><div class="tsd-comment tsd-typography"><p>A Graphics Game Object, or any kind of Shape Game Object. The geometry within it will be used as the mask.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">GeometryMask</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#creategeometrymask">createGeometryMask</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17567</li></ul></aside></div></li></ul></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">sceneOverride</span><span class="tsd-signature-symbol">?:</span> <a href="battle-scene.default.html" class="tsd-signature-type tsd-kind-class">default</a><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">sceneOverride</span>: <a href="battle-scene.default.html" class="tsd-signature-type tsd-kind-class">default</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../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="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#cry">cry</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L5188">src/field/pokemon.ts:5188</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="damage"><span>damage</span><a href="#damage" 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="damage-1"><span class="tsd-kind-call-signature">damage</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">damage</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">ignoreSegments</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">preventEndure</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">ignoreFaintPhase</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">number</span><a href="#damage-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>Called by damageAndUpdate()</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">damage</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>integer</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">ignoreSegments</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span><div class="tsd-comment tsd-typography"><p>boolean, not currently used</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">preventEndure</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span><div class="tsd-comment tsd-typography"><p>used to update damage if endure or sturdy</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">ignoreFaintPhase</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">number</span></h4><p>integer representing damage dealt</p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#damage">damage</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L7574">src/field/pokemon.ts:7574</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="damageandupdate"><span>damage<wbr/>And<wbr/>Update</span><a href="#damageandupdate" 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="damageandupdate-1"><span class="tsd-kind-call-signature">damageAndUpdate</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">damage</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">__namedParameters</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">ignoreFaintPhase</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-property">ignoreSegments</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-property">isCritical</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-property">result</span><span class="tsd-signature-symbol">?:</span> <a href="../types/field_pokemon.DamageResult.html" class="tsd-signature-type tsd-kind-type-alias">DamageResult</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">source</span><span class="tsd-signature-symbol">?:</span> <a href="field_pokemon.default.html" class="tsd-signature-type tsd-kind-class">default</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</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">number</span><a href="#damageandupdate-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>Given the damage, adds a new DamagePhase and update HP values, etc.</p>
|
||
<p>Checks for 'Indirect' HitResults to account for Endure/Reviver Seed applying correctly</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">damage</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>integer - passed to damage()</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">__namedParameters</span>: <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">ignoreFaintPhase</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-property">ignoreSegments</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-property">isCritical</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-property">result</span><span class="tsd-signature-symbol">?:</span> <a href="../types/field_pokemon.DamageResult.html" class="tsd-signature-type tsd-kind-type-alias">DamageResult</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">source</span><span class="tsd-signature-symbol">?:</span> <a href="field_pokemon.default.html" class="tsd-signature-type tsd-kind-class">default</a><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = {}</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>integer of damage done</p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#damageandupdate">damageAndUpdate</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L4759">src/field/pokemon.ts:4759</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="destroy"><span>destroy</span><a href="#destroy" 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="destroy-1"><span class="tsd-kind-call-signature">destroy</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#destroy-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>Destroys this Game Object removing it from the Display List and Update List and
|
||
severing all ties to parent resources.</p>
|
||
<p>Also removes itself from the Input Manager and Physics Manager if previously enabled.</p>
|
||
<p>Use this to remove a Game Object from your game if you don't ever plan to use it again.
|
||
As long as no reference to it exists within your own code it should become free for
|
||
garbage collection by the browser.</p>
|
||
<p>If you just want to temporarily disable an object then look at using the
|
||
Game Object Pool instead of destroying it, as destroyed objects cannot be resurrected.</p>
|
||
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#destroy">destroy</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L6346">src/field/pokemon.ts:6346</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="destroysubstitute"><span>destroy<wbr/>Substitute</span><a href="#destroysubstitute" 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="destroysubstitute-1"><span class="tsd-kind-call-signature">destroySubstitute</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#destroysubstitute-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>If this Pokemon has a Substitute on the field, removes its sprite from the field.</p>
|
||
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#destroysubstitute">destroySubstitute</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L1369">src/field/pokemon.ts:1369</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="disableinteractive"><span>disable<wbr/>Interactive</span><a href="#disableinteractive" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="disableinteractive-1"><span class="tsd-kind-call-signature">disableInteractive</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">resetCursor</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> <span class="tsd-signature-type">this</span><a href="#disableinteractive-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>If this Game Object has previously been enabled for input, this will disable it.</p>
|
||
<p>An object that is disabled for input stops processing or being considered for
|
||
input events, but can be turned back on again at any time by simply calling
|
||
<code>setInteractive()</code> with no arguments provided.</p>
|
||
<p>If want to completely remove interaction from this Game Object then use <code>removeInteractive</code> instead.</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">resetCursor</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>Should the currently active Input cursor, if any, be reset to the default cursor? Default false.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#disableinteractive">disableInteractive</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:20169</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="disablemask"><span>disable<wbr/>Mask</span><a href="#disablemask" 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="disablemask-1"><span class="tsd-kind-call-signature">disableMask</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#disablemask-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">void</span></h4><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#disablemask">disableMask</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L5890">src/field/pokemon.ts:5890</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="each"><span>each</span><a href="#each" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="each-1"><span class="tsd-kind-call-signature">each</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">context</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#each-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>Passes all Game Objects in this Container to the given callback.</p>
|
||
<p>A copy of the Container is made before passing each entry to your callback.
|
||
This protects against the callback itself modifying the Container.</p>
|
||
<p>If you know for sure that the callback will not change the size of this Container
|
||
then you can use the more performant <code>Container.iterate</code> method instead.</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">callback</span>: <span class="tsd-signature-type">Function</span></span><div class="tsd-comment tsd-typography"><p>The function to call.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">context</span>: <span class="tsd-signature-type">object</span></span><div class="tsd-comment tsd-typography"><p>Value to use as <code>this</code> when executing callback.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>Additional arguments that will be passed to the callback, after the child.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#each">each</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17229</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="emit"><span>emit</span><a href="#emit" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="emit-1"><span class="tsd-kind-call-signature">emit</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</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">symbol</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</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="#emit-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>Calls each of the listeners registered for a given event.</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">event</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">symbol</span></span><div class="tsd-comment tsd-typography"><p>The event name.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>Additional arguments that will be passed to the event handler.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#emit">emit</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:9955</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="enablemask"><span>enable<wbr/>Mask</span><a href="#enablemask" 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="enablemask-1"><span class="tsd-kind-call-signature">enableMask</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#enablemask-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">void</span></h4><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#enablemask">enableMask</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L5875">src/field/pokemon.ts:5875</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="eventnames"><span>event<wbr/>Names</span><a href="#eventnames" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="eventnames-1"><span class="tsd-kind-call-signature">eventNames</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">symbol</span>)<span class="tsd-signature-symbol">[]</span><a href="#eventnames-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>Return an array listing the events for which the emitter has registered listeners.</p>
|
||
</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">symbol</span>)<span class="tsd-signature-symbol">[]</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#eventnames">eventNames</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:9936</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="exists"><span>exists</span><a href="#exists" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="exists-1"><span class="tsd-kind-call-signature">exists</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#existst">T</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">GameObject</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">child</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="field_arena.ArenaBase.html#existst">T</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#exists-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>Returns <code>true</code> if the given Game Object is a direct child of this Container.</p>
|
||
<p>This check does not scan nested Containers.</p>
|
||
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="existst"><span class="tsd-kind-type-parameter">T</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">GameObject</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">child</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="field_arena.ArenaBase.html#existst">T</a></span><div class="tsd-comment tsd-typography"><p>The Game Object to check for within this Container.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#exists">exists</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17202</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="faintcry"><span>faint<wbr/>Cry</span><a href="#faintcry" 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="faintcry-1"><span class="tsd-kind-call-signature">faintCry</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#faintcry-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">callback</span>: <span class="tsd-signature-type">Function</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 <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#faintcry">faintCry</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L5232">src/field/pokemon.ts:5232</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="fallbackvariantcolor"><span>fallback<wbr/>Variant<wbr/>Color</span><a href="#fallbackvariantcolor" 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="fallbackvariantcolor-1"><span class="tsd-kind-call-signature">fallbackVariantColor</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">cacheKey</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">attemptedSpritePath</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">useExpSprite</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">battleSpritePath</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">optionalParams</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</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"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#fallbackvariantcolor-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>Gracefully handle errors loading a variant sprite. Log if it fails and attempt to fall back on
|
||
non-experimental sprites before giving up.</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">cacheKey</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>the cache key for the variant color sprite</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">attemptedSpritePath</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>the sprite path that failed to load</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">useExpSprite</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>was the attempted sprite experimental</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">battleSpritePath</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>the filename of the sprite</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">optionalParams</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>any additional params to log</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#fallbackvariantcolor">fallbackVariantColor</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L949">src/field/pokemon.ts:949</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="fieldsetup"><span>field<wbr/>Setup</span><a href="#fieldsetup" 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="fieldsetup-1"><span class="tsd-kind-call-signature">fieldSetup</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">resetSummonData</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> <span class="tsd-signature-type">void</span><a href="#fieldsetup-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>Performs miscellaneous setup for when the Pokemon is summoned, like generating the substitute sprite</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">resetSummonData</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>Whether to additionally reset the Pokemon's summon data (default: <code>false</code>)</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#fieldsetup">fieldSetup</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L5727">src/field/pokemon.ts:5727</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="findandremovetags"><span>find<wbr/>And<wbr/>Remove<wbr/>Tags</span><a href="#findandremovetags" 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="findandremovetags-1"><span class="tsd-kind-call-signature">findAndRemoveTags</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">tagFilter</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">tag</span><span class="tsd-signature-symbol">:</span> <a href="data_battler-tags.BattlerTag.html" class="tsd-signature-type tsd-kind-class">BattlerTag</a><span class="tsd-signature-symbol">)</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> <span class="tsd-signature-type">void</span><a href="#findandremovetags-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>Find and remove all <a href="data_battler-tags.BattlerTag.html" class="tsd-kind-class"><code>BattlerTag</code></a>s matching the given function.</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">tagFilter</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">tag</span><span class="tsd-signature-symbol">:</span> <a href="data_battler-tags.BattlerTag.html" class="tsd-signature-type tsd-kind-class">BattlerTag</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>a function dictating which tags to remove</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#findandremovetags">findAndRemoveTags</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L4996">src/field/pokemon.ts:4996</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="findtag"><span>find<wbr/>Tag</span><a href="#findtag" 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="findtag-1"><span class="tsd-kind-call-signature">findTag</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">tagFilter</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">tag</span><span class="tsd-signature-symbol">:</span> <a href="data_battler-tags.BattlerTag.html" class="tsd-signature-type tsd-kind-class">BattlerTag</a><span class="tsd-signature-symbol">)</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> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <a href="data_battler-tags.BattlerTag.html" class="tsd-signature-type tsd-kind-class">BattlerTag</a><a href="#findtag-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">tagFilter</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">tag</span><span class="tsd-signature-symbol">:</span> <a href="data_battler-tags.BattlerTag.html" class="tsd-signature-type tsd-kind-class">BattlerTag</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">boolean</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <a href="data_battler-tags.BattlerTag.html" class="tsd-signature-type tsd-kind-class">BattlerTag</a></h4><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#findtag">findTag</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L4931">src/field/pokemon.ts:4931</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="findtags"><span>find<wbr/>Tags</span><a href="#findtags" 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="findtags-1"><span class="tsd-kind-call-signature">findTags</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">tagFilter</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">tag</span><span class="tsd-signature-symbol">:</span> <a href="data_battler-tags.BattlerTag.html" class="tsd-signature-type tsd-kind-class">BattlerTag</a><span class="tsd-signature-symbol">)</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="data_battler-tags.BattlerTag.html" class="tsd-signature-type tsd-kind-class">BattlerTag</a><span class="tsd-signature-symbol">[]</span><a href="#findtags-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">tagFilter</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">tag</span><span class="tsd-signature-symbol">:</span> <a href="data_battler-tags.BattlerTag.html" class="tsd-signature-type tsd-kind-class">BattlerTag</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">boolean</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="data_battler-tags.BattlerTag.html" class="tsd-signature-type tsd-kind-class">BattlerTag</a><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#findtags">findTags</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L4935">src/field/pokemon.ts:4935</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="generateandpopulatemoveset"><span>generate<wbr/>And<wbr/>Populate<wbr/>Moveset</span><a href="#generateandpopulatemoveset" 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="generateandpopulatemoveset-1"><span class="tsd-kind-call-signature">generateAndPopulateMoveset</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><a href="#generateandpopulatemoveset-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>Generates a semi-random moveset for a Pokemon</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></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#generateandpopulatemoveset">generateAndPopulateMoveset</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L7192">src/field/pokemon.ts:7192</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="generatefusionspecies"><span>generate<wbr/>Fusion<wbr/>Species</span><a href="#generatefusionspecies" 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="generatefusionspecies-1"><span class="tsd-kind-call-signature">generateFusionSpecies</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> <span class="tsd-signature-type">void</span><a href="#generatefusionspecies-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">forStarter</span>: <span class="tsd-signature-type">boolean</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 <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#generatefusionspecies">generateFusionSpecies</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L3382">src/field/pokemon.ts:3382</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="generategender"><span>generate<wbr/>Gender</span><a href="#generategender" 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="generategender-1"><span class="tsd-kind-call-signature">generateGender</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#generategender-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">void</span></h4><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#generategender">generateGender</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L1849">src/field/pokemon.ts:1849</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="generatename"><span>generate<wbr/>Name</span><a href="#generatename" 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="generatename-1"><span class="tsd-kind-call-signature">generateName</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#generatename-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>Sets the Pokemon's name. Only called when loading a Pokemon so this function needs to be called when
|
||
initializing hardcoded Pokemon or else it will not display the form index name properly.</p>
|
||
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><p>n/a</p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#generatename">generateName</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L709">src/field/pokemon.ts:709</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="generatenature"><span>generate<wbr/>Nature</span><a href="#generatenature" 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="generatenature-1"><span class="tsd-kind-call-signature">generateNature</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">naturePool</span><span class="tsd-signature-symbol">?:</span> <a href="../enums/enums_nature.Nature.html" class="tsd-signature-type tsd-kind-enum">Nature</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#generatenature-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">naturePool</span>: <a href="../enums/enums_nature.Nature.html" class="tsd-signature-type tsd-kind-enum">Nature</a><span class="tsd-signature-symbol">[]</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 <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#generatenature">generateNature</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L1822">src/field/pokemon.ts:1822</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><h3 class="tsd-anchor-link" id="generateshinyvariant"><code class="tsd-tag">Protected</code><span>generate<wbr/>Shiny<wbr/>Variant</span><a href="#generateshinyvariant" 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-protected tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="generateshinyvariant-1"><span class="tsd-kind-call-signature">generateShinyVariant</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="../types/sprites_variant.Variant.html" class="tsd-signature-type tsd-kind-type-alias">Variant</a><a href="#generateshinyvariant-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>Generates a shiny variant</p>
|
||
</div><h4 class="tsd-returns-title">Returns <a href="../types/sprites_variant.Variant.html" class="tsd-signature-type tsd-kind-type-alias">Variant</a></h4><p><code>0-2</code>, with the following probabilities:</p>
|
||
<ul>
|
||
<li>Has a 10% chance of returning <code>2</code> (epic variant)</li>
|
||
<li>Has a 30% chance of returning <code>1</code> (rare variant)</li>
|
||
<li>Has a 60% chance of returning <code>0</code> (basic shiny)</li>
|
||
</ul>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#generateshinyvariant">generateShinyVariant</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L3309">src/field/pokemon.ts:3309</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">ignoreOverride</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="data_abilities_ability-class.Ability.html" class="tsd-signature-type tsd-kind-class">Ability</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>Gets the non-passive ability of the pokemon. This accounts for fusions and ability changing effects.
|
||
This should rarely be called, most of the time <a href="field_pokemon.default.html#hasability" class="tsd-kind-method"><code>hasAbility</code></a> or <a href="field_pokemon.default.html#hasabilitywithattr" class="tsd-kind-method"><code>hasAbilityWithAttr</code></a> are better used as
|
||
those check both the passive and non-passive abilities and account for ability suppression.</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">ignoreOverride</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span><div class="tsd-comment tsd-typography"><p>If <code>true</code>, ignore ability changing effects; Default: <code>false</code></p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="data_abilities_ability-class.Ability.html" class="tsd-signature-type tsd-kind-class">Ability</a></h4><p>The non-passive <a href="data_abilities_ability-class.Ability.html" class="tsd-kind-class"><code>Ability</code></a> of the pokemon</p>
|
||
<div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><h4 class="tsd-anchor-link" id="see-1">See<a href="#see-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></h4><p><a href="field_pokemon.default.html#hasability" class="tsd-kind-method"><code>hasAbility</code></a> <a href="field_pokemon.default.html#hasabilitywithattr" class="tsd-kind-method"><code>hasAbilityWithAttr</code></a> Intended ways to check abilities in most cases</p>
|
||
</div></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getability">getAbility</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L2233">src/field/pokemon.ts:2233</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getabilityattrs"><span>get<wbr/>Ability<wbr/>Attrs</span><a href="#getabilityattrs" 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="getabilityattrs-1"><span class="tsd-kind-call-signature">getAbilityAttrs</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#getabilityattrst">T</a> <span class="tsd-signature-keyword">extends</span> <a href="data_abilities_ab-attrs_ab-attr.AbAttr.html" class="tsd-signature-type tsd-kind-class">AbAttr</a> <span class="tsd-signature-symbol">=</span> <a href="data_abilities_ab-attrs_ab-attr.AbAttr.html" class="tsd-signature-type tsd-kind-class">AbAttr</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">attrType</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">new</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <a class="tsd-signature-type tsd-kind-type-parameter" href="field_pokemon.PlayerPokemon.html#getabilityattrst">T</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">canApply</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">ignoreOverride</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 class="tsd-signature-type tsd-kind-type-parameter" href="field_pokemon.PlayerPokemon.html#getabilityattrst">T</a><span class="tsd-signature-symbol">[]</span><a href="#getabilityattrs-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 a list of all instances of a given ability attribute among abilities this pokemon has.
|
||
Accounts for all the various effects which can affect whether an ability will be present or
|
||
in effect, and both passive and non-passive.</p>
|
||
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="getabilityattrst"><span class="tsd-kind-type-parameter">T</span> <span class="tsd-signature-keyword">extends</span> <a href="data_abilities_ab-attrs_ab-attr.AbAttr.html" class="tsd-signature-type tsd-kind-class">AbAttr</a> = <a href="data_abilities_ab-attrs_ab-attr.AbAttr.html" class="tsd-signature-type tsd-kind-class">AbAttr</a></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">attrType</span>: <span class="tsd-signature-keyword">new</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <a class="tsd-signature-type tsd-kind-type-parameter" href="field_pokemon.PlayerPokemon.html#getabilityattrst">T</a></span><div class="tsd-comment tsd-typography"><p><a href="data_abilities_ab-attrs_ab-attr.AbAttr.html" class="tsd-kind-class"><code>AbAttr</code></a> The ability attribute to check for.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">canApply</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></span><div class="tsd-comment tsd-typography"><p>Whether to check if the ability is currently active; Default <code>true</code></p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">ignoreOverride</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span><div class="tsd-comment tsd-typography"><p>Whether to ignore ability changing effects; Default <code>false</code></p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="field_pokemon.PlayerPokemon.html#getabilityattrst">T</a><span class="tsd-signature-symbol">[]</span></h4><p>An array of all the ability attributes on this ability.</p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getabilityattrs">getAbilityAttrs</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L2304">src/field/pokemon.ts:2304</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getaccuracymultiplier"><span>get<wbr/>Accuracy<wbr/>Multiplier</span><a href="#getaccuracymultiplier" 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="getaccuracymultiplier-1"><span class="tsd-kind-call-signature">getAccuracyMultiplier</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">target</span><span class="tsd-signature-symbol">:</span> <a href="field_pokemon.default.html" class="tsd-signature-type tsd-kind-class">default</a><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">sourceMove</span><span class="tsd-signature-symbol">:</span> <a href="data_moves_move.default.html" class="tsd-signature-type tsd-kind-class">default</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><a href="#getaccuracymultiplier-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>Calculates the accuracy multiplier of the user against a target.</p>
|
||
<p>This method considers various factors such as the user's accuracy level, the target's evasion level,
|
||
abilities, and modifiers to compute the final accuracy multiplier.</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">target</span>: <a href="field_pokemon.default.html" class="tsd-signature-type tsd-kind-class">default</a></span><div class="tsd-comment tsd-typography"><p><a href="field_pokemon.default.html" class="tsd-kind-class"><code>Pokemon</code></a> - The target Pokémon against which the move is used.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">sourceMove</span>: <a href="data_moves_move.default.html" class="tsd-signature-type tsd-kind-class">default</a></span><div class="tsd-comment tsd-typography"><p><a href="data_moves_move.default.html" class="tsd-kind-class"><code>Move</code></a> - The move being used by the user.</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 calculated accuracy multiplier.</p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getaccuracymultiplier">getAccuracyMultiplier</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L4071">src/field/pokemon.ts:4071</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="getall"><span>get<wbr/>All</span><a href="#getall" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="getall-1"><span class="tsd-kind-call-signature">getAll</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#getallt">T</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">GameObject</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">property</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">value</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">startIndex</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">endIndex</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> <a class="tsd-signature-type tsd-kind-type-parameter" href="field_arena.ArenaBase.html#getallt">T</a><span class="tsd-signature-symbol">[]</span><a href="#getall-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>Returns all Game Objects in this Container.</p>
|
||
<p>You can optionally specify a matching criteria using the <code>property</code> and <code>value</code> arguments.</p>
|
||
<p>For example: <code>getAll('body')</code> would return only Game Objects that have a body property.</p>
|
||
<p>You can also specify a value to compare the property to:</p>
|
||
<p><code>getAll('visible', true)</code> would return only Game Objects that have their visible property set to <code>true</code>.</p>
|
||
<p>Optionally you can specify a start and end index. For example if this Container had 100 Game Objects,
|
||
and you set <code>startIndex</code> to 0 and <code>endIndex</code> to 50, it would return matches from only
|
||
the first 50 Game Objects.</p>
|
||
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="getallt"><span class="tsd-kind-type-parameter">T</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">GameObject</span></span></li></ul></section><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">property</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The property to test on each Game Object in the Container.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>If property is set then the <code>property</code> must strictly equal this value to be included in the results.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">startIndex</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>An optional start index to search from. Default 0.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">endIndex</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>An optional end index to search up to (but not included) Default Container.length.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="field_arena.ArenaBase.html#getallt">T</a><span class="tsd-signature-symbol">[]</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getall">getAll</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17057</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getalliedfield"><span>get<wbr/>Allied<wbr/>Field</span><a href="#getalliedfield" 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="getalliedfield-1"><span class="tsd-kind-call-signature">getAlliedField</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="field_pokemon.default.html" class="tsd-signature-type tsd-kind-class">default</a><span class="tsd-signature-symbol">[]</span><a href="#getalliedfield-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 Pokémon on the allied field.</p>
|
||
</div><h4 class="tsd-returns-title">Returns <a href="field_pokemon.default.html" class="tsd-signature-type tsd-kind-class">default</a><span class="tsd-signature-symbol">[]</span></h4><p>An array of Pokémon on the allied field.</p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getalliedfield">getAlliedField</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L3978">src/field/pokemon.ts:3978</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getally"><span>get<wbr/>Ally</span><a href="#getally" 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="getally-1"><span class="tsd-kind-call-signature">getAlly</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <a href="field_pokemon.default.html" class="tsd-signature-type tsd-kind-class">default</a><a href="#getally-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">undefined</span> <span class="tsd-signature-symbol">|</span> <a href="field_pokemon.default.html" class="tsd-signature-type tsd-kind-class">default</a></h4><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getally">getAlly</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L3965">src/field/pokemon.ts:3965</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="getat"><span>get<wbr/>At</span><a href="#getat" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="getat-1"><span class="tsd-kind-call-signature">getAt</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#getatt">T</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">GameObject</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">index</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 class="tsd-signature-type tsd-kind-type-parameter" href="field_arena.ArenaBase.html#getatt">T</a><a href="#getat-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>Returns the Game Object at the given position in this Container.</p>
|
||
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="getatt"><span class="tsd-kind-type-parameter">T</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">GameObject</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">index</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The position to get the Game Object from.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="field_arena.ArenaBase.html#getatt">T</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getat">getAt</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:16992</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getattackdamage"><span>get<wbr/>Attack<wbr/>Damage</span><a href="#getattackdamage" 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="getattackdamage-1"><span class="tsd-kind-call-signature">getAttackDamage</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">__namedParameters</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">getAttackDamageParams</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/field_pokemon.DamageCalculationResult.html" class="tsd-signature-type tsd-kind-interface">DamageCalculationResult</a><a href="#getattackdamage-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>Calculates the damage of an attack made by another Pokemon against this Pokemon</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">__namedParameters</span>: <span class="tsd-signature-type">getAttackDamageParams</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../interfaces/field_pokemon.DamageCalculationResult.html" class="tsd-signature-type tsd-kind-interface">DamageCalculationResult</a></h4><p>The <a href="../interfaces/field_pokemon.DamageCalculationResult.html" class="tsd-kind-interface"><code>DamageCalculationResult</code></a></p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getattackdamage">getAttackDamage</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L4321">src/field/pokemon.ts:4321</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getattacktypeeffectiveness"><span>get<wbr/>Attack<wbr/>Type<wbr/>Effectiveness</span><a href="#getattacktypeeffectiveness" 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="getattacktypeeffectiveness-1"><span class="tsd-kind-call-signature">getAttackTypeEffectiveness</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">moveType</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">source</span><span class="tsd-signature-symbol">?:</span> <a href="field_pokemon.default.html" class="tsd-signature-type tsd-kind-class">default</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">ignoreStrongWinds</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">simulated</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">move</span><span class="tsd-signature-symbol">?:</span> <a href="data_moves_move.default.html" class="tsd-signature-type tsd-kind-class">default</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">useIllusion</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="../types/data_type.TypeDamageMultiplier.html" class="tsd-signature-type tsd-kind-type-alias">TypeDamageMultiplier</a><a href="#getattacktypeeffectiveness-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>Calculates the move's type effectiveness multiplier based on the target's type/s.</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">moveType</span>: <a href="../enums/enums_pokemon-type.PokemonType.html" class="tsd-signature-type tsd-kind-enum">PokemonType</a></span><div class="tsd-comment tsd-typography"><p><a href="../enums/enums_pokemon-type.PokemonType.html" class="tsd-kind-enum"><code>PokemonType</code></a> the type of the move being used</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">source</span>: <a href="field_pokemon.default.html" class="tsd-signature-type tsd-kind-class">default</a></span><div class="tsd-comment tsd-typography"><p><a href="field_pokemon.default.html" class="tsd-kind-class"><code>Pokemon</code></a> the Pokemon using the move</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">ignoreStrongWinds</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span><div class="tsd-comment tsd-typography"><p>whether or not this ignores strong winds (anticipation, forewarn, stealth rocks)</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">simulated</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></span><div class="tsd-comment tsd-typography"><p>tag to only apply the strong winds effect message when the move is used</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">move</span>: <a href="data_moves_move.default.html" class="tsd-signature-type tsd-kind-class">default</a></span><div class="tsd-comment tsd-typography"><p>(optional) the move whose type effectiveness is to be checked. Used for applying <a href="data_moves_move.VariableMoveTypeChartAttr.html" class="tsd-kind-class"><code>VariableMoveTypeChartAttr</code></a></p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">useIllusion</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span><div class="tsd-comment tsd-typography"><p>Whether we want the attack type effectiveness on the illusion or not</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../types/data_type.TypeDamageMultiplier.html" class="tsd-signature-type tsd-kind-type-alias">TypeDamageMultiplier</a></h4><p>a multiplier for the type effectiveness</p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getattacktypeeffectiveness">getAttackTypeEffectiveness</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L2810">src/field/pokemon.ts:2810</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getbasedamage"><span>get<wbr/>Base<wbr/>Damage</span><a href="#getbasedamage" 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="getbasedamage-1"><span class="tsd-kind-call-signature">getBaseDamage</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">__namedParameters</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">getBaseDamageParams</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><a href="#getbasedamage-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>Calculates the base damage of the given move against this Pokemon when attacked by the given source.
|
||
Used during damage calculation and for Shell Side Arm's forecasting effect.</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">__namedParameters</span>: <span class="tsd-signature-type">getBaseDamageParams</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>The move's base damage against this Pokemon when used by the source Pokemon.</p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getbasedamage">getBaseDamage</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L4174">src/field/pokemon.ts:4174</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getbasevariant"><span>get<wbr/>Base<wbr/>Variant</span><a href="#getbasevariant" 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="getbasevariant-1"><span class="tsd-kind-call-signature">getBaseVariant</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">doubleShiny</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/sprites_variant.Variant.html" class="tsd-signature-type tsd-kind-type-alias">Variant</a><a href="#getbasevariant-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">doubleShiny</span>: <span class="tsd-signature-type">boolean</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../types/sprites_variant.Variant.html" class="tsd-signature-type tsd-kind-type-alias">Variant</a></h4><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getbasevariant">getBaseVariant</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L1941">src/field/pokemon.ts:1941</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getbattleinfo"><span>get<wbr/>Battle<wbr/>Info</span><a href="#getbattleinfo" 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="getbattleinfo-1"><span class="tsd-kind-call-signature">getBattleInfo</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="ui_battle-info.default.html" class="tsd-signature-type tsd-kind-class">default</a><a href="#getbattleinfo-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="ui_battle-info.default.html" class="tsd-signature-type tsd-kind-class">default</a></h4><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getbattleinfo">getBattleInfo</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L6352">src/field/pokemon.ts:6352</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getbattlerindex"><span>get<wbr/>Battler<wbr/>Index</span><a href="#getbattlerindex" 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="getbattlerindex-1"><span class="tsd-kind-call-signature">getBattlerIndex</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="../enums/battle.BattlerIndex.html" class="tsd-signature-type tsd-kind-enum">BattlerIndex</a><a href="#getbattlerindex-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/battle.BattlerIndex.html" class="tsd-signature-type tsd-kind-enum">BattlerIndex</a></h4><aside class="tsd-sources"><p>Overrides <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getbattlerindex">getBattlerIndex</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L7720">src/field/pokemon.ts:7720</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getbattlespriteatlaspath"><span>get<wbr/>Battle<wbr/>Sprite<wbr/>Atlas<wbr/>Path</span><a href="#getbattlespriteatlaspath" 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="getbattlespriteatlaspath-1"><span class="tsd-kind-call-signature">getBattleSpriteAtlasPath</span><span class="tsd-signature-symbol">(</span><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> <span class="tsd-kind-parameter">ignoreOverride</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> <span class="tsd-signature-type">string</span><a href="#getbattlespriteatlaspath-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">back</span>: <span class="tsd-signature-type">boolean</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">ignoreOverride</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="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getbattlespriteatlaspath">getBattleSpriteAtlasPath</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L1035">src/field/pokemon.ts:1035</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getbattlespriteid"><span>get<wbr/>Battle<wbr/>Sprite<wbr/>Id</span><a href="#getbattlespriteid" 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="getbattlespriteid-1"><span class="tsd-kind-call-signature">getBattleSpriteId</span><span class="tsd-signature-symbol">(</span><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> <span class="tsd-kind-parameter">ignoreOverride</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> <span class="tsd-signature-type">string</span><a href="#getbattlespriteid-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">back</span>: <span class="tsd-signature-type">boolean</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">ignoreOverride</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="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getbattlespriteid">getBattleSpriteId</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L1053">src/field/pokemon.ts:1053</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getbattlespritekey"><span>get<wbr/>Battle<wbr/>Sprite<wbr/>Key</span><a href="#getbattlespritekey" 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="getbattlespritekey-1"><span class="tsd-kind-call-signature">getBattleSpriteKey</span><span class="tsd-signature-symbol">(</span><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> <span class="tsd-kind-parameter">ignoreOverride</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> <span class="tsd-signature-type">string</span><a href="#getbattlespritekey-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">back</span>: <span class="tsd-signature-type">boolean</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">ignoreOverride</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="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getbattlespritekey">getBattleSpriteKey</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L1078">src/field/pokemon.ts:1078</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getbosssegmentindex"><span>get<wbr/>Boss<wbr/>Segment<wbr/>Index</span><a href="#getbosssegmentindex" 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="getbosssegmentindex-1"><span class="tsd-kind-call-signature">getBossSegmentIndex</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><a href="#getbosssegmentindex-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"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L7561">src/field/pokemon.ts:7561</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="getbounds"><span>get<wbr/>Bounds</span><a href="#getbounds" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="getbounds-1"><span class="tsd-kind-call-signature">getBounds</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">output</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Rectangle</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Rectangle</span><a href="#getbounds-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 bounds of this Container. It works by iterating all children of the Container,
|
||
getting their respective bounds, and then working out a min-max rectangle from that.
|
||
It does not factor in if the children render or not, all are included.</p>
|
||
<p>Some children are unable to return their bounds, such as Graphics objects, in which case
|
||
they are skipped.</p>
|
||
<p>Depending on the quantity of children in this Container it could be a really expensive call,
|
||
so cache it and only poll it as needed.</p>
|
||
<p>The values are stored and returned in a Rectangle object.</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">output</span>: <span class="tsd-signature-type">Rectangle</span></span><div class="tsd-comment tsd-typography"><p>A Geom.Rectangle object to store the values in. If not provided a new Rectangle will be created.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Rectangle</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getbounds">getBounds</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:16952</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="getboundstransformmatrix"><span>get<wbr/>Bounds<wbr/>Transform<wbr/>Matrix</span><a href="#getboundstransformmatrix" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="getboundstransformmatrix-1"><span class="tsd-kind-call-signature">getBoundsTransformMatrix</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">TransformMatrix</span><a href="#getboundstransformmatrix-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>Returns the world transform matrix as used for Bounds checks.</p>
|
||
<p>The returned matrix is temporal and shouldn't be stored.</p>
|
||
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">TransformMatrix</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getboundstransformmatrix">getBoundsTransformMatrix</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:16967</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="getbyname"><span>get<wbr/>By<wbr/>Name</span><a href="#getbyname" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="getbyname-1"><span class="tsd-kind-call-signature">getByName</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#getbynamet">T</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">GameObject</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="field_arena.ArenaBase.html#getbynamet">T</a><a href="#getbyname-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>Searches for the first instance of a child with its <code>name</code> property matching the given argument.
|
||
Should more than one child have the same name only the first is returned.</p>
|
||
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="getbynamet"><span class="tsd-kind-type-parameter">T</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">GameObject</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The name to search for.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="field_arena.ArenaBase.html#getbynamet">T</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getbyname">getByName</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17013</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getcriticalhitresult"><span>get<wbr/>Critical<wbr/>Hit<wbr/>Result</span><a href="#getcriticalhitresult" 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="getcriticalhitresult-1"><span class="tsd-kind-call-signature">getCriticalHitResult</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">source</span><span class="tsd-signature-symbol">:</span> <a href="field_pokemon.default.html" class="tsd-signature-type tsd-kind-class">default</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">move</span><span class="tsd-signature-symbol">:</span> <a href="data_moves_move.default.html" class="tsd-signature-type tsd-kind-class">default</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">simulated</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">boolean</span><a href="#getcriticalhitresult-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>Calculate whether the given move critically hits this pokemon</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">source</span>: <a href="field_pokemon.default.html" class="tsd-signature-type tsd-kind-class">default</a></span><div class="tsd-comment tsd-typography"><p>The <a href="field_pokemon.default.html" class="tsd-kind-class"><code>Pokemon</code></a> using the move</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">move</span>: <a href="data_moves_move.default.html" class="tsd-signature-type tsd-kind-class">default</a></span><div class="tsd-comment tsd-typography"><p>The <a href="data_moves_move.default.html" class="tsd-kind-class"><code>Move</code></a> being used</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">simulated</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></span><div class="tsd-comment tsd-typography"><p>If <code>true</code>, suppresses changes to game state during calculation (defaults to <code>true</code>)</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>whether the move critically hits the pokemon</p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getcriticalhitresult">getCriticalHitResult</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L4660">src/field/pokemon.ts:4660</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getcritstage"><span>get<wbr/>Crit<wbr/>Stage</span><a href="#getcritstage" 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="getcritstage-1"><span class="tsd-kind-call-signature">getCritStage</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">source</span><span class="tsd-signature-symbol">:</span> <a href="field_pokemon.default.html" class="tsd-signature-type tsd-kind-class">default</a><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">move</span><span class="tsd-signature-symbol">:</span> <a href="data_moves_move.default.html" class="tsd-signature-type tsd-kind-class">default</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><a href="#getcritstage-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>Calculate the critical-hit stage of a move used against this pokemon by
|
||
the given source</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">source</span>: <a href="field_pokemon.default.html" class="tsd-signature-type tsd-kind-class">default</a></span><div class="tsd-comment tsd-typography"><p>The <a href="field_pokemon.default.html" class="tsd-kind-class"><code>Pokemon</code></a> using the move</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">move</span>: <a href="data_moves_move.default.html" class="tsd-signature-type tsd-kind-class">default</a></span><div class="tsd-comment tsd-typography"><p>The <a href="data_moves_move.default.html" class="tsd-kind-class"><code>Move</code></a> being used</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 final critical-hit stage value</p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getcritstage">getCritStage</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L1512">src/field/pokemon.ts:1512</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="getdata"><span>get<wbr/>Data</span><a href="#getdata" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="getdata-1"><span class="tsd-kind-call-signature">getData</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</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">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><a href="#getdata-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>Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.</p>
|
||
<p>You can also access values via the <code>values</code> object. For example, if you had a key called <code>gold</code> you can do either:</p>
|
||
<pre><code class="javascript"><span class="hl-2">sprite</span><span class="hl-1">.</span><span class="hl-6">getData</span><span class="hl-1">(</span><span class="hl-7">'gold'</span><span class="hl-1">);</span>
|
||
</code><button type="button">Copy</button></pre>
|
||
|
||
<p>Or access the value directly:</p>
|
||
<pre><code class="javascript"><span class="hl-2">sprite</span><span class="hl-1">.</span><span class="hl-2">data</span><span class="hl-1">.</span><span class="hl-2">values</span><span class="hl-1">.</span><span class="hl-2">gold</span><span class="hl-1">;</span>
|
||
</code><button type="button">Copy</button></pre>
|
||
|
||
<p>You can also pass in an array of keys, in which case an array of values will be returned:</p>
|
||
<pre><code class="javascript"><span class="hl-2">sprite</span><span class="hl-1">.</span><span class="hl-6">getData</span><span class="hl-1">([ </span><span class="hl-7">'gold'</span><span class="hl-1">, </span><span class="hl-7">'armor'</span><span class="hl-1">, </span><span class="hl-7">'health'</span><span class="hl-1"> ]);</span>
|
||
</code><button type="button">Copy</button></pre>
|
||
|
||
<p>This approach is useful for destructuring arrays in ES6.</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">key</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>The key of the value to retrieve, or an array of keys.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getdata">getData</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:20139</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getdexattr"><span>get<wbr/>Dex<wbr/>Attr</span><a href="#getdexattr" 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="getdexattr-1"><span class="tsd-kind-call-signature">getDexAttr</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">bigint</span><a href="#getdexattr-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">bigint</span></h4><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getdexattr">getDexAttr</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L690">src/field/pokemon.ts:690</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="getdisplaylist"><span>get<wbr/>Display<wbr/>List</span><a href="#getdisplaylist" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="getdisplaylist-1"><span class="tsd-kind-call-signature">getDisplayList</span><span class="tsd-signature-symbol">()</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">GameObject</span><span class="tsd-signature-symbol">[]</span><a href="#getdisplaylist-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>Returns a reference to the underlying display list <em>array</em> that contains this Game Object,
|
||
which will be either the Scene's Display List or the internal list belonging
|
||
to its parent Container, if it has one.</p>
|
||
<p>If this Game Object is not on a display list or in a container, it will return <code>null</code>.</p>
|
||
<p>You should be very careful with this method, and understand that it returns a direct reference to the
|
||
internal array used by the Display List. Mutating this array directly can cause all kinds of subtle
|
||
and difficult to debug issues in your game.</p>
|
||
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">GameObject</span><span class="tsd-signature-symbol">[]</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getdisplaylist">getDisplayList</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:20309</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="geteffectivestat"><span>get<wbr/>Effective<wbr/>Stat</span><a href="#geteffectivestat" 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="geteffectivestat-1"><span class="tsd-kind-call-signature">getEffectiveStat</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">stat</span><span class="tsd-signature-symbol">:</span> <a href="../enums/enums_stat.Stat.html#atk" class="tsd-signature-type tsd-kind-enum-member">ATK</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/enums_stat.Stat.html#def" class="tsd-signature-type tsd-kind-enum-member">DEF</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/enums_stat.Stat.html#spatk" class="tsd-signature-type tsd-kind-enum-member">SPATK</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/enums_stat.Stat.html#spdef" class="tsd-signature-type tsd-kind-enum-member">SPDEF</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/enums_stat.Stat.html#spd" class="tsd-signature-type tsd-kind-enum-member">SPD</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">opponent</span><span class="tsd-signature-symbol">?:</span> <a href="field_pokemon.default.html" class="tsd-signature-type tsd-kind-class">default</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">move</span><span class="tsd-signature-symbol">?:</span> <a href="data_moves_move.default.html" class="tsd-signature-type tsd-kind-class">default</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">ignoreAbility</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">ignoreOppAbility</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">ignoreAllyAbility</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">isCritical</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">simulated</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">ignoreHeldItems</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">number</span><a href="#geteffectivestat-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>Calculates and retrieves the final value of a stat considering any held
|
||
items, move effects, opponent abilities, and whether there was a critical
|
||
hit.</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#atk" class="tsd-signature-type tsd-kind-enum-member">ATK</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/enums_stat.Stat.html#def" class="tsd-signature-type tsd-kind-enum-member">DEF</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/enums_stat.Stat.html#spatk" class="tsd-signature-type tsd-kind-enum-member">SPATK</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/enums_stat.Stat.html#spdef" class="tsd-signature-type tsd-kind-enum-member">SPDEF</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/enums_stat.Stat.html#spd" class="tsd-signature-type tsd-kind-enum-member">SPD</a></span><div class="tsd-comment tsd-typography"><p>the desired <a href="../types/enums_stat.EffectiveStat.html" class="tsd-kind-type-alias"><code>EffectiveStat</code></a></p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">opponent</span>: <a href="field_pokemon.default.html" class="tsd-signature-type tsd-kind-class">default</a></span><div class="tsd-comment tsd-typography"><p>the target <a href="field_pokemon.default.html" class="tsd-kind-class"><code>Pokemon</code></a></p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">move</span>: <a href="data_moves_move.default.html" class="tsd-signature-type tsd-kind-class">default</a></span><div class="tsd-comment tsd-typography"><p>the <a href="data_moves_move.default.html" class="tsd-kind-class"><code>Move</code></a> being used</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">ignoreAbility</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span><div class="tsd-comment tsd-typography"><p>determines whether this Pokemon's abilities should be ignored during the stat calculation</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">ignoreOppAbility</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span><div class="tsd-comment tsd-typography"><p>during an attack, determines whether the opposing Pokemon's abilities should be ignored during the stat calculation.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">ignoreAllyAbility</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span><div class="tsd-comment tsd-typography"><p>during an attack, determines whether the ally Pokemon's abilities should be ignored during the stat calculation.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">isCritical</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span><div class="tsd-comment tsd-typography"><p>determines whether a critical hit has occurred or not (<code>false</code> by default)</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">simulated</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></span><div class="tsd-comment tsd-typography"><p>if <code>true</code>, nullifies any effects that produce any changes to game state from triggering</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">ignoreHeldItems</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span><div class="tsd-comment tsd-typography"><p>determines whether this Pokemon's held items should be ignored during the stat calculation, default <code>false</code></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 final in-battle value of a stat</p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#geteffectivestat">getEffectiveStat</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L1561">src/field/pokemon.ts:1561</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="geteggmoves"><span>get<wbr/>Egg<wbr/>Moves</span><a href="#geteggmoves" 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="geteggmoves-1"><span class="tsd-kind-call-signature">getEggMoves</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <a href="../enums/enums_moves.Moves.html" class="tsd-signature-type tsd-kind-enum">Moves</a><span class="tsd-signature-symbol">[]</span><a href="#geteggmoves-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>Get a list of all egg moves</p>
|
||
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <a href="../enums/enums_moves.Moves.html" class="tsd-signature-type tsd-kind-enum">Moves</a><span class="tsd-signature-symbol">[]</span></h4><p>list of egg moves</p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#geteggmoves">getEggMoves</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L3185">src/field/pokemon.ts:3185</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getevolution"><span>get<wbr/>Evolution</span><a href="#getevolution" 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="getevolution-1"><span class="tsd-kind-call-signature">getEvolution</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a href="data_balance_pokemon-evolutions.SpeciesFormEvolution.html" class="tsd-signature-type tsd-kind-class">SpeciesFormEvolution</a><a href="#getevolution-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">null</span> <span class="tsd-signature-symbol">|</span> <a href="data_balance_pokemon-evolutions.SpeciesFormEvolution.html" class="tsd-signature-type tsd-kind-class">SpeciesFormEvolution</a></h4><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getevolution">getEvolution</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L2958">src/field/pokemon.ts:2958</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getexpvalue"><span>get<wbr/>Exp<wbr/>Value</span><a href="#getexpvalue" 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="getexpvalue-1"><span class="tsd-kind-call-signature">getExpValue</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><a href="#getexpvalue-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="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getexpvalue">getExpValue</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L5811">src/field/pokemon.ts:5811</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getfieldindex"><span>get<wbr/>Field<wbr/>Index</span><a href="#getfieldindex" 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="getfieldindex-1"><span class="tsd-kind-call-signature">getFieldIndex</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><a href="#getfieldindex-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>Overrides <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getfieldindex">getFieldIndex</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L7716">src/field/pokemon.ts:7716</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getfieldpositionoffset"><span>get<wbr/>Field<wbr/>Position<wbr/>Offset</span><a href="#getfieldpositionoffset" 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="getfieldpositionoffset-1"><span class="tsd-kind-call-signature">getFieldPositionOffset</span><span class="tsd-signature-symbol">()</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-type">number</span><span class="tsd-signature-symbol">]</span><a href="#getfieldpositionoffset-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-symbol">[</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">]</span></h4><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getfieldpositionoffset">getFieldPositionOffset</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L1321">src/field/pokemon.ts:1321</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="getfirst"><span>get<wbr/>First</span><a href="#getfirst" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="getfirst-1"><span class="tsd-kind-call-signature">getFirst</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#getfirstt">T</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">GameObject</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">property</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">value</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">startIndex</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">endIndex</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> <a class="tsd-signature-type tsd-kind-type-parameter" href="field_arena.ArenaBase.html#getfirstt">T</a><a href="#getfirst-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 first Game Object in this Container.</p>
|
||
<p>You can also specify a property and value to search for, in which case it will return the first
|
||
Game Object in this Container with a matching property and / or value.</p>
|
||
<p>For example: <code>getFirst('visible', true)</code> would return the first Game Object that had its <code>visible</code> property set.</p>
|
||
<p>You can limit the search to the <code>startIndex</code> - <code>endIndex</code> range.</p>
|
||
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="getfirstt"><span class="tsd-kind-type-parameter">T</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">GameObject</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">property</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The property to test on each Game Object in the Container.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The value to test the property against. Must pass a strict (<code>===</code>) comparison check.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">startIndex</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>An optional start index to search from. Default 0.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">endIndex</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>An optional end index to search up to (but not included) Default Container.length.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="field_arena.ArenaBase.html#getfirstt">T</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getfirst">getFirst</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17036</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getformkey"><span>get<wbr/>Form<wbr/>Key</span><a href="#getformkey" 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="getformkey-1"><span class="tsd-kind-call-signature">getFormKey</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#getformkey-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">string</span></h4><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getformkey">getFormKey</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L1007">src/field/pokemon.ts:1007</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getfusionbattlespriteatlaspath"><span>get<wbr/>Fusion<wbr/>Battle<wbr/>Sprite<wbr/>Atlas<wbr/>Path</span><a href="#getfusionbattlespriteatlaspath" 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="getfusionbattlespriteatlaspath-1"><span class="tsd-kind-call-signature">getFusionBattleSpriteAtlasPath</span><span class="tsd-signature-symbol">(</span><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> <span class="tsd-kind-parameter">ignoreOverride</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> <span class="tsd-signature-type">string</span><a href="#getfusionbattlespriteatlaspath-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">back</span>: <span class="tsd-signature-type">boolean</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">ignoreOverride</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="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getfusionbattlespriteatlaspath">getFusionBattleSpriteAtlasPath</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L1112">src/field/pokemon.ts:1112</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getfusionbattlespriteid"><span>get<wbr/>Fusion<wbr/>Battle<wbr/>Sprite<wbr/>Id</span><a href="#getfusionbattlespriteid" 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="getfusionbattlespriteid-1"><span class="tsd-kind-call-signature">getFusionBattleSpriteId</span><span class="tsd-signature-symbol">(</span><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> <span class="tsd-kind-parameter">ignoreOverride</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> <span class="tsd-signature-type">string</span><a href="#getfusionbattlespriteid-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">back</span>: <span class="tsd-signature-type">boolean</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">ignoreOverride</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="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getfusionbattlespriteid">getFusionBattleSpriteId</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L1092">src/field/pokemon.ts:1092</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getfusionbattlespritekey"><span>get<wbr/>Fusion<wbr/>Battle<wbr/>Sprite<wbr/>Key</span><a href="#getfusionbattlespritekey" 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="getfusionbattlespritekey-1"><span class="tsd-kind-call-signature">getFusionBattleSpriteKey</span><span class="tsd-signature-symbol">(</span><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> <span class="tsd-kind-parameter">ignoreOverride</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> <span class="tsd-signature-type">string</span><a href="#getfusionbattlespritekey-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">back</span>: <span class="tsd-signature-type">boolean</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">ignoreOverride</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="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getfusionbattlespritekey">getFusionBattleSpriteKey</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L1108">src/field/pokemon.ts:1108</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getfusionformkey"><span>get<wbr/>Fusion<wbr/>Form<wbr/>Key</span><a href="#getfusionformkey" 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="getfusionformkey-1"><span class="tsd-kind-call-signature">getFusionFormKey</span><span class="tsd-signature-symbol">()</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><a href="#getfusionformkey-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">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getfusionformkey">getFusionFormKey</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L1017">src/field/pokemon.ts:1017</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getfusiongender"><span>get<wbr/>Fusion<wbr/>Gender</span><a href="#getfusiongender" 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="getfusiongender-1"><span class="tsd-kind-call-signature">getFusionGender</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">ignoreOverride</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">useIllusion</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/data_gender.Gender.html" class="tsd-signature-type tsd-kind-enum">Gender</a><a href="#getfusiongender-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">ignoreOverride</span>: <span class="tsd-signature-type">boolean</span></span></li><li><span><span class="tsd-kind-parameter">useIllusion</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span><div class="tsd-comment tsd-typography"><p>Whether we want the fake or real gender (illusion ability).</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../enums/data_gender.Gender.html" class="tsd-signature-type tsd-kind-enum">Gender</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getfusiongender">getFusionGender</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L1877">src/field/pokemon.ts:1877</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getfusioniconatlaskey"><span>get<wbr/>Fusion<wbr/>Icon<wbr/>Atlas<wbr/>Key</span><a href="#getfusioniconatlaskey" 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="getfusioniconatlaskey-1"><span class="tsd-kind-call-signature">getFusionIconAtlasKey</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">ignoreOverride</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">useIllusion</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> <span class="tsd-signature-type">string</span><a href="#getfusioniconatlaskey-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">ignoreOverride</span>: <span class="tsd-signature-type">boolean</span></span></li><li><span><span class="tsd-kind-parameter">useIllusion</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</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="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getfusioniconatlaskey">getFusionIconAtlasKey</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L1132">src/field/pokemon.ts:1132</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getfusioniconid"><span>get<wbr/>Fusion<wbr/>Icon<wbr/>Id</span><a href="#getfusioniconid" 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="getfusioniconid-1"><span class="tsd-kind-call-signature">getFusionIconId</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">ignoreOverride</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">useIllusion</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> <span class="tsd-signature-type">string</span><a href="#getfusioniconid-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">ignoreOverride</span>: <span class="tsd-signature-type">boolean</span></span></li><li><span><span class="tsd-kind-parameter">useIllusion</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</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="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getfusioniconid">getFusionIconId</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L1153">src/field/pokemon.ts:1153</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getfusionspeciesform"><span>get<wbr/>Fusion<wbr/>Species<wbr/>Form</span><a href="#getfusionspeciesform" 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="getfusionspeciesform-1"><span class="tsd-kind-call-signature">getFusionSpeciesForm</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">ignoreOverride</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">useIllusion</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="data_pokemon-species.PokemonSpeciesForm.html" class="tsd-signature-type tsd-kind-class">PokemonSpeciesForm</a><a href="#getfusionspeciesform-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">ignoreOverride</span>: <span class="tsd-signature-type">boolean</span></span></li><li><span><span class="tsd-kind-parameter">useIllusion</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span><div class="tsd-comment tsd-typography"><p>Whether we want the fusionSpeciesForm of the illusion or not.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="data_pokemon-species.PokemonSpeciesForm.html" class="tsd-signature-type tsd-kind-class">PokemonSpeciesForm</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getfusionspeciesform">getFusionSpeciesForm</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L1188">src/field/pokemon.ts:1188</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getfusionspriteid"><span>get<wbr/>Fusion<wbr/>Sprite<wbr/>Id</span><a href="#getfusionspriteid" 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="getfusionspriteid-1"><span class="tsd-kind-call-signature">getFusionSpriteId</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">ignoreOverride</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> <span class="tsd-signature-type">string</span><a href="#getfusionspriteid-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">ignoreOverride</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="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getfusionspriteid">getFusionSpriteId</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L1082">src/field/pokemon.ts:1082</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getgender"><span>get<wbr/>Gender</span><a href="#getgender" 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="getgender-1"><span class="tsd-kind-call-signature">getGender</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">ignoreOverride</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">useIllusion</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/data_gender.Gender.html" class="tsd-signature-type tsd-kind-enum">Gender</a><a href="#getgender-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">ignoreOverride</span>: <span class="tsd-signature-type">boolean</span></span></li><li><span><span class="tsd-kind-parameter">useIllusion</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span><div class="tsd-comment tsd-typography"><p>Whether we want the fake or real gender (illusion ability).</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../enums/data_gender.Gender.html" class="tsd-signature-type tsd-kind-enum">Gender</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getgender">getGender</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L1865">src/field/pokemon.ts:1865</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="gethelditems"><span>get<wbr/>Held<wbr/>Items</span><a href="#gethelditems" 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="gethelditems-1"><span class="tsd-kind-call-signature">getHeldItems</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="modifier_modifier.PokemonHeldItemModifier.html" class="tsd-signature-type tsd-kind-class">PokemonHeldItemModifier</a><span class="tsd-signature-symbol">[]</span><a href="#gethelditems-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="modifier_modifier.PokemonHeldItemModifier.html" class="tsd-signature-type tsd-kind-class">PokemonHeldItemModifier</a><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#gethelditems">getHeldItems</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L1251">src/field/pokemon.ts:1251</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="gethpratio"><span>get<wbr/>Hp<wbr/>Ratio</span><a href="#gethpratio" 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="gethpratio-1"><span class="tsd-kind-call-signature">getHpRatio</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">precise</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> <span class="tsd-signature-type">number</span><a href="#gethpratio-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">precise</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">number</span></h4><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#gethpratio">getHpRatio</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L1843">src/field/pokemon.ts:1843</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">ignoreOverride</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">useIllusion</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> <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">ignoreOverride</span>: <span class="tsd-signature-type">boolean</span></span></li><li><span><span class="tsd-kind-parameter">useIllusion</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</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="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#geticonatlaskey">getIconAtlasKey</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L1122">src/field/pokemon.ts:1122</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><span class="tsd-kind-parameter">ignoreOverride</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">useIllusion</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> <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><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">ignoreOverride</span>: <span class="tsd-signature-type">boolean</span></span></li><li><span><span class="tsd-kind-parameter">useIllusion</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</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="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#geticonid">getIconId</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L1142">src/field/pokemon.ts:1142</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="getindex"><span>get<wbr/>Index</span><a href="#getindex" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="getindex-1"><span class="tsd-kind-call-signature">getIndex</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#getindext">T</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">GameObject</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">child</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="field_arena.ArenaBase.html#getindext">T</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><a href="#getindex-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>Returns the index of the given Game Object in this Container.</p>
|
||
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="getindext"><span class="tsd-kind-type-parameter">T</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">GameObject</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">child</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="field_arena.ArenaBase.html#getindext">T</a></span><div class="tsd-comment tsd-typography"><p>The Game Object to search for in this Container.</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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getindex">getIndex</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:16998</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="getindexlist"><span>get<wbr/>Index<wbr/>List</span><a href="#getindexlist" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="getindexlist-1"><span class="tsd-kind-call-signature">getIndexList</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><a href="#getindexlist-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>Returns an array containing the display list index of either this Game Object, or if it has one,
|
||
its parent Container. It then iterates up through all of the parent containers until it hits the
|
||
root of the display list (which is index 0 in the returned array).</p>
|
||
<p>Used internally by the InputPlugin but also useful if you wish to find out the display depth of
|
||
this Game Object and all of its ancestors.</p>
|
||
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getindexlist">getIndexList</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:20240</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getinversehp"><span>get<wbr/>Inverse<wbr/>Hp</span><a href="#getinversehp" 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="getinversehp-1"><span class="tsd-kind-call-signature">getInverseHp</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><a href="#getinversehp-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>Returns the amount of hp currently missing from this <a href="field_pokemon.default.html" class="tsd-kind-class"><code>Pokemon</code></a> (max - current)</p>
|
||
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getinversehp">getInverseHp</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L1839">src/field/pokemon.ts:1839</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getlastxmoves"><span>get<wbr/>LastXMoves</span><a href="#getlastxmoves" 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="getlastxmoves-1"><span class="tsd-kind-call-signature">getLastXMoves</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">moveCount</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="../interfaces/field_pokemon.TurnMove.html" class="tsd-signature-type tsd-kind-interface">TurnMove</a><span class="tsd-signature-symbol">[]</span><a href="#getlastxmoves-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>Returns a list of the most recent move entries in this Pokemon's move history.
|
||
The retrieved move entries are sorted in order from NEWEST to OLDEST.</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">moveCount</span>: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 1</span></span><div class="tsd-comment tsd-typography"><p>The number of move entries to retrieve.
|
||
If negative, retrieve the Pokemon's entire move history (equivalent to reversing the output of <a href="field_pokemon.default.html#getmovehistory" class="tsd-kind-method"><code>()</code></a>).
|
||
Default is <code>1</code>.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../interfaces/field_pokemon.TurnMove.html" class="tsd-signature-type tsd-kind-interface">TurnMove</a><span class="tsd-signature-symbol">[]</span></h4><p>A list of <a href="../interfaces/field_pokemon.TurnMove.html" class="tsd-kind-interface"><code>TurnMove</code></a>, as specified above.</p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getlastxmoves">getLastXMoves</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L5150">src/field/pokemon.ts:5150</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getlearnablelevelmoves"><span>get<wbr/>Learnable<wbr/>Level<wbr/>Moves</span><a href="#getlearnablelevelmoves" 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="getlearnablelevelmoves-1"><span class="tsd-kind-call-signature">getLearnableLevelMoves</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="../enums/enums_moves.Moves.html" class="tsd-signature-type tsd-kind-enum">Moves</a><span class="tsd-signature-symbol">[]</span><a href="#getlearnablelevelmoves-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 all possible learnable level moves for the <a href="field_pokemon.default.html" class="tsd-kind-class"><code>Pokemon</code></a>,
|
||
excluding any moves already known.</p>
|
||
<p>Available egg moves are only included if the <a href="field_pokemon.default.html" class="tsd-kind-class"><code>Pokemon</code></a> was
|
||
in the starting party of the run and if Fresh Start is not active.</p>
|
||
</div><h4 class="tsd-returns-title">Returns <a href="../enums/enums_moves.Moves.html" class="tsd-signature-type tsd-kind-enum">Moves</a><span class="tsd-signature-symbol">[]</span></h4><p>an array of <a href="../enums/enums_moves.Moves.html" class="tsd-kind-enum"><code>Moves</code></a>, the length of which is determined
|
||
by how many learnable moves there are for the <a href="field_pokemon.default.html" class="tsd-kind-class"><code>Pokemon</code></a>.</p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getlearnablelevelmoves">getLearnableLevelMoves</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L2058">src/field/pokemon.ts:2058</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><br/> <span class="tsd-kind-parameter">startingLevel</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">includeEvolutionMoves</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">simulateEvolutionChain</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">includeRelearnerMoves</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">learnSituation</span><span class="tsd-signature-symbol">?:</span> <a href="../enums/field_pokemon.LearnMoveSituation.html" class="tsd-signature-type tsd-kind-enum">LearnMoveSituation</a><span class="tsd-signature-symbol">,</span><br/><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"><div class="tsd-comment tsd-typography"><p>Gets all level up moves in a given range for a particular pokemon.</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">startingLevel</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>Don't include moves below this level</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">includeEvolutionMoves</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span><div class="tsd-comment tsd-typography"><p>Whether to include evolution moves</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">simulateEvolutionChain</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span><div class="tsd-comment tsd-typography"><p>Whether to include moves from prior evolutions</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">includeRelearnerMoves</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span><div class="tsd-comment tsd-typography"><p>Whether to include moves that would require a relearner. Note the move relearner inherently allows evolution moves</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">learnSituation</span>: <a href="../enums/field_pokemon.LearnMoveSituation.html" class="tsd-signature-type tsd-kind-enum">LearnMoveSituation</a><span class="tsd-signature-symbol"> = LearnMoveSituation.MISC</span></span></li></ul></div><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><p>A list of moves and the levels they can be learned at</p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getlevelmoves">getLevelMoves</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L3014">src/field/pokemon.ts:3014</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="getlocalpoint"><span>get<wbr/>Local<wbr/>Point</span><a href="#getlocalpoint" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="getlocalpoint-1"><span class="tsd-kind-call-signature">getLocalPoint</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">x</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">y</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">point</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Vector2</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">camera</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Camera</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Vector2</span><a href="#getlocalpoint-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>Takes the given <code>x</code> and <code>y</code> coordinates and converts them into local space for this
|
||
Game Object, taking into account parent and local transforms, and the Display Origin.</p>
|
||
<p>The returned Vector2 contains the translated point in its properties.</p>
|
||
<p>A Camera needs to be provided in order to handle modified scroll factors. If no
|
||
camera is specified, it will use the <code>main</code> camera from the Scene to which this
|
||
Game Object belongs.</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">x</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The x position to translate.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">y</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The y position to translate.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">point</span>: <span class="tsd-signature-type">Vector2</span></span><div class="tsd-comment tsd-typography"><p>A Vector2, or point-like object, to store the results in.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">camera</span>: <span class="tsd-signature-type">Camera</span></span><div class="tsd-comment tsd-typography"><p>The Camera which is being tested against. If not given will use the Scene default camera.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Vector2</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getlocalpoint">getLocalPoint</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17879</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="getlocaltransformmatrix"><span>get<wbr/>Local<wbr/>Transform<wbr/>Matrix</span><a href="#getlocaltransformmatrix" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="getlocaltransformmatrix-1"><span class="tsd-kind-call-signature">getLocalTransformMatrix</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">tempMatrix</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">TransformMatrix</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">TransformMatrix</span><a href="#getlocaltransformmatrix-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 local transform matrix for this Game Object.</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">tempMatrix</span>: <span class="tsd-signature-type">TransformMatrix</span></span><div class="tsd-comment tsd-typography"><p>The matrix to populate with the values from this Game Object.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">TransformMatrix</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getlocaltransformmatrix">getLocalTransformMatrix</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17856</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getluck"><span>get<wbr/>Luck</span><a href="#getluck" 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="getluck-1"><span class="tsd-kind-call-signature">getLuck</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><a href="#getluck-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="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getluck">getLuck</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L1949">src/field/pokemon.ts:1949</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getmatchupscore"><span>get<wbr/>Matchup<wbr/>Score</span><a href="#getmatchupscore" 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="getmatchupscore-1"><span class="tsd-kind-call-signature">getMatchupScore</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">opponent</span><span class="tsd-signature-symbol">:</span> <a href="field_pokemon.default.html" class="tsd-signature-type tsd-kind-class">default</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><a href="#getmatchupscore-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>Computes the given Pokemon's matchup score against this Pokemon.
|
||
In most cases, this score ranges from near-zero to 16, but the maximum possible matchup score is 64.</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">opponent</span>: <a href="field_pokemon.default.html" class="tsd-signature-type tsd-kind-class">default</a></span><div class="tsd-comment tsd-typography"><p><a href="field_pokemon.default.html" class="tsd-kind-class"><code>Pokemon</code></a> The Pokemon to compare this Pokemon against</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>A score value based on how favorable this Pokemon is when fighting the given Pokemon</p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getmatchupscore">getMatchupScore</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L2918">src/field/pokemon.ts:2918</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getmaxhp"><span>get<wbr/>Max<wbr/>Hp</span><a href="#getmaxhp" 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="getmaxhp-1"><span class="tsd-kind-call-signature">getMaxHp</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><a href="#getmaxhp-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="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getmaxhp">getMaxHp</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L1834">src/field/pokemon.ts:1834</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getmovecategory"><span>get<wbr/>Move<wbr/>Category</span><a href="#getmovecategory" 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="getmovecategory-1"><span class="tsd-kind-call-signature">getMoveCategory</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">target</span><span class="tsd-signature-symbol">:</span> <a href="field_pokemon.default.html" class="tsd-signature-type tsd-kind-class">default</a><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">move</span><span class="tsd-signature-symbol">:</span> <a href="data_moves_move.default.html" class="tsd-signature-type tsd-kind-class">default</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="../enums/enums_MoveCategory.MoveCategory.html" class="tsd-signature-type tsd-kind-enum">MoveCategory</a><a href="#getmovecategory-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>Calculates the category of a move when used by this pokemon after
|
||
category-changing move effects are applied.</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">target</span>: <a href="field_pokemon.default.html" class="tsd-signature-type tsd-kind-class">default</a></span><div class="tsd-comment tsd-typography"><p>The <a href="field_pokemon.default.html" class="tsd-kind-class"><code>Pokemon</code></a> using the move</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">move</span>: <a href="data_moves_move.default.html" class="tsd-signature-type tsd-kind-class">default</a></span><div class="tsd-comment tsd-typography"><p>The <a href="data_moves_move.default.html" class="tsd-kind-class"><code>Move</code></a> being used</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../enums/enums_MoveCategory.MoveCategory.html" class="tsd-signature-type tsd-kind-enum">MoveCategory</a></h4><p>The given move's final category</p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getmovecategory">getMoveCategory</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L1540">src/field/pokemon.ts:1540</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getmoveeffectiveness"><span>get<wbr/>Move<wbr/>Effectiveness</span><a href="#getmoveeffectiveness" 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="getmoveeffectiveness-1"><span class="tsd-kind-call-signature">getMoveEffectiveness</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">source</span><span class="tsd-signature-symbol">:</span> <a href="field_pokemon.default.html" class="tsd-signature-type tsd-kind-class">default</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">move</span><span class="tsd-signature-symbol">:</span> <a href="data_moves_move.default.html" class="tsd-signature-type tsd-kind-class">default</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">ignoreAbility</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">simulated</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">cancelled</span><span class="tsd-signature-symbol">?:</span> <a href="utils_common.BooleanHolder.html" class="tsd-signature-type tsd-kind-class">BooleanHolder</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">useIllusion</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="../types/data_type.TypeDamageMultiplier.html" class="tsd-signature-type tsd-kind-type-alias">TypeDamageMultiplier</a><a href="#getmoveeffectiveness-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>Calculates the effectiveness of a move against the Pokémon.
|
||
This includes modifiers from move and ability attributes.</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">source</span>: <a href="field_pokemon.default.html" class="tsd-signature-type tsd-kind-class">default</a></span><div class="tsd-comment tsd-typography"><p><a href="field_pokemon.default.html" class="tsd-kind-class"><code>Pokemon</code></a> The attacking Pokémon.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">move</span>: <a href="data_moves_move.default.html" class="tsd-signature-type tsd-kind-class">default</a></span><div class="tsd-comment tsd-typography"><p><a href="data_moves_move.default.html" class="tsd-kind-class"><code>Move</code></a> The move being used by the attacking Pokémon.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">ignoreAbility</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span><div class="tsd-comment tsd-typography"><p>Whether to ignore abilities that might affect type effectiveness or immunity (defaults to <code>false</code>).</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">simulated</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></span><div class="tsd-comment tsd-typography"><p>Whether to apply abilities via simulated calls (defaults to <code>true</code>)</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">cancelled</span>: <a href="utils_common.BooleanHolder.html" class="tsd-signature-type tsd-kind-class">BooleanHolder</a></span><div class="tsd-comment tsd-typography"><p><a href="utils_common.BooleanHolder.html" class="tsd-kind-class"><code>BooleanHolder</code></a> Stores whether the move was cancelled by a non-type-based immunity.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">useIllusion</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span><div class="tsd-comment tsd-typography"><p>Whether we want the attack move effectiveness on the illusion or not</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../types/data_type.TypeDamageMultiplier.html" class="tsd-signature-type tsd-kind-type-alias">TypeDamageMultiplier</a></h4><p>The type damage multiplier, indicating the effectiveness of the move</p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getmoveeffectiveness">getMoveEffectiveness</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L2675">src/field/pokemon.ts:2675</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getmovehistory"><span>get<wbr/>Move<wbr/>History</span><a href="#getmovehistory" 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="getmovehistory-1"><span class="tsd-kind-call-signature">getMoveHistory</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/field_pokemon.TurnMove.html" class="tsd-signature-type tsd-kind-interface">TurnMove</a><span class="tsd-signature-symbol">[]</span><a href="#getmovehistory-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="../interfaces/field_pokemon.TurnMove.html" class="tsd-signature-type tsd-kind-interface">TurnMove</a><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getmovehistory">getMoveHistory</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L5130">src/field/pokemon.ts:5130</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getmovequeue"><span>get<wbr/>Move<wbr/>Queue</span><a href="#getmovequeue" 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="getmovequeue-1"><span class="tsd-kind-call-signature">getMoveQueue</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/field_pokemon.TurnMove.html" class="tsd-signature-type tsd-kind-interface">TurnMove</a><span class="tsd-signature-symbol">[]</span><a href="#getmovequeue-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="../interfaces/field_pokemon.TurnMove.html" class="tsd-signature-type tsd-kind-interface">TurnMove</a><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getmovequeue">getMoveQueue</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L5160">src/field/pokemon.ts:5160</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getmoveset"><span>get<wbr/>Moveset</span><a href="#getmoveset" 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="getmoveset-1"><span class="tsd-kind-call-signature">getMoveset</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">ignoreOverride</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="field_pokemon.PokemonMove.html" class="tsd-signature-type tsd-kind-class">PokemonMove</a><span class="tsd-signature-symbol">[]</span><a href="#getmoveset-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">ignoreOverride</span>: <span class="tsd-signature-type">boolean</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="field_pokemon.PokemonMove.html" class="tsd-signature-type tsd-kind-class">PokemonMove</a><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getmoveset">getMoveset</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L1997">src/field/pokemon.ts:1997</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getmovetype"><span>get<wbr/>Move<wbr/>Type</span><a href="#getmovetype" 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="getmovetype-1"><span class="tsd-kind-call-signature">getMoveType</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">move</span><span class="tsd-signature-symbol">:</span> <a href="data_moves_move.default.html" class="tsd-signature-type tsd-kind-class">default</a><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">simulated</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_pokemon-type.PokemonType.html" class="tsd-signature-type tsd-kind-enum">PokemonType</a><a href="#getmovetype-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>Calculates the type of a move when used by this Pokemon after
|
||
type-changing move and ability attributes have applied.</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">move</span>: <a href="data_moves_move.default.html" class="tsd-signature-type tsd-kind-class">default</a></span><div class="tsd-comment tsd-typography"><p><a href="data_moves_move.default.html" class="tsd-kind-class"><code>Move</code></a> The move being used.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">simulated</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></span><div class="tsd-comment tsd-typography"><p>If <code>true</code>, prevents showing abilities applied in this calculation.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../enums/enums_pokemon-type.PokemonType.html" class="tsd-signature-type tsd-kind-enum">PokemonType</a></h4><p>The <a href="../enums/enums_pokemon-type.PokemonType.html" class="tsd-kind-enum"><code>PokemonType</code></a> of the move after attributes are applied</p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getmovetype">getMoveType</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L2633">src/field/pokemon.ts:2633</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getname"><span>get<wbr/>Name</span><a href="#getname" 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="getname-1"><span class="tsd-kind-call-signature">getName</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">useIllusion</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> <span class="tsd-signature-type">string</span><a href="#getname-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">useIllusion</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span><div class="tsd-comment tsd-typography"><p>Whether we want the fake name or the real name of the Pokemon (for Illusion ability).</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></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getname">getName</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L1963">src/field/pokemon.ts:1963</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getnametorender"><span>get<wbr/>Name<wbr/>To<wbr/>Render</span><a href="#getnametorender" 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="getnametorender-1"><span class="tsd-kind-call-signature">getNameToRender</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">useIllusion</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> <span class="tsd-signature-type">string</span><a href="#getnametorender-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">useIllusion</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></span><div class="tsd-comment tsd-typography"><p>Whether we want the fake name or the real name of the Pokemon (for Illusion ability).</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></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getnametorender">getNameToRender</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L567">src/field/pokemon.ts:567</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getnature"><span>get<wbr/>Nature</span><a href="#getnature" 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="getnature-1"><span class="tsd-kind-call-signature">getNature</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="../enums/enums_nature.Nature.html" class="tsd-signature-type tsd-kind-enum">Nature</a><a href="#getnature-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/enums_nature.Nature.html" class="tsd-signature-type tsd-kind-enum">Nature</a></h4><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getnature">getNature</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L1806">src/field/pokemon.ts:1806</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getnextmove"><span>get<wbr/>Next<wbr/>Move</span><a href="#getnextmove" 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="getnextmove-1"><span class="tsd-kind-call-signature">getNextMove</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/field_pokemon.TurnMove.html" class="tsd-signature-type tsd-kind-interface">TurnMove</a><a href="#getnextmove-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>Determines the move this Pokemon will use on the next turn, as well as
|
||
the Pokemon the move will target.</p>
|
||
</div><h4 class="tsd-returns-title">Returns <a href="../interfaces/field_pokemon.TurnMove.html" class="tsd-signature-type tsd-kind-interface">TurnMove</a></h4><p>this Pokemon's next move in the format {move, moveTargets}</p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L7231">src/field/pokemon.ts:7231</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getnexttargets"><span>get<wbr/>Next<wbr/>Targets</span><a href="#getnexttargets" 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="getnexttargets-1"><span class="tsd-kind-call-signature">getNextTargets</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">moveId</span><span class="tsd-signature-symbol">:</span> <a href="../enums/enums_moves.Moves.html" class="tsd-signature-type tsd-kind-enum">Moves</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="../enums/battle.BattlerIndex.html" class="tsd-signature-type tsd-kind-enum">BattlerIndex</a><span class="tsd-signature-symbol">[]</span><a href="#getnexttargets-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>Determines the Pokemon the given move would target if used by this Pokemon</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">moveId</span>: <a href="../enums/enums_moves.Moves.html" class="tsd-signature-type tsd-kind-enum">Moves</a></span><div class="tsd-comment tsd-typography"><p><a href="../enums/enums_moves.Moves.html" class="tsd-kind-enum"><code>Moves</code></a> The move to be used</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../enums/battle.BattlerIndex.html" class="tsd-signature-type tsd-kind-enum">BattlerIndex</a><span class="tsd-signature-symbol">[]</span></h4><p>The indexes of the Pokemon the given move would target</p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L7463">src/field/pokemon.ts:7463</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getopponent"><span>get<wbr/>Opponent</span><a href="#getopponent" 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="getopponent-1"><span class="tsd-kind-call-signature">getOpponent</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">targetIndex</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">null</span> <span class="tsd-signature-symbol">|</span> <a href="field_pokemon.default.html" class="tsd-signature-type tsd-kind-class">default</a><a href="#getopponent-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">targetIndex</span>: <span class="tsd-signature-type">number</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a href="field_pokemon.default.html" class="tsd-signature-type tsd-kind-class">default</a></h4><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getopponent">getOpponent</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L3934">src/field/pokemon.ts:3934</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getopponentdescriptor"><span>get<wbr/>Opponent<wbr/>Descriptor</span><a href="#getopponentdescriptor" 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="getopponentdescriptor-1"><span class="tsd-kind-call-signature">getOpponentDescriptor</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#getopponentdescriptor-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">string</span></h4><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getopponentdescriptor">getOpponentDescriptor</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L3955">src/field/pokemon.ts:3955</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getopponents"><span>get<wbr/>Opponents</span><a href="#getopponents" 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="getopponents-1"><span class="tsd-kind-call-signature">getOpponents</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">onField</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="field_pokemon.default.html" class="tsd-signature-type tsd-kind-class">default</a><span class="tsd-signature-symbol">[]</span><a href="#getopponents-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>Returns the pokemon that oppose this one and are active</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">onField</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></span><div class="tsd-comment tsd-typography"><p>whether to also check if the pokemon is currently on the field (defaults to true)</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="field_pokemon.default.html" class="tsd-signature-type tsd-kind-class">default</a><span class="tsd-signature-symbol">[]</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getopponents">getOpponents</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L3947">src/field/pokemon.ts:3947</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="getparentrotation"><span>get<wbr/>Parent<wbr/>Rotation</span><a href="#getparentrotation" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="getparentrotation-1"><span class="tsd-kind-call-signature">getParentRotation</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><a href="#getparentrotation-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 sum total rotation of all of this Game Objects parent Containers.</p>
|
||
<p>The returned value is in radians and will be zero if this Game Object has no parent container.</p>
|
||
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getparentrotation">getParentRotation</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17894</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-signature-symbol">:</span> <a href="data_abilities_ability-class.Ability.html" class="tsd-signature-type tsd-kind-class">Ability</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>Gets the passive ability of the pokemon. This should rarely be called, most of the time
|
||
<a href="field_pokemon.default.html#hasability" class="tsd-kind-method"><code>hasAbility</code></a> or <a href="field_pokemon.default.html#hasabilitywithattr" class="tsd-kind-method"><code>hasAbilityWithAttr</code></a> are better used as those check both the passive and
|
||
non-passive abilities and account for ability suppression.</p>
|
||
</div><h4 class="tsd-returns-title">Returns <a href="data_abilities_ability-class.Ability.html" class="tsd-signature-type tsd-kind-class">Ability</a></h4><p>The passive <a href="data_abilities_ability-class.Ability.html" class="tsd-kind-class"><code>Ability</code></a> of the pokemon</p>
|
||
<div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><h4 class="tsd-anchor-link" id="see-2">See<a href="#see-2" 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></h4><p><a href="field_pokemon.default.html#hasability" class="tsd-kind-method"><code>hasAbility</code></a> <a href="field_pokemon.default.html#hasabilitywithattr" class="tsd-kind-method"><code>hasAbilityWithAttr</code></a> Intended ways to check abilities in most cases</p>
|
||
</div></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getpassiveability">getPassiveAbility</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L2278">src/field/pokemon.ts:2278</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getpokeball"><span>get<wbr/>Pokeball</span><a href="#getpokeball" 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="getpokeball-1"><span class="tsd-kind-call-signature">getPokeball</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">useIllusion</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_pokeball.PokeballType.html" class="tsd-signature-type tsd-kind-enum">PokeballType</a><a href="#getpokeball-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">useIllusion</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="../enums/enums_pokeball.PokeballType.html" class="tsd-signature-type tsd-kind-enum">PokeballType</a></h4><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getpokeball">getPokeball</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L581">src/field/pokemon.ts:581</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="getpostpipeline"><span>get<wbr/>Post<wbr/>Pipeline</span><a href="#getpostpipeline" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="getpostpipeline-1"><span class="tsd-kind-call-signature">getPostPipeline</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">pipeline</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">Function</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">PostFXPipeline</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">PostFXPipeline</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">PostFXPipeline</span><span class="tsd-signature-symbol">[]</span><a href="#getpostpipeline-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 a Post Pipeline instance from this Game Object, based on the given name, and returns it.</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">pipeline</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Function</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">PostFXPipeline</span></span><div class="tsd-comment tsd-typography"><p>The string-based name of the pipeline, or a pipeline class.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">PostFXPipeline</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">PostFXPipeline</span><span class="tsd-signature-symbol">[]</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getpostpipeline">getPostPipeline</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17683</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="getrandom"><span>get<wbr/>Random</span><a href="#getrandom" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="getrandom-1"><span class="tsd-kind-call-signature">getRandom</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#getrandomt">T</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">GameObject</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">startIndex</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">length</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 class="tsd-signature-type tsd-kind-type-parameter" href="field_arena.ArenaBase.html#getrandomt">T</a><a href="#getrandom-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>Returns a random Game Object from this Container.</p>
|
||
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="getrandomt"><span class="tsd-kind-type-parameter">T</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">GameObject</span></span></li></ul></section><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">startIndex</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>An optional start index. Default 0.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">length</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>An optional length, the total number of elements (from the startIndex) to choose from.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="field_arena.ArenaBase.html#getrandomt">T</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getrandom">getRandom</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17020</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getrestrictingtag"><span>get<wbr/>Restricting<wbr/>Tag</span><a href="#getrestrictingtag" 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="getrestrictingtag-1"><span class="tsd-kind-call-signature">getRestrictingTag</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">moveId</span><span class="tsd-signature-symbol">:</span> <a href="../enums/enums_moves.Moves.html" class="tsd-signature-type tsd-kind-enum">Moves</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">user</span><span class="tsd-signature-symbol">?:</span> <a href="field_pokemon.default.html" class="tsd-signature-type tsd-kind-class">default</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">target</span><span class="tsd-signature-symbol">?:</span> <a href="field_pokemon.default.html" class="tsd-signature-type tsd-kind-class">default</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a href="data_battler-tags.MoveRestrictionBattlerTag.html" class="tsd-signature-type tsd-kind-class">MoveRestrictionBattlerTag</a><a href="#getrestrictingtag-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 <a href="data_battler-tags.MoveRestrictionBattlerTag.html" class="tsd-kind-class">MoveRestrictionBattlerTag</a> that is restricting a move, if it exists.</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">moveId</span>: <a href="../enums/enums_moves.Moves.html" class="tsd-signature-type tsd-kind-enum">Moves</a></span><div class="tsd-comment tsd-typography"><p><a href="../enums/enums_moves.Moves.html" class="tsd-kind-enum"><code>Moves</code></a> ID of the move to check</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">user</span>: <a href="field_pokemon.default.html" class="tsd-signature-type tsd-kind-class">default</a></span><div class="tsd-comment tsd-typography"><p><a href="field_pokemon.default.html" class="tsd-kind-class"><code>Pokemon</code></a> the move user, optional and used when the target is a factor in the move's restricted status</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">target</span>: <a href="field_pokemon.default.html" class="tsd-signature-type tsd-kind-class">default</a></span><div class="tsd-comment tsd-typography"><p><a href="field_pokemon.default.html" class="tsd-kind-class"><code>Pokemon</code></a> the target of the move, optional and used when the target is a factor in the move's restricted status</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a href="data_battler-tags.MoveRestrictionBattlerTag.html" class="tsd-signature-type tsd-kind-class">MoveRestrictionBattlerTag</a></h4><p>The first tag on this Pokemon that restricts the move, or <code>null</code> if the move is not restricted.</p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getrestrictingtag">getRestrictingTag</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L5104">src/field/pokemon.ts:5104</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getspeciesform"><span>get<wbr/>Species<wbr/>Form</span><a href="#getspeciesform" 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="getspeciesform-1"><span class="tsd-kind-call-signature">getSpeciesForm</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">ignoreOverride</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">useIllusion</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="data_pokemon-species.PokemonSpeciesForm.html" class="tsd-signature-type tsd-kind-class">PokemonSpeciesForm</a><a href="#getspeciesform-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>Get this <a href="field_pokemon.default.html" class="tsd-kind-class"><code>Pokemon</code></a>'s <a href="data_pokemon-species.PokemonSpeciesForm.html" class="tsd-kind-class"><code>PokemonSpeciesForm</code></a>.</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">ignoreOverride</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span><div class="tsd-comment tsd-typography"><p>Whether to ignore overridden species from <a href="../enums/enums_moves.Moves.html#transform" class="tsd-kind-enum-member"><code>Moves.TRANSFORM</code></a>, default <code>false</code>.
|
||
This overrides <code>useIllusion</code> if <code>true</code>.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">useIllusion</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span><div class="tsd-comment tsd-typography"><p><code>true</code> to use the speciesForm of the illusion; default <code>false</code>.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="data_pokemon-species.PokemonSpeciesForm.html" class="tsd-signature-type tsd-kind-class">PokemonSpeciesForm</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getspeciesform">getSpeciesForm</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L1170">src/field/pokemon.ts:1170</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getsprite"><span>get<wbr/>Sprite</span><a href="#getsprite" 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="getsprite-1"><span class="tsd-kind-call-signature">getSprite</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Sprite</span><a href="#getsprite-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">Sprite</span></h4><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getsprite">getSprite</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L1204">src/field/pokemon.ts:1204</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><span class="tsd-kind-parameter">ignoreOverride</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> <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><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">ignoreOverride</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="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getspriteatlaspath">getSpriteAtlasPath</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L1030">src/field/pokemon.ts:1030</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><span class="tsd-kind-parameter">ignoreOverride</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> <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-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">ignoreOverride</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="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getspriteid">getSpriteId</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L1043">src/field/pokemon.ts:1043</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><span class="tsd-kind-parameter">ignoreOverride</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> <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><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">ignoreOverride</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="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getspritekey">getSpriteKey</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L1069">src/field/pokemon.ts:1069</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getspritescale"><span>get<wbr/>Sprite<wbr/>Scale</span><a href="#getspritescale" 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="getspritescale-1"><span class="tsd-kind-call-signature">getSpriteScale</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><a href="#getspritescale-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="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getspritescale">getSpriteScale</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L1214">src/field/pokemon.ts:1214</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getstat"><span>get<wbr/>Stat</span><a href="#getstat" 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="getstat-1"><span class="tsd-kind-call-signature">getStat</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">stat</span><span class="tsd-signature-symbol">:</span> <a href="../enums/enums_stat.Stat.html#hp" class="tsd-signature-type tsd-kind-enum-member">HP</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/enums_stat.Stat.html#atk" class="tsd-signature-type tsd-kind-enum-member">ATK</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/enums_stat.Stat.html#def" class="tsd-signature-type tsd-kind-enum-member">DEF</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/enums_stat.Stat.html#spatk" class="tsd-signature-type tsd-kind-enum-member">SPATK</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/enums_stat.Stat.html#spdef" class="tsd-signature-type tsd-kind-enum-member">SPDEF</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/enums_stat.Stat.html#spd" class="tsd-signature-type tsd-kind-enum-member">SPD</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">bypassSummonData</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">number</span><a href="#getstat-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>Retrieves the corresponding <a href="../types/enums_stat.PermanentStat.html" class="tsd-kind-type-alias"><code>PermanentStat</code></a> of the <a href="field_pokemon.default.html" class="tsd-kind-class"><code>Pokemon</code></a>.</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#hp" class="tsd-signature-type tsd-kind-enum-member">HP</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/enums_stat.Stat.html#atk" class="tsd-signature-type tsd-kind-enum-member">ATK</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/enums_stat.Stat.html#def" class="tsd-signature-type tsd-kind-enum-member">DEF</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/enums_stat.Stat.html#spatk" class="tsd-signature-type tsd-kind-enum-member">SPATK</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/enums_stat.Stat.html#spdef" class="tsd-signature-type tsd-kind-enum-member">SPDEF</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/enums_stat.Stat.html#spd" class="tsd-signature-type tsd-kind-enum-member">SPD</a></span><div class="tsd-comment tsd-typography"><p>the desired <a href="../types/enums_stat.PermanentStat.html" class="tsd-kind-type-alias"><code>PermanentStat</code></a></p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">bypassSummonData</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></span><div class="tsd-comment tsd-typography"><p>prefer actual stats (<code>true</code> by default) or in-battle overridden stats (<code>false</code>)</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 numeric value of the desired <a href="../enums/enums_stat.Stat.html" class="tsd-kind-enum"><code>Stat</code></a></p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getstat">getStat</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L1443">src/field/pokemon.ts:1443</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getstats"><span>get<wbr/>Stats</span><a href="#getstats" 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="getstats-1"><span class="tsd-kind-call-signature">getStats</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">bypassSummonData</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> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><a href="#getstats-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>Retrieves the entire set of stats of this <a href="field_pokemon.default.html" class="tsd-kind-class"><code>Pokemon</code></a>.</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">bypassSummonData</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></span><div class="tsd-comment tsd-typography"><p>whether to use actual stats or in-battle overriden stats from Transform; default <code>true</code></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><span class="tsd-signature-symbol">[]</span></h4><p>the numeric values of this <a href="field_pokemon.default.html" class="tsd-kind-class"><code>Pokemon</code></a>'s stats</p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getstats">getStats</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L1430">src/field/pokemon.ts:1430</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getstatstage"><span>get<wbr/>Stat<wbr/>Stage</span><a href="#getstatstage" 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="getstatstage-1"><span class="tsd-kind-call-signature">getStatStage</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#atk" class="tsd-signature-type tsd-kind-enum-member">ATK</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/enums_stat.Stat.html#def" class="tsd-signature-type tsd-kind-enum-member">DEF</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/enums_stat.Stat.html#spatk" class="tsd-signature-type tsd-kind-enum-member">SPATK</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/enums_stat.Stat.html#spdef" class="tsd-signature-type tsd-kind-enum-member">SPDEF</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/enums_stat.Stat.html#spd" class="tsd-signature-type tsd-kind-enum-member">SPD</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/enums_stat.Stat.html#acc" class="tsd-signature-type tsd-kind-enum-member">ACC</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/enums_stat.Stat.html#eva" class="tsd-signature-type tsd-kind-enum-member">EVA</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><a href="#getstatstage-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>Retrieves the in-battle stage of the specified <a href="../types/enums_stat.BattleStat.html" class="tsd-kind-type-alias"><code>BattleStat</code></a>.</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#atk" class="tsd-signature-type tsd-kind-enum-member">ATK</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/enums_stat.Stat.html#def" class="tsd-signature-type tsd-kind-enum-member">DEF</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/enums_stat.Stat.html#spatk" class="tsd-signature-type tsd-kind-enum-member">SPATK</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/enums_stat.Stat.html#spdef" class="tsd-signature-type tsd-kind-enum-member">SPDEF</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/enums_stat.Stat.html#spd" class="tsd-signature-type tsd-kind-enum-member">SPD</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/enums_stat.Stat.html#acc" class="tsd-signature-type tsd-kind-enum-member">ACC</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/enums_stat.Stat.html#eva" class="tsd-signature-type tsd-kind-enum-member">EVA</a></span><div class="tsd-comment tsd-typography"><p>the <a href="../types/enums_stat.BattleStat.html" class="tsd-kind-type-alias"><code>BattleStat</code></a> whose stage is desired</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 stage of the desired <a href="../types/enums_stat.BattleStat.html" class="tsd-kind-type-alias"><code>BattleStat</code></a> if available, 0 otherwise</p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getstatstage">getStatStage</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L1486">src/field/pokemon.ts:1486</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getstatstagemultiplier"><span>get<wbr/>Stat<wbr/>Stage<wbr/>Multiplier</span><a href="#getstatstagemultiplier" 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="getstatstagemultiplier-1"><span class="tsd-kind-call-signature">getStatStageMultiplier</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">stat</span><span class="tsd-signature-symbol">:</span> <a href="../enums/enums_stat.Stat.html#atk" class="tsd-signature-type tsd-kind-enum-member">ATK</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/enums_stat.Stat.html#def" class="tsd-signature-type tsd-kind-enum-member">DEF</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/enums_stat.Stat.html#spatk" class="tsd-signature-type tsd-kind-enum-member">SPATK</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/enums_stat.Stat.html#spdef" class="tsd-signature-type tsd-kind-enum-member">SPDEF</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/enums_stat.Stat.html#spd" class="tsd-signature-type tsd-kind-enum-member">SPD</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">opponent</span><span class="tsd-signature-symbol">?:</span> <a href="field_pokemon.default.html" class="tsd-signature-type tsd-kind-class">default</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">move</span><span class="tsd-signature-symbol">?:</span> <a href="data_moves_move.default.html" class="tsd-signature-type tsd-kind-class">default</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">ignoreOppAbility</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">isCritical</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">simulated</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">ignoreHeldItems</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">number</span><a href="#getstatstagemultiplier-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>Calculates the stat stage multiplier of the user against an opponent.</p>
|
||
<p>Note that this does not apply to evasion or accuracy</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#atk" class="tsd-signature-type tsd-kind-enum-member">ATK</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/enums_stat.Stat.html#def" class="tsd-signature-type tsd-kind-enum-member">DEF</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/enums_stat.Stat.html#spatk" class="tsd-signature-type tsd-kind-enum-member">SPATK</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/enums_stat.Stat.html#spdef" class="tsd-signature-type tsd-kind-enum-member">SPDEF</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/enums_stat.Stat.html#spd" class="tsd-signature-type tsd-kind-enum-member">SPD</a></span><div class="tsd-comment tsd-typography"><p>the desired <a href="../types/enums_stat.EffectiveStat.html" class="tsd-kind-type-alias"><code>EffectiveStat</code></a></p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">opponent</span>: <a href="field_pokemon.default.html" class="tsd-signature-type tsd-kind-class">default</a></span><div class="tsd-comment tsd-typography"><p>the target <a href="field_pokemon.default.html" class="tsd-kind-class"><code>Pokemon</code></a></p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">move</span>: <a href="data_moves_move.default.html" class="tsd-signature-type tsd-kind-class">default</a></span><div class="tsd-comment tsd-typography"><p>the <a href="data_moves_move.default.html" class="tsd-kind-class"><code>Move</code></a> being used</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">ignoreOppAbility</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span><div class="tsd-comment tsd-typography"><p>determines whether the effects of the opponent's abilities (i.e. Unaware) should be ignored (<code>false</code> by default)</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">isCritical</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span><div class="tsd-comment tsd-typography"><p>determines whether a critical hit has occurred or not (<code>false</code> by default)</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">simulated</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></span><div class="tsd-comment tsd-typography"><p>determines whether effects are applied without altering game state (<code>true</code> by default)</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">ignoreHeldItems</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span><div class="tsd-comment tsd-typography"><p>determines whether this Pokemon's held items should be ignored during the stat calculation, default <code>false</code></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 stat stage multiplier to be used for effective stat calculation</p>
|
||
<div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><h4 class="tsd-anchor-link" id="see-3">See<a href="#see-3" 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></h4><p><a href="field_pokemon.default.html#getaccuracymultiplier" class="tsd-kind-method"><code>getAccuracyMultiplier</code></a></p>
|
||
</div></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getstatstagemultiplier">getStatStageMultiplier</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L3998">src/field/pokemon.ts:3998</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getstatstages"><span>get<wbr/>Stat<wbr/>Stages</span><a href="#getstatstages" 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="getstatstages-1"><span class="tsd-kind-call-signature">getStatStages</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><a href="#getstatstages-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>Retrieves the entire set of in-battle stat stages of the <a href="field_pokemon.default.html" class="tsd-kind-class"><code>Pokemon</code></a>.</p>
|
||
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h4><p>the numeric values of the <a href="field_pokemon.default.html" class="tsd-kind-class"><code>Pokemon</code></a>'s in-battle stat stages if available, a fresh stat stage array otherwise</p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getstatstages">getStatStages</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L1477">src/field/pokemon.ts:1477</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getsubstituteoffset"><span>get<wbr/>Substitute<wbr/>Offset</span><a href="#getsubstituteoffset" 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="getsubstituteoffset-1"><span class="tsd-kind-call-signature">getSubstituteOffset</span><span class="tsd-signature-symbol">()</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-type">number</span><span class="tsd-signature-symbol">]</span><a href="#getsubstituteoffset-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>Returns the Pokemon's offset from its current field position in the event that
|
||
it has a Substitute doll in effect. The offset is returned in <code>[ x, y ]</code> format.</p>
|
||
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">]</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><h4 class="tsd-anchor-link" id="see-4">See<a href="#see-4" 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></h4><ul>
|
||
<li><a href="data_battler-tags.SubstituteTag.html" class="tsd-kind-class"><code>SubstituteTag</code></a></li>
|
||
<li><a href="field_pokemon.default.html#getfieldpositionoffset" class="tsd-kind-method"><code>getFieldPositionOffset</code></a></li>
|
||
</ul>
|
||
</div></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getsubstituteoffset">getSubstituteOffset</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L1338">src/field/pokemon.ts:1338</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="gettag"><span>get<wbr/>Tag</span><a href="#gettag" 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="gettag-1"><span class="tsd-kind-call-signature">getTag</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">tagType</span><span class="tsd-signature-symbol">:</span> <a href="../enums/enums_battler-tag-type.BattlerTagType.html#grudge" class="tsd-signature-type tsd-kind-enum-member">GRUDGE</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="../types/utils_common.nil.html" class="tsd-signature-type tsd-kind-type-alias">nil</a> <span class="tsd-signature-symbol">|</span> <a href="data_battler-tags.GrudgeTag.html" class="tsd-signature-type tsd-kind-class">GrudgeTag</a><a href="#gettag-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">tagType</span>: <a href="../enums/enums_battler-tag-type.BattlerTagType.html#grudge" class="tsd-signature-type tsd-kind-enum-member">GRUDGE</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../types/utils_common.nil.html" class="tsd-signature-type tsd-kind-type-alias">nil</a> <span class="tsd-signature-symbol">|</span> <a href="data_battler-tags.GrudgeTag.html" class="tsd-signature-type tsd-kind-class">GrudgeTag</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#gettag">getTag</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L4917">src/field/pokemon.ts:4917</a></li></ul></aside></div></li><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="gettag-2"><span class="tsd-kind-call-signature">getTag</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">tagType</span><span class="tsd-signature-symbol">:</span> <a href="../enums/enums_battler-tag-type.BattlerTagType.html" class="tsd-signature-type tsd-kind-enum">BattlerTagType</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <a href="data_battler-tags.BattlerTag.html" class="tsd-signature-type tsd-kind-class">BattlerTag</a><a href="#gettag-2" 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">tagType</span>: <a href="../enums/enums_battler-tag-type.BattlerTagType.html" class="tsd-signature-type tsd-kind-enum">BattlerTagType</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <a href="data_battler-tags.BattlerTag.html" class="tsd-signature-type tsd-kind-class">BattlerTag</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#gettag">getTag</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L4920">src/field/pokemon.ts:4920</a></li></ul></aside></div></li><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="gettag-3"><span class="tsd-kind-call-signature">getTag</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#gettagt">T</a> <span class="tsd-signature-keyword">extends</span> <a href="data_battler-tags.BattlerTag.html" class="tsd-signature-type tsd-kind-class">BattlerTag</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">tagType</span><span class="tsd-signature-symbol">:</span> <a href="../types/utils_common.Constructor.html" class="tsd-signature-type tsd-kind-type-alias">Constructor</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="field_pokemon.PlayerPokemon.html#gettagt">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="field_pokemon.PlayerPokemon.html#gettagt">T</a><a href="#gettag-3" 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"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="gettagt"><span class="tsd-kind-type-parameter">T</span> <span class="tsd-signature-keyword">extends</span> <a href="data_battler-tags.BattlerTag.html" class="tsd-signature-type tsd-kind-class">BattlerTag</a></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">tagType</span>: <a href="../types/utils_common.Constructor.html" class="tsd-signature-type tsd-kind-type-alias">Constructor</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="field_pokemon.PlayerPokemon.html#gettagt">T</a><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="field_pokemon.PlayerPokemon.html#gettagt">T</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#gettag">getTag</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L4923">src/field/pokemon.ts:4923</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getteratype"><span>get<wbr/>Tera<wbr/>Type</span><a href="#getteratype" 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="getteratype-1"><span class="tsd-kind-call-signature">getTeraType</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="../enums/enums_pokemon-type.PokemonType.html" class="tsd-signature-type tsd-kind-enum">PokemonType</a><a href="#getteratype-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/enums_pokemon-type.PokemonType.html" class="tsd-signature-type tsd-kind-enum">PokemonType</a></h4><p>the pokemon's current tera <a href="../enums/enums_pokemon-type.PokemonType.html" class="tsd-kind-enum"><code>PokemonType</code></a></p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getteratype">getTeraType</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L2534">src/field/pokemon.ts:2534</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="gettintsprite"><span>get<wbr/>Tint<wbr/>Sprite</span><a href="#gettintsprite" 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="gettintsprite-1"><span class="tsd-kind-call-signature">getTintSprite</span><span class="tsd-signature-symbol">()</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">Sprite</span><a href="#gettintsprite-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">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Sprite</span></h4><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#gettintsprite">getTintSprite</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L1208">src/field/pokemon.ts:1208</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="gettypes"><span>get<wbr/>Types</span><a href="#gettypes" 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="gettypes-1"><span class="tsd-kind-call-signature">getTypes</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">includeTeraType</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">forDefend</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">ignoreOverride</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">useIllusion</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="../enums/enums_pokemon-type.PokemonType.html" class="tsd-signature-type tsd-kind-enum">PokemonType</a><span class="tsd-signature-symbol">[]</span><a href="#gettypes-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 types of a pokemon</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">includeTeraType</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span><div class="tsd-comment tsd-typography"><p><code>true</code> to include tera-formed type; Default: <code>false</code></p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">forDefend</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span><div class="tsd-comment tsd-typography"><p><code>true</code> if the pokemon is defending from an attack; Default: <code>false</code></p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">ignoreOverride</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span><div class="tsd-comment tsd-typography"><p>If <code>true</code>, ignore ability changing effects; Default: <code>false</code></p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">useIllusion</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span><div class="tsd-comment tsd-typography"><p><code>true</code> to return the types of the illusion instead of the actual types; Default: <code>false</code></p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../enums/enums_pokemon-type.PokemonType.html" class="tsd-signature-type tsd-kind-enum">PokemonType</a><span class="tsd-signature-symbol">[]</span></h4><p>array of <a href="../enums/enums_pokemon-type.PokemonType.html" class="tsd-kind-enum"><code>PokemonType</code></a></p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#gettypes">getTypes</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L2084">src/field/pokemon.ts:2084</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getunlockedeggmoves"><span>get<wbr/>Unlocked<wbr/>Egg<wbr/>Moves</span><a href="#getunlockedeggmoves" 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="getunlockedeggmoves-1"><span class="tsd-kind-call-signature">getUnlockedEggMoves</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="../enums/enums_moves.Moves.html" class="tsd-signature-type tsd-kind-enum">Moves</a><span class="tsd-signature-symbol">[]</span><a href="#getunlockedeggmoves-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>Checks which egg moves have been unlocked for the <a href="field_pokemon.default.html" class="tsd-kind-class"><code>Pokemon</code></a> based
|
||
on the species it was met at or by the first <a href="field_pokemon.default.html" class="tsd-kind-class"><code>Pokemon</code></a> in its evolution
|
||
line that can act as a starter and provides those egg moves.</p>
|
||
</div><h4 class="tsd-returns-title">Returns <a href="../enums/enums_moves.Moves.html" class="tsd-signature-type tsd-kind-enum">Moves</a><span class="tsd-signature-symbol">[]</span></h4><p>an array of <a href="../enums/enums_moves.Moves.html" class="tsd-kind-enum"><code>Moves</code></a>, the length of which is determined by how many
|
||
egg moves are unlocked for that species.</p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getunlockedeggmoves">getUnlockedEggMoves</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L2033">src/field/pokemon.ts:2033</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getvariant"><span>get<wbr/>Variant</span><a href="#getvariant" 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="getvariant-1"><span class="tsd-kind-call-signature">getVariant</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">useIllusion</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/sprites_variant.Variant.html" class="tsd-signature-type tsd-kind-type-alias">Variant</a><a href="#getvariant-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">useIllusion</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span><div class="tsd-comment tsd-typography"><p>Whether we want the fake or real variant (illusion ability).</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../types/sprites_variant.Variant.html" class="tsd-signature-type tsd-kind-type-alias">Variant</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getvariant">getVariant</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L1929">src/field/pokemon.ts:1929</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="getweight"><span>get<wbr/>Weight</span><a href="#getweight" 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="getweight-1"><span class="tsd-kind-call-signature">getWeight</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><a href="#getweight-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 weight of the Pokemon with subtractive modifiers (Autotomize) happening first
|
||
and then multiplicative modifiers happening after (Heavy Metal and Light Metal)</p>
|
||
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>the kg of the Pokemon (minimum of 0.1)</p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getweight">getWeight</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L2517">src/field/pokemon.ts:2517</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="getworldpoint"><span>get<wbr/>World<wbr/>Point</span><a href="#getworldpoint" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="getworldpoint-1"><span class="tsd-kind-call-signature">getWorldPoint</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">point</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Vector2</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">tempMatrix</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">TransformMatrix</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">parentMatrix</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">TransformMatrix</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">Vector2</span><a href="#getworldpoint-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 world position of this Game Object, factoring in any parent Containers.</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">point</span>: <span class="tsd-signature-type">Vector2</span></span><div class="tsd-comment tsd-typography"><p>A Vector2, or point-like object, to store the result in.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">tempMatrix</span>: <span class="tsd-signature-type">TransformMatrix</span></span><div class="tsd-comment tsd-typography"><p>A temporary matrix to hold the Game Object's values.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">parentMatrix</span>: <span class="tsd-signature-type">TransformMatrix</span></span><div class="tsd-comment tsd-typography"><p>A temporary matrix to hold parent values.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Vector2</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getworldpoint">getWorldPoint</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17887</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="getworldtransformmatrix"><span>get<wbr/>World<wbr/>Transform<wbr/>Matrix</span><a href="#getworldtransformmatrix" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="getworldtransformmatrix-1"><span class="tsd-kind-call-signature">getWorldTransformMatrix</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">tempMatrix</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">TransformMatrix</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">parentMatrix</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">TransformMatrix</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">TransformMatrix</span><a href="#getworldtransformmatrix-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 world transform matrix for this Game Object, factoring in any parent Containers.</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">tempMatrix</span>: <span class="tsd-signature-type">TransformMatrix</span></span><div class="tsd-comment tsd-typography"><p>The matrix to populate with the values from this Game Object.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">parentMatrix</span>: <span class="tsd-signature-type">TransformMatrix</span></span><div class="tsd-comment tsd-typography"><p>A temporary matrix to hold parent values during the calculations.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">TransformMatrix</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#getworldtransformmatrix">getWorldTransformMatrix</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17863</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="handlebosssegmentcleared"><span>handle<wbr/>Boss<wbr/>Segment<wbr/>Cleared</span><a href="#handlebosssegmentcleared" 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="handlebosssegmentcleared-1"><span class="tsd-kind-call-signature">handleBossSegmentCleared</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">segmentIndex</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><a href="#handlebosssegmentcleared-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>Go through a boss' health segments and give stats boosts for each newly cleared segment
|
||
The base boost is 1 to a random stat that's not already maxed out per broken shield
|
||
For Pokemon with 3 health segments or more, breaking the last shield gives +2 instead
|
||
For Pokemon with 5 health segments or more, breaking the last two shields give +2 each</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">segmentIndex</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>index of the segment to get down to (0 = no shield left, 1 = 1 shield left, etc.)</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L7660">src/field/pokemon.ts:7660</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="hasability"><span>has<wbr/>Ability</span><a href="#hasability" 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="hasability-1"><span class="tsd-kind-call-signature">hasAbility</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">ability</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">canApply</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">ignoreOverride</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">boolean</span><a href="#hasability-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>Checks whether a pokemon has the specified ability and it's in effect. Accounts for all the various
|
||
effects which can affect whether an ability will be present or in effect, and both passive and
|
||
non-passive. This is the primary way to check whether a pokemon has a particular ability.</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">ability</span>: <a href="../enums/enums_abilities.Abilities.html" class="tsd-signature-type tsd-kind-enum">Abilities</a></span><div class="tsd-comment tsd-typography"><p>The ability to check for</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">canApply</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></span><div class="tsd-comment tsd-typography"><p>Whether to check if the ability is currently active; default <code>true</code></p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">ignoreOverride</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span><div class="tsd-comment tsd-typography"><p>Whether to ignore ability changing effects; default <code>false</code></p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p><code>true</code> if the ability is present and active</p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#hasability">hasAbility</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L2460">src/field/pokemon.ts:2460</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="hasabilitywithattr"><span>has<wbr/>Ability<wbr/>With<wbr/>Attr</span><a href="#hasabilitywithattr" 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="hasabilitywithattr-1"><span class="tsd-kind-call-signature">hasAbilityWithAttr</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">attrType</span><span class="tsd-signature-symbol">:</span> <a href="../types/utils_common.Constructor.html" class="tsd-signature-type tsd-kind-type-alias">Constructor</a><span class="tsd-signature-symbol"><</span><a href="data_abilities_ab-attrs_ab-attr.AbAttr.html" class="tsd-signature-type tsd-kind-class">AbAttr</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">canApply</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">ignoreOverride</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">boolean</span><a href="#hasabilitywithattr-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>Checks whether a pokemon has an ability with the specified attribute and it's in effect.
|
||
Accounts for all the various effects which can affect whether an ability will be present or
|
||
in effect, and both passive and non-passive. This is one of the two primary ways to check
|
||
whether a pokemon has a particular ability.</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">attrType</span>: <a href="../types/utils_common.Constructor.html" class="tsd-signature-type tsd-kind-type-alias">Constructor</a><span class="tsd-signature-symbol"><</span><a href="data_abilities_ab-attrs_ab-attr.AbAttr.html" class="tsd-signature-type tsd-kind-class">AbAttr</a><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>The <a href="data_abilities_ab-attrs_ab-attr.AbAttr.html" class="tsd-kind-class">ability attribute</a> to check for</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">canApply</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></span><div class="tsd-comment tsd-typography"><p>Whether to check if the ability is currently active; default <code>true</code></p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">ignoreOverride</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span><div class="tsd-comment tsd-typography"><p>Whether to ignore ability changing effects; default <code>false</code></p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p><code>true</code> if an ability with the given <a href="data_abilities_ab-attrs_ab-attr.AbAttr.html" class="tsd-kind-class"><code>AbAttr</code></a> is present and active</p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#hasabilitywithattr">hasAbilityWithAttr</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L2491">src/field/pokemon.ts:2491</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="hasfusionspecies"><span>has<wbr/>Fusion<wbr/>Species</span><a href="#hasfusionspecies" 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="hasfusionspecies-1"><span class="tsd-kind-call-signature">hasFusionSpecies</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">species</span><span class="tsd-signature-symbol">:</span> <a href="../enums/enums_species.Species.html" class="tsd-signature-type tsd-kind-enum">Species</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#hasfusionspecies-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>Checks if the <a href="field_pokemon.default.html" class="tsd-kind-class"><code>Pokemon</code></a> has a fusion with the specified <a href="../enums/enums_species.Species.html" class="tsd-kind-enum"><code>Species</code></a>.</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">species</span>: <a href="../enums/enums_species.Species.html" class="tsd-signature-type tsd-kind-enum">Species</a></span><div class="tsd-comment tsd-typography"><p>the pokemon <a href="../enums/enums_species.Species.html" class="tsd-kind-enum"><code>Species</code></a> to check</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p><code>true</code> if the <a href="field_pokemon.default.html" class="tsd-kind-class"><code>Pokemon</code></a> has a fusion with the specified <a href="../enums/enums_species.Species.html" class="tsd-kind-enum"><code>Species</code></a>, <code>false</code> otherwise</p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#hasfusionspecies">hasFusionSpecies</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L1974">src/field/pokemon.ts:1974</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="haspassive"><span>has<wbr/>Passive</span><a href="#haspassive" 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="haspassive-1"><span class="tsd-kind-call-signature">hasPassive</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#haspassive-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>Checks if a pokemon has a passive either from:</p>
|
||
<ul>
|
||
<li>bought with starter candy</li>
|
||
<li>set by override</li>
|
||
<li>is a boss pokemon</li>
|
||
</ul>
|
||
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p><code>true</code> if the Pokemon has a passive</p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#haspassive">hasPassive</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L2355">src/field/pokemon.ts:2355</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="hassameabilityinrootform"><span>has<wbr/>Same<wbr/>Ability<wbr/>In<wbr/>Root<wbr/>Form</span><a href="#hassameabilityinrootform" 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="hassameabilityinrootform-1"><span class="tsd-kind-call-signature">hasSameAbilityInRootForm</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> <span class="tsd-signature-type">boolean</span><a href="#hassameabilityinrootform-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>Checks whether or not the Pokemon's root form has the same ability</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>the given ability index we are checking</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>true if the abilities are the same</p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#hassameabilityinrootform">hasSameAbilityInRootForm</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L6361">src/field/pokemon.ts:6361</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="hasspecies"><span>has<wbr/>Species</span><a href="#hasspecies" 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="hasspecies-1"><span class="tsd-kind-call-signature">hasSpecies</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">species</span><span class="tsd-signature-symbol">:</span> <a href="../enums/enums_species.Species.html" class="tsd-signature-type tsd-kind-enum">Species</a><span class="tsd-signature-symbol">,</span> <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><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#hasspecies-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>Checks if the <a href="field_pokemon.default.html" class="tsd-kind-class"><code>Pokemon</code></a> has is the specified <a href="../enums/enums_species.Species.html" class="tsd-kind-enum"><code>Species</code></a> or is fused with it.</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">species</span>: <a href="../enums/enums_species.Species.html" class="tsd-signature-type tsd-kind-enum">Species</a></span><div class="tsd-comment tsd-typography"><p>the pokemon <a href="../enums/enums_species.Species.html" class="tsd-kind-enum"><code>Species</code></a> to check</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">formKey</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>If provided, requires the species to be in that form</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p><code>true</code> if the pokemon is the species or is fused with it, <code>false</code> otherwise</p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#hasspecies">hasSpecies</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L1984">src/field/pokemon.ts:1984</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="hastrainer"><span>has<wbr/>Trainer</span><a href="#hastrainer" 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="hastrainer-1"><span class="tsd-kind-call-signature">hasTrainer</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#hastrainer-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>Overrides <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#hastrainer">hasTrainer</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L7553">src/field/pokemon.ts:7553</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="heal"><span>heal</span><a href="#heal" 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="heal-1"><span class="tsd-kind-call-signature">heal</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">amount</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">number</span><a href="#heal-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">amount</span>: <span class="tsd-signature-type">number</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#heal">heal</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L4817">src/field/pokemon.ts:4817</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="hideinfo"><span>hide<wbr/>Info</span><a href="#hideinfo" 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="hideinfo-1"><span class="tsd-kind-call-signature">hideInfo</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#hideinfo-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">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#hideinfo">hideInfo</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L3841">src/field/pokemon.ts:3841</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="incdata"><span>inc<wbr/>Data</span><a href="#incdata" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="incdata-1"><span class="tsd-kind-call-signature">incData</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">amount</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">this</span><a href="#incdata-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>Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.</p>
|
||
<p>If the Game Object has not been enabled for data (via <code>setDataEnabled</code>) then it will be enabled
|
||
before setting the value.</p>
|
||
<p>If the key doesn't already exist in the Data Manager then it is created.</p>
|
||
<p>When the value is first set, a <code>setdata</code> event is emitted from this Game Object.</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">key</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The key to change the value for.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">amount</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The amount to increase the given key by. Pass a negative value to decrease the key. Default 1.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#incdata">incData</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:20100</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="init"><span>init</span><a href="#init" 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="init-1"><span class="tsd-kind-call-signature">init</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#init-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">void</span></h4><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#init">init</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L589">src/field/pokemon.ts:589</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="initbattleinfo"><span>init<wbr/>Battle<wbr/>Info</span><a href="#initbattleinfo" 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="initbattleinfo-1"><span class="tsd-kind-call-signature">initBattleInfo</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#initbattleinfo-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">void</span></h4><aside class="tsd-sources"><p>Overrides <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#initbattleinfo">initBattleInfo</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L7158">src/field/pokemon.ts:7158</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="initpostpipeline"><span>init<wbr/>Post<wbr/>Pipeline</span><a href="#initpostpipeline" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="initpostpipeline-1"><span class="tsd-kind-call-signature">initPostPipeline</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">preFX</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> <span class="tsd-signature-type">void</span><a href="#initpostpipeline-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>This should only be called during the instantiation of the Game Object.</p>
|
||
<p>It is called by default by all core Game Objects and doesn't need
|
||
calling again.</p>
|
||
<p>After that, use <code>setPostPipeline</code>.</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">preFX</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>Does this Game Object support Pre FX? Default false.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#initpostpipeline">initPostPipeline</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17645</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="initshinysparkle"><span>init<wbr/>Shiny<wbr/>Sparkle</span><a href="#initshinysparkle" 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="initshinysparkle-1"><span class="tsd-kind-call-signature">initShinySparkle</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#initshinysparkle-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">void</span></h4><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#initshinysparkle">initShinySparkle</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L1275">src/field/pokemon.ts:1275</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="isactive"><span>is<wbr/>Active</span><a href="#isactive" 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="isactive-1"><span class="tsd-kind-call-signature">isActive</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">onField</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> <span class="tsd-signature-type">boolean</span><a href="#isactive-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>Checks if this <a href="field_pokemon.default.html" class="tsd-kind-class"><code>Pokemon</code></a> is allowed in battle (ie: not fainted, and allowed under any active challenges).</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">onField</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span><div class="tsd-comment tsd-typography"><p><code>true</code> to also check if the pokemon is currently on the field; default <code>false</code></p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p><code>true</code> if the pokemon is "active", as described above.
|
||
Returns <code>false</code> if there is no active <a href="battle-scene.default.html" class="tsd-kind-class"><code>BattleScene</code></a> or the pokemon is disallowed.</p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#isactive">isActive</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L683">src/field/pokemon.ts:683</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="isallowedinbattle"><span>is<wbr/>Allowed<wbr/>In<wbr/>Battle</span><a href="#isallowedinbattle" 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="isallowedinbattle-1"><span class="tsd-kind-call-signature">isAllowedInBattle</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#isallowedinbattle-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>Check if this pokemon is both not fainted and allowed to be in battle based on currently active challenges.</p>
|
||
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p><code>true</code> if pokemon is allowed in battle</p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#isallowedinbattle">isAllowedInBattle</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L658">src/field/pokemon.ts:658</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="isallowedinchallenge"><span>is<wbr/>Allowed<wbr/>In<wbr/>Challenge</span><a href="#isallowedinchallenge" 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="isallowedinchallenge-1"><span class="tsd-kind-call-signature">isAllowedInChallenge</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#isallowedinchallenge-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>Check if this pokemon is allowed based on any active challenges.
|
||
It's usually better to call <a href="field_pokemon.default.html#isallowedinbattle" class="tsd-kind-method"><code>()</code></a></p>
|
||
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p><code>true</code> if pokemon is allowed in battle</p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#isallowedinchallenge">isAllowedInChallenge</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L667">src/field/pokemon.ts:667</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="isbaseshiny"><span>is<wbr/>Base<wbr/>Shiny</span><a href="#isbaseshiny" 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="isbaseshiny-1"><span class="tsd-kind-call-signature">isBaseShiny</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">useIllusion</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> <span class="tsd-signature-type">boolean</span><a href="#isbaseshiny-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">useIllusion</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">boolean</span></h4><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#isbaseshiny">isBaseShiny</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L1897">src/field/pokemon.ts:1897</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="isboss"><span>is<wbr/>Boss</span><a href="#isboss" 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="isboss-1"><span class="tsd-kind-call-signature">isBoss</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#isboss-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>Overrides <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#isboss">isBoss</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L7557">src/field/pokemon.ts:7557</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="isbossimmune"><span>is<wbr/>Boss<wbr/>Immune</span><a href="#isbossimmune" 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="isbossimmune-1"><span class="tsd-kind-call-signature">isBossImmune</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#isbossimmune-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="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#isbossimmune">isBossImmune</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L4823">src/field/pokemon.ts:4823</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="isdoubleshiny"><span>is<wbr/>Double<wbr/>Shiny</span><a href="#isdoubleshiny" 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="isdoubleshiny-1"><span class="tsd-kind-call-signature">isDoubleShiny</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">useIllusion</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> <span class="tsd-signature-type">boolean</span><a href="#isdoubleshiny-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">useIllusion</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span><div class="tsd-comment tsd-typography"><p>Whether we want the fake or real shininess (illusion ability).</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p><code>true</code> if the <a href="field_pokemon.default.html" class="tsd-kind-class"><code>Pokemon</code></a> is shiny and the fusion is shiny as well, <code>false</code> otherwise</p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#isdoubleshiny">isDoubleShiny</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L1918">src/field/pokemon.ts:1918</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="isfainted"><span>is<wbr/>Fainted</span><a href="#isfainted" 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="isfainted-1"><span class="tsd-kind-call-signature">isFainted</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">checkStatus</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> <span class="tsd-signature-type">boolean</span><a href="#isfainted-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>Checks if a pokemon is fainted (ie: its <code>hp <= 0</code>).
|
||
It's usually better to call <a href="field_pokemon.default.html#isallowedinbattle" class="tsd-kind-method"><code>()</code></a></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">checkStatus</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span><div class="tsd-comment tsd-typography"><p><code>true</code> to also check that the pokemon's status is <a href="../enums/enums_status-effect.StatusEffect.html#faint" class="tsd-kind-enum-member"><code>StatusEffect.FAINT</code></a></p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p><code>true</code> if the pokemon is fainted</p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#isfainted">isFainted</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L647">src/field/pokemon.ts:647</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="isfullhp"><span>is<wbr/>Full<wbr/>Hp</span><a href="#isfullhp" 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="isfullhp-1"><span class="tsd-kind-call-signature">isFullHp</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#isfullhp-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="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#isfullhp">isFullHp</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L1830">src/field/pokemon.ts:1830</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="isfusion"><span>is<wbr/>Fusion</span><a href="#isfusion" 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="isfusion-1"><span class="tsd-kind-call-signature">isFusion</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">useIllusion</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> <span class="tsd-signature-type">boolean</span><a href="#isfusion-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">useIllusion</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">boolean</span></h4><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#isfusion">isFusion</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L1953">src/field/pokemon.ts:1953</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="isfusionshiny"><span>is<wbr/>Fusion<wbr/>Shiny</span><a href="#isfusionshiny" 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="isfusionshiny-1"><span class="tsd-kind-call-signature">isFusionShiny</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">useIllusion</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> <span class="tsd-signature-type">boolean</span><a href="#isfusionshiny-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">useIllusion</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">boolean</span></h4><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#isfusionshiny">isFusionShiny</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L1905">src/field/pokemon.ts:1905</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="isgrounded"><span>is<wbr/>Grounded</span><a href="#isgrounded" 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="isgrounded-1"><span class="tsd-kind-call-signature">isGrounded</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#isgrounded-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="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#isgrounded">isGrounded</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L2564">src/field/pokemon.ts:2564</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="ismax"><span>is<wbr/>Max</span><a href="#ismax" 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="ismax-1"><span class="tsd-kind-call-signature">isMax</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#ismax-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="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#ismax">isMax</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L4827">src/field/pokemon.ts:4827</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="ismega"><span>is<wbr/>Mega</span><a href="#ismega" 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="ismega-1"><span class="tsd-kind-call-signature">isMega</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#ismega-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="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#ismega">isMega</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L4832">src/field/pokemon.ts:4832</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="ismoverestricted"><span>is<wbr/>Move<wbr/>Restricted</span><a href="#ismoverestricted" 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="ismoverestricted-1"><span class="tsd-kind-call-signature">isMoveRestricted</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">moveId</span><span class="tsd-signature-symbol">:</span> <a href="../enums/enums_moves.Moves.html" class="tsd-signature-type tsd-kind-enum">Moves</a><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">pokemon</span><span class="tsd-signature-symbol">?:</span> <a href="field_pokemon.default.html" class="tsd-signature-type tsd-kind-class">default</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#ismoverestricted-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 whether the given move is currently disabled for this Pokemon.</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">moveId</span>: <a href="../enums/enums_moves.Moves.html" class="tsd-signature-type tsd-kind-enum">Moves</a></span><div class="tsd-comment tsd-typography"><p>The <a href="../enums/enums_moves.Moves.html" class="tsd-kind-enum"><code>Moves</code></a> ID of the move to check</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">pokemon</span>: <a href="field_pokemon.default.html" class="tsd-signature-type tsd-kind-class">default</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p><code>true</code> if the move is disabled for this Pokemon, otherwise <code>false</code></p>
|
||
<div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><h4 class="tsd-anchor-link" id="see-5">See<a href="#see-5" 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></h4><p><a href="data_battler-tags.MoveRestrictionBattlerTag.html" class="tsd-kind-class"><code>MoveRestrictionBattlerTag</code></a></p>
|
||
</div></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#ismoverestricted">isMoveRestricted</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L5060">src/field/pokemon.ts:5060</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="ismovetargetrestricted"><span>is<wbr/>Move<wbr/>Target<wbr/>Restricted</span><a href="#ismovetargetrestricted" 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="ismovetargetrestricted-1"><span class="tsd-kind-call-signature">isMoveTargetRestricted</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">moveId</span><span class="tsd-signature-symbol">:</span> <a href="../enums/enums_moves.Moves.html" class="tsd-signature-type tsd-kind-enum">Moves</a><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">user</span><span class="tsd-signature-symbol">:</span> <a href="field_pokemon.default.html" class="tsd-signature-type tsd-kind-class">default</a><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">target</span><span class="tsd-signature-symbol">:</span> <a href="field_pokemon.default.html" class="tsd-signature-type tsd-kind-class">default</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#ismovetargetrestricted-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 whether the given move is currently disabled for the user based on the player's target selection</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">moveId</span>: <a href="../enums/enums_moves.Moves.html" class="tsd-signature-type tsd-kind-enum">Moves</a></span><div class="tsd-comment tsd-typography"><p>The <a href="../enums/enums_moves.Moves.html" class="tsd-kind-enum"><code>Moves</code></a> ID of the move to check</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">user</span>: <a href="field_pokemon.default.html" class="tsd-signature-type tsd-kind-class">default</a></span><div class="tsd-comment tsd-typography"><p>The move user</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">target</span>: <a href="field_pokemon.default.html" class="tsd-signature-type tsd-kind-class">default</a></span><div class="tsd-comment tsd-typography"><p>The target of the move</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p><code>true</code> if the move is disabled for this Pokemon due to the player's target selection</p>
|
||
<div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><h4 class="tsd-anchor-link" id="see-6">See<a href="#see-6" 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></h4><p><a href="data_battler-tags.MoveRestrictionBattlerTag.html" class="tsd-kind-class"><code>MoveRestrictionBattlerTag</code></a></p>
|
||
</div></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#ismovetargetrestricted">isMoveTargetRestricted</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L5075">src/field/pokemon.ts:5075</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="isoffsetbysubstitute"><span>is<wbr/>Offset<wbr/>By<wbr/>Substitute</span><a href="#isoffsetbysubstitute" 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="isoffsetbysubstitute-1"><span class="tsd-kind-call-signature">isOffsetBySubstitute</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#isoffsetbysubstitute-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>Returns whether or not the Pokemon's position on the field is offset because
|
||
the Pokemon has a Substitute active.</p>
|
||
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><h4 class="tsd-anchor-link" id="see-7">See<a href="#see-7" 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></h4><p><a href="data_battler-tags.SubstituteTag.html" class="tsd-kind-class"><code>SubstituteTag</code></a></p>
|
||
</div></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#isoffsetbysubstitute">isOffsetBySubstitute</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L1347">src/field/pokemon.ts:1347</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><br/> <span class="tsd-kind-parameter">type</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">includeTeraType</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">forDefend</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">ignoreOverride</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">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-comment tsd-typography"><p>Checks if the pokemon's typing includes the specified type</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">type</span>: <a href="../enums/enums_pokemon-type.PokemonType.html" class="tsd-signature-type tsd-kind-enum">PokemonType</a></span><div class="tsd-comment tsd-typography"><p><a href="../enums/enums_pokemon-type.PokemonType.html" class="tsd-kind-enum"><code>PokemonType</code></a> to check</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">includeTeraType</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></span><div class="tsd-comment tsd-typography"><p><code>true</code> to include tera-formed type; Default: <code>true</code></p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">forDefend</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span><div class="tsd-comment tsd-typography"><p><code>true</code> if the pokemon is defending from an attack; Default: <code>false</code></p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">ignoreOverride</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span><div class="tsd-comment tsd-typography"><p>If <code>true</code>, ignore ability changing effects; Default: <code>false</code></p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p><code>true</code> if the Pokemon's type matches</p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#isoftype">isOfType</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L2214">src/field/pokemon.ts:2214</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="isonfield"><span>is<wbr/>On<wbr/>Field</span><a href="#isonfield" 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="isonfield-1"><span class="tsd-kind-call-signature">isOnField</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#isonfield-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="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#isonfield">isOnField</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L631">src/field/pokemon.ts:631</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="isopponent"><span>is<wbr/>Opponent</span><a href="#isopponent" 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="isopponent-1"><span class="tsd-kind-call-signature">isOpponent</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">target</span><span class="tsd-signature-symbol">:</span> <a href="field_pokemon.default.html" class="tsd-signature-type tsd-kind-class">default</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#isopponent-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>Compares if <code>this</code> and <a href="field_pokemon.PlayerPokemon.html#isopponent-1" class="tsd-kind-parameter"><code>target</code></a> are on the same team.</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">target</span>: <a href="field_pokemon.default.html" class="tsd-signature-type tsd-kind-class">default</a></span><div class="tsd-comment tsd-typography"><p>the <a href="field_pokemon.default.html" class="tsd-kind-class"><code>Pokemon</code></a> to compare against.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p><code>true</code> if the two pokemon are allies, <code>false</code> otherwise</p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#isopponent">isOpponent</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L3930">src/field/pokemon.ts:3930</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="isoppositegender"><span>is<wbr/>Opposite<wbr/>Gender</span><a href="#isoppositegender" 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="isoppositegender-1"><span class="tsd-kind-call-signature">isOppositeGender</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">pokemon</span><span class="tsd-signature-symbol">:</span> <a href="field_pokemon.default.html" class="tsd-signature-type tsd-kind-class">default</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#isoppositegender-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">pokemon</span>: <a href="field_pokemon.default.html" class="tsd-signature-type tsd-kind-class">default</a></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="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#isoppositegender">isOppositeGender</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L5415">src/field/pokemon.ts:5415</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="isplayer"><span>is<wbr/>Player</span><a href="#isplayer" 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="isplayer-1"><span class="tsd-kind-call-signature">isPlayer</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#isplayer-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>Overrides <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#isplayer">isPlayer</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L7549">src/field/pokemon.ts:7549</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="issafeguarded"><span>is<wbr/>Safeguarded</span><a href="#issafeguarded" 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="issafeguarded-1"><span class="tsd-kind-call-signature">isSafeguarded</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">attacker</span><span class="tsd-signature-symbol">:</span> <a href="field_pokemon.default.html" class="tsd-signature-type tsd-kind-class">default</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#issafeguarded-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>Checks if this Pokemon is protected by Safeguard</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">attacker</span>: <a href="field_pokemon.default.html" class="tsd-signature-type tsd-kind-class">default</a></span><div class="tsd-comment tsd-typography"><p>the <a href="field_pokemon.default.html" class="tsd-kind-class"><code>Pokemon</code></a> inflicting status on this Pokemon</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p><code>true</code> if this Pokemon is protected by Safeguard; <code>false</code> otherwise.</p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#issafeguarded">isSafeguarded</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L5709">src/field/pokemon.ts:5709</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="isshiny"><span>is<wbr/>Shiny</span><a href="#isshiny" 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="isshiny-1"><span class="tsd-kind-call-signature">isShiny</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">useIllusion</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> <span class="tsd-signature-type">boolean</span><a href="#isshiny-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">useIllusion</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span><div class="tsd-comment tsd-typography"><p>Whether we want the fake or real shininess (illusion ability).</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#isshiny">isShiny</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L1889">src/field/pokemon.ts:1889</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="istrapped"><span>is<wbr/>Trapped</span><a href="#istrapped" 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="istrapped-1"><span class="tsd-kind-call-signature">isTrapped</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">trappedAbMessages</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">simulated</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> <span class="tsd-signature-type">boolean</span><a href="#istrapped-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>Determines whether this Pokemon is prevented from running or switching due
|
||
to effects from moves and/or abilities.</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">trappedAbMessages</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></span><div class="tsd-comment tsd-typography"><p>If defined, ability trigger messages
|
||
(e.g. from Shadow Tag) are forwarded through this array.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">simulated</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></span><div class="tsd-comment tsd-typography"><p>If <code>true</code>, applies abilities via simulated calls.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p><code>true</code> if the pokemon is trapped</p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#istrapped">isTrapped</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L2582">src/field/pokemon.ts:2582</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="iterate"><span>iterate</span><a href="#iterate" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="iterate-1"><span class="tsd-kind-call-signature">iterate</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">context</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#iterate-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>Passes all Game Objects in this Container to the given callback.</p>
|
||
<p>Only use this method when you absolutely know that the Container will not be modified during
|
||
the iteration, i.e. by removing or adding to its contents.</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">callback</span>: <span class="tsd-signature-type">Function</span></span><div class="tsd-comment tsd-typography"><p>The function to call.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">context</span>: <span class="tsd-signature-type">object</span></span><div class="tsd-comment tsd-typography"><p>Value to use as <code>this</code> when executing callback.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>Additional arguments that will be passed to the callback, after the child.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#iterate">iterate</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17240</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="lapsetag"><span>lapse<wbr/>Tag</span><a href="#lapsetag" 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="lapsetag-1"><span class="tsd-kind-call-signature">lapseTag</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">tagType</span><span class="tsd-signature-symbol">:</span> <a href="../enums/enums_battler-tag-type.BattlerTagType.html" class="tsd-signature-type tsd-kind-enum">BattlerTagType</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#lapsetag-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>Tick down the first <a href="data_battler-tags.BattlerTag.html" class="tsd-kind-class"><code>BattlerTag</code></a> found matching the given <a href="../enums/enums_battler-tag-type.BattlerTagType.html" class="tsd-kind-enum"><code>BattlerTagType</code></a>,
|
||
removing it if its duration goes below 0.</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">tagType</span>: <a href="../enums/enums_battler-tag-type.BattlerTagType.html" class="tsd-signature-type tsd-kind-enum">BattlerTagType</a></span><div class="tsd-comment tsd-typography"><p>the <a href="../enums/enums_battler-tag-type.BattlerTagType.html" class="tsd-kind-enum"><code>BattlerTagType</code></a> to check against</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p><code>true</code> if the tag was present</p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#lapsetag">lapseTag</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L4945">src/field/pokemon.ts:4945</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="lapsetags"><span>lapse<wbr/>Tags</span><a href="#lapsetags" 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="lapsetags-1"><span class="tsd-kind-call-signature">lapseTags</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">lapseType</span><span class="tsd-signature-symbol">:</span> <a href="../enums/data_battler-tags.BattlerTagLapseType.html" class="tsd-signature-type tsd-kind-enum">BattlerTagLapseType</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#lapsetags-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>Tick down all BattlerTags matching the given <a href="../enums/data_battler-tags.BattlerTagLapseType.html" class="tsd-kind-enum"><code>BattlerTagLapseType</code></a>,
|
||
removing any whose durations fall below 0.</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">lapseType</span>: <a href="../enums/data_battler-tags.BattlerTagLapseType.html" class="tsd-signature-type tsd-kind-enum">BattlerTagLapseType</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#lapsetags">lapseTags</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L4964">src/field/pokemon.ts:4964</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="leavefield"><span>leave<wbr/>Field</span><a href="#leavefield" 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="leavefield-1"><span class="tsd-kind-call-signature">leaveField</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">clearEffects</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">hideInfo</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">destroy</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> <span class="tsd-signature-type">void</span><a href="#leavefield-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>Causes a Pokemon to leave the field (such as in preparation for a switch out/escape).</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">clearEffects</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></span><div class="tsd-comment tsd-typography"><p>Indicates if effects should be cleared (true) or passed
|
||
to the next pokemon, such as during a baton pass (false)</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">hideInfo</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></span><div class="tsd-comment tsd-typography"><p>Indicates if this should also play the animation to hide the Pokemon's
|
||
info container.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">destroy</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">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#leavefield">leaveField</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L6320">src/field/pokemon.ts:6320</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="listenercount"><span>listener<wbr/>Count</span><a href="#listenercount" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="listenercount-1"><span class="tsd-kind-call-signature">listenerCount</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</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">symbol</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><a href="#listenercount-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>Return the number of listeners listening to a given event.</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">event</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">symbol</span></span><div class="tsd-comment tsd-typography"><p>The event name.</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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#listenercount">listenerCount</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:9948</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="listeners"><span>listeners</span><a href="#listeners" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="listeners-1"><span class="tsd-kind-call-signature">listeners</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</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">symbol</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">[]</span><a href="#listeners-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>Return the listeners registered for a given event.</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">event</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">symbol</span></span><div class="tsd-comment tsd-typography"><p>The event name.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">[]</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#listeners">listeners</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:9942</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><span class="tsd-kind-parameter">ignoreOverride</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">useIllusion</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> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></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">ignoreOverride</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></span></li><li><span><span class="tsd-kind-parameter">useIllusion</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span><div class="tsd-comment tsd-typography"><p>Whether we want the illusion or not.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#loadassets">loadAssets</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L847">src/field/pokemon.ts:847</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="losehelditem"><span>lose<wbr/>Held<wbr/>Item</span><a href="#losehelditem" 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="losehelditem-1"><span class="tsd-kind-call-signature">loseHeldItem</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">heldItem</span><span class="tsd-signature-symbol">:</span> <a href="modifier_modifier.PokemonHeldItemModifier.html" class="tsd-signature-type tsd-kind-class">PokemonHeldItemModifier</a><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">forBattle</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> <span class="tsd-signature-type">boolean</span><a href="#losehelditem-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>Reduces one of this Pokemon's held item stacks by 1, and removes the item if applicable.
|
||
Does nothing if this Pokemon is somehow not the owner of the held item.</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">heldItem</span>: <a href="modifier_modifier.PokemonHeldItemModifier.html" class="tsd-signature-type tsd-kind-class">PokemonHeldItemModifier</a></span><div class="tsd-comment tsd-typography"><p>The item stack to be reduced by 1.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">forBattle</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></span><div class="tsd-comment tsd-typography"><p>If <code>false</code>, do not trigger in-battle effects (such as Unburden) from losing the item. For example, set this to <code>false</code> if the Pokemon is giving away the held item for a Mystery Encounter. Default is <code>true</code>.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p><code>true</code> if the item was removed successfully, <code>false</code> otherwise.</p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#losehelditem">loseHeldItem</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L6396">src/field/pokemon.ts:6396</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="moveabove"><span>move<wbr/>Above</span><a href="#moveabove" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="moveabove-1"><span class="tsd-kind-call-signature">moveAbove</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#moveabovet">T</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">GameObject</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">child1</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="field_arena.ArenaBase.html#moveabovet">T</a><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">child2</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="field_arena.ArenaBase.html#moveabovet">T</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#moveabove-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>Moves a Game Object above another one within this Container.
|
||
If the Game Object is already above the other, it isn't moved.</p>
|
||
<p>These 2 Game Objects must already be children of this Container.</p>
|
||
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="moveabovet"><span class="tsd-kind-type-parameter">T</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">GameObject</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">child1</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="field_arena.ArenaBase.html#moveabovet">T</a></span><div class="tsd-comment tsd-typography"><p>The Game Object to move above base Game Object.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">child2</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="field_arena.ArenaBase.html#moveabovet">T</a></span><div class="tsd-comment tsd-typography"><p>The base Game Object.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#moveabove">moveAbove</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17101</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="movebelow"><span>move<wbr/>Below</span><a href="#movebelow" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="movebelow-1"><span class="tsd-kind-call-signature">moveBelow</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#movebelowt">T</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">GameObject</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">child1</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="field_arena.ArenaBase.html#movebelowt">T</a><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">child2</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="field_arena.ArenaBase.html#movebelowt">T</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#movebelow-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>Moves a Game Object below another one within this Container.
|
||
If the Game Object is already below the other, it isn't moved.</p>
|
||
<p>These 2 Game Objects must already be children of this Container.</p>
|
||
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="movebelowt"><span class="tsd-kind-type-parameter">T</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">GameObject</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">child1</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="field_arena.ArenaBase.html#movebelowt">T</a></span><div class="tsd-comment tsd-typography"><p>The Game Object to move below base Game Object.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">child2</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="field_arena.ArenaBase.html#movebelowt">T</a></span><div class="tsd-comment tsd-typography"><p>The base Game Object.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#movebelow">moveBelow</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17111</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="movedown"><span>move<wbr/>Down</span><a href="#movedown" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="movedown-1"><span class="tsd-kind-call-signature">moveDown</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#movedownt">T</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">GameObject</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">child</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="field_arena.ArenaBase.html#movedownt">T</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#movedown-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>Moves the given Game Object down one place in this Container, unless it's already at the bottom.</p>
|
||
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="movedownt"><span class="tsd-kind-type-parameter">T</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">GameObject</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">child</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="field_arena.ArenaBase.html#movedownt">T</a></span><div class="tsd-comment tsd-typography"><p>The Game Object to be moved in the Container.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#movedown">moveDown</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17175</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="moveto"><span>move<wbr/>To</span><a href="#moveto" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="moveto-1"><span class="tsd-kind-call-signature">moveTo</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#movetot">T</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">GameObject</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">child</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="field_arena.ArenaBase.html#movetot">T</a><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">index</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">this</span><a href="#moveto-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>Moves a Game Object to a new position within this Container.</p>
|
||
<p>The Game Object must already be a child of this Container.</p>
|
||
<p>The Game Object is removed from its old position and inserted into the new one.
|
||
Therefore the Container size does not change. Other children will change position accordingly.</p>
|
||
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="movetot"><span class="tsd-kind-type-parameter">T</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">GameObject</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">child</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="field_arena.ArenaBase.html#movetot">T</a></span><div class="tsd-comment tsd-typography"><p>The Game Object to move.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">index</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The new position of the Game Object in this Container.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#moveto">moveTo</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17091</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="moveup"><span>move<wbr/>Up</span><a href="#moveup" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="moveup-1"><span class="tsd-kind-call-signature">moveUp</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#moveupt">T</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">GameObject</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">child</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="field_arena.ArenaBase.html#moveupt">T</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#moveup-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>Moves the given Game Object up one place in this Container, unless it's already at the top.</p>
|
||
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="moveupt"><span class="tsd-kind-type-parameter">T</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">GameObject</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">child</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="field_arena.ArenaBase.html#moveupt">T</a></span><div class="tsd-comment tsd-typography"><p>The Game Object to be moved in the Container.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#moveup">moveUp</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17169</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="off"><span>off</span><a href="#off" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="off-1"><span class="tsd-kind-call-signature">off</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</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">symbol</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">fn</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">context</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">once</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> <span class="tsd-signature-type">this</span><a href="#off-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>Remove the listeners of a given event.</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">event</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">symbol</span></span><div class="tsd-comment tsd-typography"><p>The event name.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">fn</span>: <span class="tsd-signature-type">Function</span></span><div class="tsd-comment tsd-typography"><p>Only remove the listeners that match this function.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">context</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>Only remove the listeners that have this context.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">once</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>Only remove one-time listeners.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#off">off</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:9997</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="on"><span>on</span><a href="#on" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="on-1"><span class="tsd-kind-call-signature">on</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</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">symbol</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">fn</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">context</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#on-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>Add a listener for a given event.</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">event</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">symbol</span></span><div class="tsd-comment tsd-typography"><p>The event name.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">fn</span>: <span class="tsd-signature-type">Function</span></span><div class="tsd-comment tsd-typography"><p>The listener function.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">context</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The context to invoke the listener with. Default this.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#on">on</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:9963</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="once"><span>once</span><a href="#once" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="once-1"><span class="tsd-kind-call-signature">once</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</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">symbol</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">fn</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">context</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#once-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>Add a one-time listener for a given event.</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">event</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">symbol</span></span><div class="tsd-comment tsd-typography"><p>The event name.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">fn</span>: <span class="tsd-signature-type">Function</span></span><div class="tsd-comment tsd-typography"><p>The listener function.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">context</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The context to invoke the listener with. Default this.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#once">once</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:9979</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="onchilddestroyed"><code class="tsd-tag">Protected</code><span>on<wbr/>Child<wbr/>Destroyed</span><a href="#onchilddestroyed" 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-protected tsd-is-inherited tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="onchilddestroyed-1"><span class="tsd-kind-call-signature">onChildDestroyed</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#onchilddestroyed-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>Internal handler, called when a child is destroyed.</p>
|
||
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#onchilddestroyed">onChildDestroyed</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17305</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="playanim"><span>play<wbr/>Anim</span><a href="#playanim" 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="playanim-1"><span class="tsd-kind-call-signature">playAnim</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#playanim-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">void</span></h4><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#playanim">playAnim</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L1313">src/field/pokemon.ts:1313</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="pointtocontainer"><span>point<wbr/>To<wbr/>Container</span><a href="#pointtocontainer" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="pointtocontainer-1"><span class="tsd-kind-call-signature">pointToContainer</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">source</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Vector2Like</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">output</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Vector2Like</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Vector2Like</span><a href="#pointtocontainer-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>Takes a Point-like object, such as a Vector2, Geom.Point or object with public x and y properties,
|
||
and transforms it into the space of this Container, then returns it in the output object.</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">source</span>: <span class="tsd-signature-type">Vector2Like</span></span><div class="tsd-comment tsd-typography"><p>The Source Point to be transformed.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">output</span>: <span class="tsd-signature-type">Vector2Like</span></span><div class="tsd-comment tsd-typography"><p>A destination object to store the transformed point in. If none given a Vector2 will be created and returned.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Vector2Like</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#pointtocontainer">pointToContainer</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:16960</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="populatevariantcolorcache"><span>populate<wbr/>Variant<wbr/>Color<wbr/>Cache</span><a href="#populatevariantcolorcache" 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="populatevariantcolorcache-1"><span class="tsd-kind-call-signature">populateVariantColorCache</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">cacheKey</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">useExpSprite</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">battleSpritePath</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</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"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#populatevariantcolorcache-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>Attempt to process variant sprite.</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">cacheKey</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>the cache key for the variant color sprite</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">useExpSprite</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>should the experimental sprite be used</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">battleSpritePath</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>the filename of the sprite</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#populatevariantcolorcache">populateVariantColorCache</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L969">src/field/pokemon.ts:969</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="predestroy"><code class="tsd-tag">Protected</code><span>pre<wbr/>Destroy</span><a href="#predestroy" 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-protected tsd-is-inherited tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="predestroy-1"><span class="tsd-kind-call-signature">preDestroy</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#predestroy-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>Internal destroy handler, called as part of the destroy process.</p>
|
||
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#predestroy">preDestroy</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17300</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="pushmovehistory"><span>push<wbr/>Move<wbr/>History</span><a href="#pushmovehistory" 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="pushmovehistory-1"><span class="tsd-kind-call-signature">pushMoveHistory</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">turnMove</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/field_pokemon.TurnMove.html" class="tsd-signature-type tsd-kind-interface">TurnMove</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#pushmovehistory-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">turnMove</span>: <a href="../interfaces/field_pokemon.TurnMove.html" class="tsd-signature-type tsd-kind-interface">TurnMove</a></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 <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#pushmovehistory">pushMoveHistory</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L5134">src/field/pokemon.ts:5134</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="queueimmunemessage"><span>queue<wbr/>Immune<wbr/>Message</span><a href="#queueimmunemessage" 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="queueimmunemessage-1"><span class="tsd-kind-call-signature">queueImmuneMessage</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">quiet</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">effect</span><span class="tsd-signature-symbol">?:</span> <a href="../enums/enums_status-effect.StatusEffect.html" class="tsd-signature-type tsd-kind-enum">StatusEffect</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#queueimmunemessage-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">quiet</span>: <span class="tsd-signature-type">boolean</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">effect</span>: <a href="../enums/enums_status-effect.StatusEffect.html" class="tsd-signature-type tsd-kind-enum">StatusEffect</a></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 <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#queueimmunemessage">queueImmuneMessage</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L5423">src/field/pokemon.ts:5423</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="randbattleseedint"><span>rand<wbr/>Battle<wbr/>Seed<wbr/>Int</span><a href="#randbattleseedint" 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="randbattleseedint-1"><span class="tsd-kind-call-signature">randBattleSeedInt</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">range</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">min</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">number</span><a href="#randbattleseedint-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">range</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">min</span>: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#randbattleseedint">randBattleSeedInt</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L6295">src/field/pokemon.ts:6295</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="randbattleseedintrange"><span>rand<wbr/>Battle<wbr/>Seed<wbr/>Int<wbr/>Range</span><a href="#randbattleseedintrange" 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="randbattleseedintrange-1"><span class="tsd-kind-call-signature">randBattleSeedIntRange</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">min</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">max</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">number</span><a href="#randbattleseedintrange-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>Generates a random number using the current battle's seed, or the global seed if <code>globalScene.currentBattle</code> is falsy</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">min</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The minimum integer to generate</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">max</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The maximum integer to generate</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>a random integer between <a href="field_pokemon.PlayerPokemon.html#randbattleseedintrange-1" class="tsd-kind-parameter"><code>min</code></a> and <a href="field_pokemon.PlayerPokemon.html#randbattleseedintrange-1" class="tsd-kind-parameter"><code>max</code></a> inclusive</p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#randbattleseedintrange">randBattleSeedIntRange</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L6307">src/field/pokemon.ts:6307</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="recordeatenberry"><span>record<wbr/>Eaten<wbr/>Berry</span><a href="#recordeatenberry" 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="recordeatenberry-1"><span class="tsd-kind-call-signature">recordEatenBerry</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">berryType</span><span class="tsd-signature-symbol">:</span> <a href="../enums/enums_berry-type.BerryType.html" class="tsd-signature-type tsd-kind-enum">BerryType</a><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">updateHarvest</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> <span class="tsd-signature-type">void</span><a href="#recordeatenberry-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>Record a berry being eaten for ability and move triggers.
|
||
Only tracks things that proc <em>every</em> time a berry is eaten.</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">berryType</span>: <a href="../enums/enums_berry-type.BerryType.html" class="tsd-signature-type tsd-kind-enum">BerryType</a></span><div class="tsd-comment tsd-typography"><p>The type of berry being eaten.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">updateHarvest</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></span><div class="tsd-comment tsd-typography"><p>Whether to track the berry for harvest; default <code>true</code>.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#recordeatenberry">recordEatenBerry</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L6421">src/field/pokemon.ts:6421</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="remove"><span>remove</span><a href="#remove" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="remove-1"><span class="tsd-kind-call-signature">remove</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#removet">T</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">GameObject</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">child</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="field_arena.ArenaBase.html#removet">T</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="field_arena.ArenaBase.html#removet">T</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">destroyChild</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> <span class="tsd-signature-type">this</span><a href="#remove-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>Removes the given Game Object, or array of Game Objects, from this Container.</p>
|
||
<p>The Game Objects must already be children of this Container.</p>
|
||
<p>You can also optionally call <code>destroy</code> on each Game Object that is removed from the Container.</p>
|
||
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="removet"><span class="tsd-kind-type-parameter">T</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">GameObject</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">child</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="field_arena.ArenaBase.html#removet">T</a> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="field_arena.ArenaBase.html#removet">T</a><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>The Game Object, or array of Game Objects, to be removed from the Container.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">destroyChild</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>Optionally call <code>destroy</code> on each child successfully removed from this Container. Default false.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#remove">remove</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17122</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="removeall"><span>remove<wbr/>All</span><a href="#removeall" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="removeall-1"><span class="tsd-kind-call-signature">removeAll</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">destroyChild</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> <span class="tsd-signature-type">this</span><a href="#removeall-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>Removes all Game Objects from this Container.</p>
|
||
<p>You can also optionally call <code>destroy</code> on each Game Object that is removed from the Container.</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">destroyChild</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>Optionally call <code>destroy</code> on each Game Object successfully removed from this Container. Default false.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#removeall">removeAll</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17149</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="removealllisteners"><span>remove<wbr/>All<wbr/>Listeners</span><a href="#removealllisteners" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="removealllisteners-1"><span class="tsd-kind-call-signature">removeAllListeners</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</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">symbol</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#removealllisteners-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>Remove all listeners, or those of the specified event.</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">event</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">symbol</span></span><div class="tsd-comment tsd-typography"><p>The event name.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#removealllisteners">removeAllListeners</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:10003</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="removeat"><span>remove<wbr/>At</span><a href="#removeat" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="removeat-1"><span class="tsd-kind-call-signature">removeAt</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">index</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">destroyChild</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> <span class="tsd-signature-type">this</span><a href="#removeat-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>Removes the Game Object at the given position in this Container.</p>
|
||
<p>You can also optionally call <code>destroy</code> on the Game Object, if one is found.</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">index</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The index of the Game Object to be removed.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">destroyChild</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>Optionally call <code>destroy</code> on the Game Object if successfully removed from this Container. Default false.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#removeat">removeAt</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17131</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="removebetween"><span>remove<wbr/>Between</span><a href="#removebetween" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="removebetween-1"><span class="tsd-kind-call-signature">removeBetween</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">startIndex</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">endIndex</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">destroyChild</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">this</span><a href="#removebetween-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>Removes the Game Objects between the given positions in this Container.</p>
|
||
<p>You can also optionally call <code>destroy</code> on each Game Object that is removed from the Container.</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">startIndex</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>An optional start index to search from. Default 0.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">endIndex</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>An optional end index to search up to (but not included) Default Container.length.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">destroyChild</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>Optionally call <code>destroy</code> on each Game Object successfully removed from this Container. Default false.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#removebetween">removeBetween</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17141</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="removedfromscene"><span>removed<wbr/>From<wbr/>Scene</span><a href="#removedfromscene" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="removedfromscene-1"><span class="tsd-kind-call-signature">removedFromScene</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#removedfromscene-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>This callback is invoked when this Game Object is removed from a Scene.</p>
|
||
<p>Can be overriden by custom Game Objects, but be aware of some Game Objects that
|
||
will use this, such as Sprites, to removed themselves from the Update List.</p>
|
||
<p>You can also listen for the <code>REMOVED_FROM_SCENE</code> event from this Game Object.</p>
|
||
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#removedfromscene">removedFromScene</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:20212</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="removefromdisplaylist"><span>remove<wbr/>From<wbr/>Display<wbr/>List</span><a href="#removefromdisplaylist" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="removefromdisplaylist-1"><span class="tsd-kind-call-signature">removeFromDisplayList</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#removefromdisplaylist-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>Removes this Game Object from the Display List it is currently on.</p>
|
||
<p>A Game Object can only exist on one Display List at any given time, but may move freely removed
|
||
and added back at a later stage.</p>
|
||
<p>You can query which list it is on by looking at the <code>Phaser.GameObjects.GameObject#displayList</code> property.</p>
|
||
<p>If a Game Object isn't on any Display List, it will not be rendered. If you just wish to temporarly
|
||
disable it from rendering, consider using the <code>setVisible</code> method, instead.</p>
|
||
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#removefromdisplaylist">removeFromDisplayList</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:20284</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="removefromupdatelist"><span>remove<wbr/>From<wbr/>Update<wbr/>List</span><a href="#removefromupdatelist" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="removefromupdatelist-1"><span class="tsd-kind-call-signature">removeFromUpdateList</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#removefromupdatelist-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>Removes this Game Object from the Scene's Update List.</p>
|
||
<p>When a Game Object is on the Update List, it will have its <code>preUpdate</code> method called
|
||
every game frame. Calling this method will remove it from the list, preventing this.</p>
|
||
<p>Removing a Game Object from the Update List will stop most internal functions working.
|
||
For example, removing a Sprite from the Update List will prevent it from being able to
|
||
run animations.</p>
|
||
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#removefromupdatelist">removeFromUpdateList</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:20296</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="removeinteractive"><span>remove<wbr/>Interactive</span><a href="#removeinteractive" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="removeinteractive-1"><span class="tsd-kind-call-signature">removeInteractive</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">resetCursor</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> <span class="tsd-signature-type">this</span><a href="#removeinteractive-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>If this Game Object has previously been enabled for input, this will queue it
|
||
for removal, causing it to no longer be interactive. The removal happens on
|
||
the next game step, it is not immediate.</p>
|
||
<p>The Interactive Object that was assigned to this Game Object will be destroyed,
|
||
removed from the Input Manager and cleared from this Game Object.</p>
|
||
<p>If you wish to re-enable this Game Object at a later date you will need to
|
||
re-create its InteractiveObject by calling <code>setInteractive</code> again.</p>
|
||
<p>If you wish to only temporarily stop an object from receiving input then use
|
||
<code>disableInteractive</code> instead, as that toggles the interactive state, where-as
|
||
this erases it completely.</p>
|
||
<p>If you wish to resize a hit area, don't remove and then set it as being
|
||
interactive. Instead, access the hitarea object directly and resize the shape
|
||
being used. I.e.: <code>sprite.input.hitArea.setSize(width, height)</code> (assuming the
|
||
shape is a Rectangle, which it is by default.)</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">resetCursor</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>Should the currently active Input cursor, if any, be reset to the default cursor? Default false.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#removeinteractive">removeInteractive</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:20192</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="removelistener"><span>remove<wbr/>Listener</span><a href="#removelistener" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="removelistener-1"><span class="tsd-kind-call-signature">removeListener</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">event</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">symbol</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">fn</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">context</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">once</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">this</span><a href="#removelistener-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>Remove the listeners of a given event.</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">event</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">symbol</span></span><div class="tsd-comment tsd-typography"><p>The event name.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">fn</span>: <span class="tsd-signature-type">Function</span></span><div class="tsd-comment tsd-typography"><p>Only remove the listeners that match this function.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">context</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>Only remove the listeners that have this context.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">once</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>Only remove one-time listeners.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#removelistener">removeListener</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:9988</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="removepostpipeline"><span>remove<wbr/>Post<wbr/>Pipeline</span><a href="#removepostpipeline" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="removepostpipeline-1"><span class="tsd-kind-call-signature">removePostPipeline</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">pipeline</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">PostFXPipeline</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#removepostpipeline-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>Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.</p>
|
||
<p>If you wish to remove all Post Pipelines use the <code>resetPostPipeline</code> method instead.</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">pipeline</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">PostFXPipeline</span></span><div class="tsd-comment tsd-typography"><p>The string-based name of the pipeline, or a pipeline class.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#removepostpipeline">removePostPipeline</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17698</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="removetag"><span>remove<wbr/>Tag</span><a href="#removetag" 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="removetag-1"><span class="tsd-kind-call-signature">removeTag</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">tagType</span><span class="tsd-signature-symbol">:</span> <a href="../enums/enums_battler-tag-type.BattlerTagType.html" class="tsd-signature-type tsd-kind-enum">BattlerTagType</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#removetag-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>Remove the first tag matching the given <a href="../enums/enums_battler-tag-type.BattlerTagType.html" class="tsd-kind-enum"><code>BattlerTagType</code></a>.</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">tagType</span>: <a href="../enums/enums_battler-tag-type.BattlerTagType.html" class="tsd-signature-type tsd-kind-enum">BattlerTagType</a></span><div class="tsd-comment tsd-typography"><p>the <a href="../enums/enums_battler-tag-type.BattlerTagType.html" class="tsd-kind-enum"><code>BattlerTagType</code></a> to search for and remove</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#removetag">removeTag</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L4983">src/field/pokemon.ts:4983</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="removetagsbysourceid"><span>remove<wbr/>Tags<wbr/>By<wbr/>Source<wbr/>Id</span><a href="#removetagsbysourceid" 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="removetagsbysourceid-1"><span class="tsd-kind-call-signature">removeTagsBySourceId</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">sourceId</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><a href="#removetagsbysourceid-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">sourceId</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 <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#removetagsbysourceid">removeTagsBySourceId</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L5006">src/field/pokemon.ts:5006</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="replace"><span>replace</span><a href="#replace" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="replace-1"><span class="tsd-kind-call-signature">replace</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#replacet">T</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">GameObject</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">oldChild</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="field_arena.ArenaBase.html#replacet">T</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">newChild</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="field_arena.ArenaBase.html#replacet">T</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">destroyChild</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">this</span><a href="#replace-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>Replaces a Game Object in this Container with the new Game Object.
|
||
The new Game Object cannot already be a child of this Container.</p>
|
||
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="replacet"><span class="tsd-kind-type-parameter">T</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">GameObject</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">oldChild</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="field_arena.ArenaBase.html#replacet">T</a></span><div class="tsd-comment tsd-typography"><p>The Game Object in this Container that will be replaced.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">newChild</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="field_arena.ArenaBase.html#replacet">T</a></span><div class="tsd-comment tsd-typography"><p>The Game Object to be added to this Container.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">destroyChild</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>Optionally call <code>destroy</code> on the Game Object if successfully removed from this Container. Default false.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#replace">replace</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17194</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="resetbattleandwavedata"><span>reset<wbr/>Battle<wbr/>And<wbr/>Wave<wbr/>Data</span><a href="#resetbattleandwavedata" 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="resetbattleandwavedata-1"><span class="tsd-kind-call-signature">resetBattleAndWaveData</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#resetbattleandwavedata-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>Reset a <a href="field_pokemon.default.html" class="tsd-kind-class"><code>Pokemon</code></a>'s per-battle <a href="field_pokemon.PokemonBattleData.html" class="tsd-kind-class"><code>battleData</code></a>,
|
||
as well as any transient <a href="field_pokemon.PokemonWaveData.html" class="tsd-kind-class"><code>waveData</code></a> for the current wave.
|
||
Should be called once per arena transition (new biome/trainer battle/Mystery Encounter).</p>
|
||
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#resetbattleandwavedata">resetBattleAndWaveData</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L5780">src/field/pokemon.ts:5780</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="resetpostpipeline"><span>reset<wbr/>Post<wbr/>Pipeline</span><a href="#resetpostpipeline" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="resetpostpipeline-1"><span class="tsd-kind-call-signature">resetPostPipeline</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">resetData</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> <span class="tsd-signature-type">void</span><a href="#resetpostpipeline-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>Resets the WebGL Post Pipelines of this Game Object. It does this by calling
|
||
the <code>destroy</code> method on each post pipeline and then clearing the local array.</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">resetData</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>Reset the <code>postPipelineData</code> object to being an empty object? Default false.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#resetpostpipeline">resetPostPipeline</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17690</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="resetsprite"><span>reset<wbr/>Sprite</span><a href="#resetsprite" 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="resetsprite-1"><span class="tsd-kind-call-signature">resetSprite</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#resetsprite-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>Resets the pokemon's field sprite properties, including position, alpha, and scale</p>
|
||
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#resetsprite">resetSprite</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L1236">src/field/pokemon.ts:1236</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="resetstatus"><span>reset<wbr/>Status</span><a href="#resetstatus" 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="resetstatus-1"><span class="tsd-kind-call-signature">resetStatus</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">revive</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">confusion</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">reloadAssets</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">asPhase</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">void</span><a href="#resetstatus-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>Resets the status of a pokemon.</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">revive</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></span><div class="tsd-comment tsd-typography"><p>Whether revive should be cured; defaults to true.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">confusion</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span><div class="tsd-comment tsd-typography"><p>Whether resetStatus should include confusion or not; defaults to false.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">reloadAssets</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span><div class="tsd-comment tsd-typography"><p>Whether to reload the assets or not; defaults to false.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">asPhase</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></span><div class="tsd-comment tsd-typography"><p>Whether to reset the status in a phase or immediately</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#resetstatus">resetStatus</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L5666">src/field/pokemon.ts:5666</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="resetsummondata"><span>reset<wbr/>Summon<wbr/>Data</span><a href="#resetsummondata" 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="resetsummondata-1"><span class="tsd-kind-call-signature">resetSummonData</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#resetsummondata-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>Reset this Pokemon's <a href="field_pokemon.PokemonSummonData.html" class="tsd-kind-class"><code>SummonData</code></a> and <a href="field_pokemon.PokemonTempSummonData.html" class="tsd-kind-class"><code>TempSummonData</code></a>
|
||
in preparation for switching pokemon, as well as removing any relevant on-switch tags.</p>
|
||
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#resetsummondata">resetSummonData</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L5763">src/field/pokemon.ts:5763</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="resettera"><span>reset<wbr/>Tera</span><a href="#resettera" 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="resettera-1"><span class="tsd-kind-call-signature">resetTera</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#resettera-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">void</span></h4><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#resettera">resetTera</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L5794">src/field/pokemon.ts:5794</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="resetturndata"><span>reset<wbr/>Turn<wbr/>Data</span><a href="#resetturndata" 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="resetturndata-1"><span class="tsd-kind-call-signature">resetTurnData</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#resetturndata-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">void</span></h4><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#resetturndata">resetTurnData</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L5807">src/field/pokemon.ts:5807</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="resetwavedata"><span>reset<wbr/>Wave<wbr/>Data</span><a href="#resetwavedata" 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="resetwavedata-1"><span class="tsd-kind-call-signature">resetWaveData</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#resetwavedata-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>Reset a <a href="field_pokemon.default.html" class="tsd-kind-class"><code>Pokemon</code></a>'s <a href="field_pokemon.PokemonWaveData.html" class="tsd-kind-class"><code>waveData</code></a>.
|
||
Should be called upon starting a new wave in addition to whenever an arena transition occurs.</p>
|
||
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><h4 class="tsd-anchor-link" id="see-8">See<a href="#see-8" 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></h4><p><a href="field_pokemon.default.html#resetbattleandwavedata" class="tsd-kind-method"><code>()</code></a></p>
|
||
</div></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#resetwavedata">resetWaveData</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L5790">src/field/pokemon.ts:5790</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="reverse"><span>reverse</span><a href="#reverse" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="reverse-1"><span class="tsd-kind-call-signature">reverse</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#reverse-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>Reverses the order of all Game Objects in this Container.</p>
|
||
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#reverse">reverse</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17180</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="sendtoback"><span>send<wbr/>To<wbr/>Back</span><a href="#sendtoback" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="sendtoback-1"><span class="tsd-kind-call-signature">sendToBack</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#sendtobackt">T</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">GameObject</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">child</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="field_arena.ArenaBase.html#sendtobackt">T</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#sendtoback-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>Sends the given Game Object to the bottom of this Container.
|
||
This will cause it to render below any other objects in the Container.</p>
|
||
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="sendtobackt"><span class="tsd-kind-type-parameter">T</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">GameObject</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">child</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="field_arena.ArenaBase.html#sendtobackt">T</a></span><div class="tsd-comment tsd-typography"><p>The Game Object to send to the bottom of the Container.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#sendtoback">sendToBack</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17163</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="setabove"><span>set<wbr/>Above</span><a href="#setabove" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="setabove-1"><span class="tsd-kind-call-signature">setAbove</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">gameObject</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">GameObject</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#setabove-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>Move this Game Object so that it appears above the given Game Object.</p>
|
||
<p>This means it will render immediately after the other object in the display list.</p>
|
||
<p>Both objects must belong to the same display list, or parent container.</p>
|
||
<p>This method does not change this Game Objects <code>depth</code> value, it simply alters its list position.</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">gameObject</span>: <span class="tsd-signature-type">GameObject</span></span><div class="tsd-comment tsd-typography"><p>The Game Object that this Game Object will be moved to be above.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#setabove">setAbove</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17492</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="setactive"><span>set<wbr/>Active</span><a href="#setactive" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="setactive-1"><span class="tsd-kind-call-signature">setActive</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</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> <span class="tsd-signature-type">this</span><a href="#setactive-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>Sets the <code>active</code> property of this Game Object and returns this Game Object for further chaining.
|
||
A Game Object with its <code>active</code> property set to <code>true</code> will be updated by the Scenes UpdateList.</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">value</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>True if this Game Object should be set as active, false if not.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#setactive">setActive</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:20018</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="setall"><span>set<wbr/>All</span><a href="#setall" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="setall-1"><span class="tsd-kind-call-signature">setAll</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">property</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">value</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">startIndex</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">endIndex</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">this</span><a href="#setall-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>Sets the property to the given value on all Game Objects in this Container.</p>
|
||
<p>Optionally you can specify a start and end index. For example if this Container had 100 Game Objects,
|
||
and you set <code>startIndex</code> to 0 and <code>endIndex</code> to 50, it would return matches from only
|
||
the first 50 Game Objects.</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">property</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The property that must exist on the Game Object.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The value to get the property to.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">startIndex</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>An optional start index to search from. Default 0.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">endIndex</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>An optional end index to search up to (but not included) Default Container.length.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#setall">setAll</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17215</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="setalpha"><span>set<wbr/>Alpha</span><a href="#setalpha" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="setalpha-1"><span class="tsd-kind-call-signature">setAlpha</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</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">this</span><a href="#setalpha-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>Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders.
|
||
Alpha values are provided as a float between 0, fully transparent, and 1, fully opaque.</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">value</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The alpha value applied across the whole Game Object. Default 1.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#setalpha">setAlpha</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17319</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="setangle"><span>set<wbr/>Angle</span><a href="#setangle" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="setangle-1"><span class="tsd-kind-call-signature">setAngle</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">degrees</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">this</span><a href="#setangle-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>Sets the angle of this Game Object.</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">degrees</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The rotation of this Game Object, in degrees. Default 0.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#setangle">setAngle</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17816</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="setbelow"><span>set<wbr/>Below</span><a href="#setbelow" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="setbelow-1"><span class="tsd-kind-call-signature">setBelow</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">gameObject</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">GameObject</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#setbelow-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>Move this Game Object so that it appears below the given Game Object.</p>
|
||
<p>This means it will render immediately under the other object in the display list.</p>
|
||
<p>Both objects must belong to the same display list, or parent container.</p>
|
||
<p>This method does not change this Game Objects <code>depth</code> value, it simply alters its list position.</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">gameObject</span>: <span class="tsd-signature-type">GameObject</span></span><div class="tsd-comment tsd-typography"><p>The Game Object that this Game Object will be moved to be below.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#setbelow">setBelow</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17504</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="setblendmode"><span>set<wbr/>Blend<wbr/>Mode</span><a href="#setblendmode" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="setblendmode-1"><span class="tsd-kind-call-signature">setBlendMode</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</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> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">BlendModes</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#setblendmode-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>Sets the Blend Mode being used by this Game Object.</p>
|
||
<p>This can be a const, such as <code>Phaser.BlendModes.SCREEN</code>, or an integer, such as 4 (for Overlay)</p>
|
||
<p>Under WebGL only the following Blend Modes are available:</p>
|
||
<ul>
|
||
<li>NORMAL</li>
|
||
<li>ADD</li>
|
||
<li>MULTIPLY</li>
|
||
<li>SCREEN</li>
|
||
<li>ERASE (only works when rendering to a framebuffer, like a Render Texture)</li>
|
||
</ul>
|
||
<p>Canvas has more available depending on browser support.</p>
|
||
<p>You can also create your own custom Blend Modes in WebGL.</p>
|
||
<p>Blend modes have different effects under Canvas and WebGL, and from browser to browser, depending
|
||
on support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these
|
||
reasons try to be careful about the construction of your Scene and the frequency in which blend modes
|
||
are used.</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">value</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">BlendModes</span></span><div class="tsd-comment tsd-typography"><p>The BlendMode value. Either a string, a CONST or a number.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#setblendmode">setBlendMode</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17375</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="setboss"><span>set<wbr/>Boss</span><a href="#setboss" 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="setboss-1"><span class="tsd-kind-call-signature">setBoss</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">boss</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">bossSegments</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><a href="#setboss-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>Sets the pokemons boss status. If true initializes the boss segments either from the arguments
|
||
or through the the Scene.getEncounterBossSegments function</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">boss</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></span><div class="tsd-comment tsd-typography"><p>if the pokemon is a boss</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">bossSegments</span>: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></span><div class="tsd-comment tsd-typography"><p>amount of boss segments (health-bar segments)</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L7175">src/field/pokemon.ts:7175</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="setcustomnature"><span>set<wbr/>Custom<wbr/>Nature</span><a href="#setcustomnature" 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="setcustomnature-1"><span class="tsd-kind-call-signature">setCustomNature</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">nature</span><span class="tsd-signature-symbol">:</span> <a href="../enums/enums_nature.Nature.html" class="tsd-signature-type tsd-kind-enum">Nature</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#setcustomnature-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">nature</span>: <a href="../enums/enums_nature.Nature.html" class="tsd-signature-type tsd-kind-enum">Nature</a></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 <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#setcustomnature">setCustomNature</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L1817">src/field/pokemon.ts:1817</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="setdata"><span>set<wbr/>Data</span><a href="#setdata" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="setdata-1"><span class="tsd-kind-call-signature">setData</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#setdatat">T</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="field_arena.ArenaBase.html#setdatat">T</a><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#setdata-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>Allows you to store a key value pair within this Game Objects Data Manager.</p>
|
||
<p>If the Game Object has not been enabled for data (via <code>setDataEnabled</code>) then it will be enabled
|
||
before setting the value.</p>
|
||
<p>If the key doesn't already exist in the Data Manager then it is created.</p>
|
||
<pre><code class="javascript"><span class="hl-2">sprite</span><span class="hl-1">.</span><span class="hl-6">setData</span><span class="hl-1">(</span><span class="hl-7">'name'</span><span class="hl-1">, </span><span class="hl-7">'Red Gem Stone'</span><span class="hl-1">);</span>
|
||
</code><button type="button">Copy</button></pre>
|
||
|
||
<p>You can also pass in an object of key value pairs as the first argument:</p>
|
||
<pre><code class="javascript"><span class="hl-2">sprite</span><span class="hl-1">.</span><span class="hl-6">setData</span><span class="hl-1">({ </span><span class="hl-2">name:</span><span class="hl-1"> </span><span class="hl-7">'Red Gem Stone'</span><span class="hl-1">, </span><span class="hl-2">level:</span><span class="hl-1"> </span><span class="hl-0">2</span><span class="hl-1">, </span><span class="hl-2">owner:</span><span class="hl-1"> </span><span class="hl-7">'Link'</span><span class="hl-1">, </span><span class="hl-2">gold:</span><span class="hl-1"> </span><span class="hl-0">50</span><span class="hl-1"> });</span>
|
||
</code><button type="button">Copy</button></pre>
|
||
|
||
<p>To get a value back again you can call <code>getData</code>:</p>
|
||
<pre><code class="javascript"><span class="hl-2">sprite</span><span class="hl-1">.</span><span class="hl-6">getData</span><span class="hl-1">(</span><span class="hl-7">'gold'</span><span class="hl-1">);</span>
|
||
</code><button type="button">Copy</button></pre>
|
||
|
||
<p>Or you can access the value directly via the <code>values</code> property, where it works like any other variable:</p>
|
||
<pre><code class="javascript"><span class="hl-2">sprite</span><span class="hl-1">.</span><span class="hl-2">data</span><span class="hl-1">.</span><span class="hl-2">values</span><span class="hl-1">.</span><span class="hl-2">gold</span><span class="hl-1"> += </span><span class="hl-0">50</span><span class="hl-1">;</span>
|
||
</code><button type="button">Copy</button></pre>
|
||
|
||
<p>When the value is first set, a <code>setdata</code> event is emitted from this Game Object.</p>
|
||
<p>If the key already exists, a <code>changedata</code> event is emitted instead, along an event named after the key.
|
||
For example, if you updated an existing key called <code>PlayerLives</code> then it would emit the event <code>changedata-PlayerLives</code>.
|
||
These events will be emitted regardless if you use this method to set the value, or the direct <code>values</code> setter.</p>
|
||
<p>Please note that the data keys are case-sensitive and must be valid JavaScript Object property strings.
|
||
This means the keys <code>gold</code> and <code>Gold</code> are treated as two unique values within the Data Manager.</p>
|
||
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="setdatat"><span class="tsd-kind-type-parameter">T</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">unknown</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="field_arena.ArenaBase.html#setdatat">T</a></span><div class="tsd-comment tsd-typography"><p>The key to set the value for. Or an object of key value pairs. If an object the <code>data</code> argument is ignored.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">data</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The value to set for the given key. If an object is provided as the key this argument is ignored.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#setdata">setData</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:20086</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="setdataenabled"><span>set<wbr/>Data<wbr/>Enabled</span><a href="#setdataenabled" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="setdataenabled-1"><span class="tsd-kind-call-signature">setDataEnabled</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#setdataenabled-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>Adds a Data Manager component to this Game Object.</p>
|
||
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#setdataenabled">setDataEnabled</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:20043</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="setdepth"><span>set<wbr/>Depth</span><a href="#setdepth" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="setdepth-1"><span class="tsd-kind-call-signature">setDepth</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</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">this</span><a href="#setdepth-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>The depth of this Game Object within the Scene.</p>
|
||
<p>The depth is also known as the 'z-index' in some environments, and allows you to change the rendering order
|
||
of Game Objects, without actually moving their position in the display list.</p>
|
||
<p>The default depth is zero. A Game Object with a higher depth
|
||
value will always render in front of one with a lower value.</p>
|
||
<p>Setting the depth will queue a depth sort event within the Scene.</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">value</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The depth of this Game Object. Ensure this value is only ever a number data-type.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#setdepth">setDepth</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17462</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="setdisplaysize"><span>set<wbr/>Display<wbr/>Size</span><a href="#setdisplaysize" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="setdisplaysize-1"><span class="tsd-kind-call-signature">setDisplaySize</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">width</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">height</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">this</span><a href="#setdisplaysize-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>Sets the display size of this Game Object.</p>
|
||
<p>Calling this will adjust the scale.</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">width</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The width of this Game Object.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">height</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The height of this Game Object.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#setdisplaysize">setDisplaySize</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17435</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="setexclusive"><span>set<wbr/>Exclusive</span><a href="#setexclusive" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="setexclusive-1"><span class="tsd-kind-call-signature">setExclusive</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</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> <span class="tsd-signature-type">this</span><a href="#setexclusive-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>Does this Container exclusively manage its children?</p>
|
||
<p>The default is <code>true</code> which means a child added to this Container cannot
|
||
belong in another Container, which includes the Scene display list.</p>
|
||
<p>If you disable this then this Container will no longer exclusively manage its children.
|
||
This allows you to create all kinds of interesting graphical effects, such as replicating
|
||
Game Objects without reparenting them all over the Scene.
|
||
However, doing so will prevent children from receiving any kind of input event or have
|
||
their physics bodies work by default, as they're no longer a single entity on the
|
||
display list, but are being replicated where-ever this Container is.</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">value</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>The exclusive state of this Container. Default true.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#setexclusive">setExclusive</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:16936</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="setfieldposition"><span>set<wbr/>Field<wbr/>Position</span><a href="#setfieldposition" 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="setfieldposition-1"><span class="tsd-kind-call-signature">setFieldPosition</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fieldPosition</span><span class="tsd-signature-symbol">:</span> <a href="../enums/field_pokemon.FieldPosition.html" class="tsd-signature-type tsd-kind-enum">FieldPosition</a><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">duration</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">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#setfieldposition-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">fieldPosition</span>: <a href="../enums/field_pokemon.FieldPosition.html" class="tsd-signature-type tsd-kind-enum">FieldPosition</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">duration</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"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#setfieldposition">setFieldPosition</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L1376">src/field/pokemon.ts:1376</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="setframerate"><span>set<wbr/>Frame<wbr/>Rate</span><a href="#setframerate" 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="setframerate-1"><span class="tsd-kind-call-signature">setFrameRate</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">frameRate</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><a href="#setframerate-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">frameRate</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 <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#setframerate">setFrameRate</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L5816">src/field/pokemon.ts:5816</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="setillusion"><span>set<wbr/>Illusion</span><a href="#setillusion" 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="setillusion-1"><span class="tsd-kind-call-signature">setIllusion</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">pokemon</span><span class="tsd-signature-symbol">:</span> <a href="field_pokemon.default.html" class="tsd-signature-type tsd-kind-class">default</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#setillusion-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>Generate an illusion of the last pokemon in the party, as other wild pokemon in the area.</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">pokemon</span>: <a href="field_pokemon.default.html" class="tsd-signature-type tsd-kind-class">default</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#setillusion">setIllusion</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L753">src/field/pokemon.ts:753</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="setinteractive"><span>set<wbr/>Interactive</span><a href="#setinteractive" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="setinteractive-1"><span class="tsd-kind-call-signature">setInteractive</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">hitArea</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">HitAreaCallback</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">dropZone</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">this</span><a href="#setinteractive-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>Pass this Game Object to the Input Manager to enable it for Input.</p>
|
||
<p>Input works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area
|
||
for the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced
|
||
input detection.</p>
|
||
<p>If no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If
|
||
this isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific
|
||
shape for it to use.</p>
|
||
<p>You can also provide an Input Configuration Object as the only argument to this method.</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">hitArea</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not given it will try to create a Rectangle based on the texture frame.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">callback</span>: <span class="tsd-signature-type">HitAreaCallback</span></span><div class="tsd-comment tsd-typography"><p>The callback that determines if the pointer is within the Hit Area shape or not. If you provide a shape you must also provide a callback.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">dropZone</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>Should this Game Object be treated as a drop zone target? Default false.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#setinteractive">setInteractive</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:20157</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="setmask"><span>set<wbr/>Mask</span><a href="#setmask" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="setmask-1"><span class="tsd-kind-call-signature">setMask</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">mask</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">BitmapMask</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">GeometryMask</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#setmask-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>Sets the mask that this Game Object will use to render with.</p>
|
||
<p>The mask must have been previously created and can be either a GeometryMask or a BitmapMask.
|
||
Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.</p>
|
||
<p>If a mask is already set on this Game Object it will be immediately replaced.</p>
|
||
<p>Masks are positioned in global space and are not relative to the Game Object to which they
|
||
are applied. The reason for this is that multiple Game Objects can all share the same mask.</p>
|
||
<p>Masks have no impact on physics or input detection. They are purely a rendering component
|
||
that allows you to limit what is visible during the render pass.</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">mask</span>: <span class="tsd-signature-type">BitmapMask</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">GeometryMask</span></span><div class="tsd-comment tsd-typography"><p>The mask this Game Object will use when rendering.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#setmask">setMask</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17526</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="setmove"><span>set<wbr/>Move</span><a href="#setmove" 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="setmove-1"><span class="tsd-kind-call-signature">setMove</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">moveIndex</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">moveId</span><span class="tsd-signature-symbol">:</span> <a href="../enums/enums_moves.Moves.html" class="tsd-signature-type tsd-kind-enum">Moves</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#setmove-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">moveIndex</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">moveId</span>: <a href="../enums/enums_moves.Moves.html" class="tsd-signature-type tsd-kind-enum">Moves</a></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 <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#setmove">setMove</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L3189">src/field/pokemon.ts:3189</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="setname"><span>set<wbr/>Name</span><a href="#setname" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="setname-1"><span class="tsd-kind-call-signature">setName</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#setname-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>Sets the <code>name</code> property of this Game Object and returns this Game Object for further chaining.
|
||
The <code>name</code> property is not populated by Phaser and is presented for your own use.</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">value</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The name to be given to this Game Object.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#setname">setName</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:20025</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="setnature"><span>set<wbr/>Nature</span><a href="#setnature" 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="setnature-1"><span class="tsd-kind-call-signature">setNature</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">nature</span><span class="tsd-signature-symbol">:</span> <a href="../enums/enums_nature.Nature.html" class="tsd-signature-type tsd-kind-enum">Nature</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#setnature-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">nature</span>: <a href="../enums/enums_nature.Nature.html" class="tsd-signature-type tsd-kind-enum">Nature</a></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 <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#setnature">setNature</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L1812">src/field/pokemon.ts:1812</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="setposition"><span>set<wbr/>Position</span><a href="#setposition" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="setposition-1"><span class="tsd-kind-call-signature">setPosition</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">x</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">y</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">z</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">w</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">this</span><a href="#setposition-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>Sets the position of this Game Object.</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">x</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The x position of this Game Object. Default 0.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">y</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The y position of this Game Object. If not set it will use the <code>x</code> value. Default x.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">z</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The z position of this Game Object. Default 0.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">w</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The w position of this Game Object. Default 0.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#setposition">setPosition</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17783</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="setpositionrelative"><span>set<wbr/>Position<wbr/>Relative</span><a href="#setpositionrelative" 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="setpositionrelative-1"><span class="tsd-kind-call-signature">setPositionRelative</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">guideObject</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">x</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">y</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><a href="#setpositionrelative-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>Sets this object's position relative to another object with a given offset</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">guideObject</span>: <span class="tsd-signature-type">any</span></span></li><li><span><span class="tsd-kind-parameter">x</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">y</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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#setpositionrelative">setPositionRelative</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/typings/phaser/index.d.ts#L23">src/typings/phaser/index.d.ts:23</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="setpostpipeline"><span>set<wbr/>Post<wbr/>Pipeline</span><a href="#setpostpipeline" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="setpostpipeline-1"><span class="tsd-kind-call-signature">setPostPipeline</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">pipelines</span><span class="tsd-signature-symbol">:</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Function</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">PostFXPipeline</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">PostFXPipeline</span><span class="tsd-signature-symbol">[]</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">pipelineData</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">copyData</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">this</span><a href="#setpostpipeline-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>Sets one, or more, Post Pipelines on this Game Object.</p>
|
||
<p>Post Pipelines are invoked after this Game Object has rendered to its target and
|
||
are commonly used for post-fx.</p>
|
||
<p>The post pipelines are appended to the <code>postPipelines</code> array belonging to this
|
||
Game Object. When the renderer processes this Game Object, it iterates through the post
|
||
pipelines in the order in which they appear in the array. If you are stacking together
|
||
multiple effects, be aware that the order is important.</p>
|
||
<p>If you call this method multiple times, the new pipelines will be appended to any existing
|
||
post pipelines already set. Use the <code>resetPostPipeline</code> method to clear them first, if required.</p>
|
||
<p>You can optionally also set the <code>postPipelineData</code> property, if the parameter is given.</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">pipelines</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Function</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">PostFXPipeline</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">PostFXPipeline</span><span class="tsd-signature-symbol">[]</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">pipelineData</span>: <span class="tsd-signature-type">object</span></span><div class="tsd-comment tsd-typography"><p>Optional pipeline data object that is set in to the <code>postPipelineData</code> property of this Game Object.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">copyData</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>Should the pipeline data object be <em>deep copied</em> into the <code>postPipelineData</code> property of this Game Object? If <code>false</code> it will be set by reference instead. Default true.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#setpostpipeline">setPostPipeline</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17666</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="setpostpipelinedata"><span>set<wbr/>Post<wbr/>Pipeline<wbr/>Data</span><a href="#setpostpipelinedata" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="setpostpipelinedata-1"><span class="tsd-kind-call-signature">setPostPipelineData</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#setpostpipelinedata-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>Adds an entry to the <code>postPipelineData</code> object belonging to this Game Object.</p>
|
||
<p>If the 'key' already exists, its value is updated. If it doesn't exist, it is created.</p>
|
||
<p>If <code>value</code> is undefined, and <code>key</code> exists, <code>key</code> is removed from the data object.</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">key</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The key of the pipeline data to set, update, or delete.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The value to be set with the key. If <code>undefined</code> then <code>key</code> will be deleted from the object.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#setpostpipelinedata">setPostPipelineData</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17677</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="setrandomposition"><span>set<wbr/>Random<wbr/>Position</span><a href="#setrandomposition" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="setrandomposition-1"><span class="tsd-kind-call-signature">setRandomPosition</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">x</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">y</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">width</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">height</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">this</span><a href="#setrandomposition-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>Sets the position of this Game Object to be a random position within the confines of
|
||
the given area.</p>
|
||
<p>If no area is specified a random position between 0 x 0 and the game width x height is used instead.</p>
|
||
<p>The position does not factor in the size of this Game Object, meaning that only the origin is
|
||
guaranteed to be within the area.</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">x</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The x position of the top-left of the random area. Default 0.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">y</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The y position of the top-left of the random area. Default 0.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">width</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The width of the random area.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">height</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The height of the random area.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#setrandomposition">setRandomPosition</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17804</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="setrotation"><span>set<wbr/>Rotation</span><a href="#setrotation" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="setrotation-1"><span class="tsd-kind-call-signature">setRotation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">radians</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">this</span><a href="#setrotation-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>Sets the rotation of this Game Object.</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">radians</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The rotation of this Game Object, in radians. Default 0.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#setrotation">setRotation</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17810</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="setscale"><span>set<wbr/>Scale</span><a href="#setscale" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="setscale-1"><span class="tsd-kind-call-signature">setScale</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">x</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">y</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">this</span><a href="#setscale-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>Sets the scale of this Game Object.</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">x</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The horizontal scale of this Game Object. Default 1.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">y</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The vertical scale of this Game Object. If not set it will use the <code>x</code> value. Default x.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#setscale">setScale</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17823</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="setscrollfactor"><span>set<wbr/>Scroll<wbr/>Factor</span><a href="#setscrollfactor" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="setscrollfactor-1"><span class="tsd-kind-call-signature">setScrollFactor</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">x</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">y</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">updateChildren</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> <span class="tsd-signature-type">this</span><a href="#setscrollfactor-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>Sets the scroll factor of this Container and optionally all of its children.</p>
|
||
<p>The scroll factor controls the influence of the movement of a Camera upon this Game Object.</p>
|
||
<p>When a camera scrolls it will change the location at which this Game Object is rendered on-screen.
|
||
It does not change the Game Objects actual position values.</p>
|
||
<p>A value of 1 means it will move exactly in sync with a camera.
|
||
A value of 0 means it will not move at all, even if the camera moves.
|
||
Other values control the degree to which the camera movement is mapped to this Game Object.</p>
|
||
<p>Please be aware that scroll factor values other than 1 are not taken in to consideration when
|
||
calculating physics collisions. Bodies always collide based on their world position, but changing
|
||
the scroll factor is a visual adjustment to where the textures are rendered, which can offset
|
||
them from physics bodies if not accounted for in your code.</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">x</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The horizontal scroll factor of this Game Object.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">y</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The vertical scroll factor of this Game Object. If not set it will use the <code>x</code> value. Default x.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">updateChildren</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>Apply this scrollFactor to all Container children as well? Default false.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#setscrollfactor">setScrollFactor</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17262</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="setsize"><span>set<wbr/>Size</span><a href="#setsize" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="setsize-1"><span class="tsd-kind-call-signature">setSize</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">width</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">height</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">this</span><a href="#setsize-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>Sets the internal size of this Game Object, as used for frame or physics body creation.</p>
|
||
<p>This will not change the size that the Game Object is rendered in-game.
|
||
For that you need to either set the scale of the Game Object (<code>setScale</code>) or call the
|
||
<code>setDisplaySize</code> method, which is the same thing as changing the scale but allows you
|
||
to do so by giving pixel values.</p>
|
||
<p>If you have enabled this Game Object for input, changing the size will <em>not</em> change the
|
||
size of the hit area. To do this you should adjust the <code>input.hitArea</code> object directly.</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">width</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The width of this Game Object.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">height</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The height of this Game Object.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#setsize">setSize</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17426</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="setstat"><span>set<wbr/>Stat</span><a href="#setstat" 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="setstat-1"><span class="tsd-kind-call-signature">setStat</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">stat</span><span class="tsd-signature-symbol">:</span> <a href="../enums/enums_stat.Stat.html#hp" class="tsd-signature-type tsd-kind-enum-member">HP</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/enums_stat.Stat.html#atk" class="tsd-signature-type tsd-kind-enum-member">ATK</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/enums_stat.Stat.html#def" class="tsd-signature-type tsd-kind-enum-member">DEF</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/enums_stat.Stat.html#spatk" class="tsd-signature-type tsd-kind-enum-member">SPATK</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/enums_stat.Stat.html#spdef" class="tsd-signature-type tsd-kind-enum-member">SPDEF</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/enums_stat.Stat.html#spd" class="tsd-signature-type tsd-kind-enum-member">SPD</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">value</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">bypassSummonData</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">void</span><a href="#setstat-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>Writes the value to the corrseponding <a href="../types/enums_stat.PermanentStat.html" class="tsd-kind-type-alias"><code>PermanentStat</code></a> of the <a href="field_pokemon.default.html" class="tsd-kind-class"><code>Pokemon</code></a>.</p>
|
||
<p>Note that this does nothing if <a href="field_pokemon.PlayerPokemon.html#setstat-1" class="tsd-kind-parameter"><code>value</code></a> is less than 0.</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#hp" class="tsd-signature-type tsd-kind-enum-member">HP</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/enums_stat.Stat.html#atk" class="tsd-signature-type tsd-kind-enum-member">ATK</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/enums_stat.Stat.html#def" class="tsd-signature-type tsd-kind-enum-member">DEF</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/enums_stat.Stat.html#spatk" class="tsd-signature-type tsd-kind-enum-member">SPATK</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/enums_stat.Stat.html#spdef" class="tsd-signature-type tsd-kind-enum-member">SPDEF</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/enums_stat.Stat.html#spd" class="tsd-signature-type tsd-kind-enum-member">SPD</a></span><div class="tsd-comment tsd-typography"><p>the desired <a href="../types/enums_stat.PermanentStat.html" class="tsd-kind-type-alias"><code>PermanentStat</code></a> to be overwritten</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>the desired numeric value</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">bypassSummonData</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></span><div class="tsd-comment tsd-typography"><p>write to actual stats (<code>true</code> by default) or in-battle overridden stats (<code>false</code>)</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#setstat">setStat</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L1461">src/field/pokemon.ts:1461</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="setstate"><span>set<wbr/>State</span><a href="#setstate" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="setstate-1"><span class="tsd-kind-call-signature">setState</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</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><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#setstate-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>Sets the current state of this Game Object.</p>
|
||
<p>Phaser itself will never modify the State of a Game Object, although plugins may do so.</p>
|
||
<p>For example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'.
|
||
The state value should typically be an integer (ideally mapped to a constant
|
||
in your game code), but could also be a string. It is recommended to keep it light and simple.
|
||
If you need to store complex data about your Game Object, look at using the Data Component instead.</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">value</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The state of the Game Object.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#setstate">setState</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:20038</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="setstatstage"><span>set<wbr/>Stat<wbr/>Stage</span><a href="#setstatstage" 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="setstatstage-1"><span class="tsd-kind-call-signature">setStatStage</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">stat</span><span class="tsd-signature-symbol">:</span> <a href="../enums/enums_stat.Stat.html#atk" class="tsd-signature-type tsd-kind-enum-member">ATK</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/enums_stat.Stat.html#def" class="tsd-signature-type tsd-kind-enum-member">DEF</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/enums_stat.Stat.html#spatk" class="tsd-signature-type tsd-kind-enum-member">SPATK</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/enums_stat.Stat.html#spdef" class="tsd-signature-type tsd-kind-enum-member">SPDEF</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/enums_stat.Stat.html#spd" class="tsd-signature-type tsd-kind-enum-member">SPD</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/enums_stat.Stat.html#acc" class="tsd-signature-type tsd-kind-enum-member">ACC</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/enums_stat.Stat.html#eva" class="tsd-signature-type tsd-kind-enum-member">EVA</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">value</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">void</span><a href="#setstatstage-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>Writes the value to the in-battle stage of the corresponding <a href="../types/enums_stat.BattleStat.html" class="tsd-kind-type-alias"><code>BattleStat</code></a> of the <a href="field_pokemon.default.html" class="tsd-kind-class"><code>Pokemon</code></a>.</p>
|
||
<p>Note that, if the value is not within a range of [-6, 6], it will be forced to the closest range bound.</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#atk" class="tsd-signature-type tsd-kind-enum-member">ATK</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/enums_stat.Stat.html#def" class="tsd-signature-type tsd-kind-enum-member">DEF</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/enums_stat.Stat.html#spatk" class="tsd-signature-type tsd-kind-enum-member">SPATK</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/enums_stat.Stat.html#spdef" class="tsd-signature-type tsd-kind-enum-member">SPDEF</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/enums_stat.Stat.html#spd" class="tsd-signature-type tsd-kind-enum-member">SPD</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/enums_stat.Stat.html#acc" class="tsd-signature-type tsd-kind-enum-member">ACC</a> <span class="tsd-signature-symbol">|</span> <a href="../enums/enums_stat.Stat.html#eva" class="tsd-signature-type tsd-kind-enum-member">EVA</a></span><div class="tsd-comment tsd-typography"><p>the <a href="../types/enums_stat.BattleStat.html" class="tsd-kind-type-alias"><code>BattleStat</code></a> whose stage is to be overwritten</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>the desired numeric value</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#setstatstage">setStatStage</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L1497">src/field/pokemon.ts:1497</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="setswitchoutstatus"><span>set<wbr/>Switch<wbr/>Out<wbr/>Status</span><a href="#setswitchoutstatus" 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="setswitchoutstatus-1"><span class="tsd-kind-call-signature">setSwitchOutStatus</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">status</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> <span class="tsd-signature-type">void</span><a href="#setswitchoutstatus-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>sets if the pokemon is switching out (if it's a enemy wild implies it's going to flee)</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">status</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>boolean</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#setswitchoutstatus">setSwitchOutStatus</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L3871">src/field/pokemon.ts:3871</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="settempability"><span>set<wbr/>Temp<wbr/>Ability</span><a href="#settempability" 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="settempability-1"><span class="tsd-kind-call-signature">setTempAbility</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">ability</span><span class="tsd-signature-symbol">:</span> <a href="data_abilities_ability-class.Ability.html" class="tsd-signature-type tsd-kind-class">Ability</a><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">passive</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> <span class="tsd-signature-type">void</span><a href="#settempability-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>Sets the <a href="field_pokemon.default.html" class="tsd-kind-class"><code>Pokemon</code></a>'s ability and activates it if it normally activates on summon</p>
|
||
<p>Also clears primal weather if it is from the ability being changed</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">ability</span>: <a href="data_abilities_ability-class.Ability.html" class="tsd-signature-type tsd-kind-class">Ability</a></span><div class="tsd-comment tsd-typography"><p>New Ability</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">passive</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">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#settempability">setTempAbility</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L2330">src/field/pokemon.ts:2330</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="settoback"><span>set<wbr/>To<wbr/>Back</span><a href="#settoback" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="settoback-1"><span class="tsd-kind-call-signature">setToBack</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#settoback-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>Sets this Game Object to the back of the display list, or the back of its parent container.</p>
|
||
<p>Being at the back means it will render below everything else.</p>
|
||
<p>This method does not change this Game Objects <code>depth</code> value, it simply alters its list position.</p>
|
||
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#settoback">setToBack</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17480</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="settotop"><span>set<wbr/>To<wbr/>Top</span><a href="#settotop" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="settotop-1"><span class="tsd-kind-call-signature">setToTop</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#settotop-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>Sets this Game Object to be at the top of the display list, or the top of its parent container.</p>
|
||
<p>Being at the top means it will render on-top of everything else.</p>
|
||
<p>This method does not change this Game Objects <code>depth</code> value, it simply alters its list position.</p>
|
||
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#settotop">setToTop</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17471</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="setvisible"><span>set<wbr/>Visible</span><a href="#setvisible" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="setvisible-1"><span class="tsd-kind-call-signature">setVisible</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</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> <span class="tsd-signature-type">this</span><a href="#setvisible-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>Sets the visibility of this Game Object.</p>
|
||
<p>An invisible Game Object will skip rendering, but will still process update logic.</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">value</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>The visible state of the Game Object.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#setvisible">setVisible</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17909</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="setw"><span>setW</span><a href="#setw" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="setw-1"><span class="tsd-kind-call-signature">setW</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</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">this</span><a href="#setw-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>Sets the w position of this Game Object.</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">value</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The w position of this Game Object. Default 0.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#setw">setW</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17850</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="setx"><span>setX</span><a href="#setx" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="setx-1"><span class="tsd-kind-call-signature">setX</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</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">this</span><a href="#setx-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>Sets the x position of this Game Object.</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">value</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The x position of this Game Object. Default 0.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#setx">setX</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17829</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="sety"><span>setY</span><a href="#sety" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="sety-1"><span class="tsd-kind-call-signature">setY</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</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">this</span><a href="#sety-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>Sets the y position of this Game Object.</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">value</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The y position of this Game Object. Default 0.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#sety">setY</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17835</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="setz"><span>setZ</span><a href="#setz" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="setz-1"><span class="tsd-kind-call-signature">setZ</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</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">this</span><a href="#setz-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>Sets the z position of this Game Object.</p>
|
||
<p>Note: The z position does not control the rendering order of 2D Game Objects. Use
|
||
Phaser.GameObjects.Components.Depth#setDepth instead.</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">value</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The z position of this Game Object. Default 0.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#setz">setZ</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17844</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="showinfo"><span>show<wbr/>Info</span><a href="#showinfo" 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="showinfo-1"><span class="tsd-kind-call-signature">showInfo</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#showinfo-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">void</span></h4><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#showinfo">showInfo</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L3807">src/field/pokemon.ts:3807</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="shuffle"><span>shuffle</span><a href="#shuffle" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="shuffle-1"><span class="tsd-kind-call-signature">shuffle</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#shuffle-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>Shuffles the all Game Objects in this Container using the Fisher-Yates implementation.</p>
|
||
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#shuffle">shuffle</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17185</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="shutdown"><span>shutdown</span><a href="#shutdown" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="shutdown-1"><span class="tsd-kind-call-signature">shutdown</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#shutdown-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>Removes all listeners.</p>
|
||
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#shutdown">shutdown</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:9926</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="sort"><span>sort</span><a href="#sort" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="sort-1"><span class="tsd-kind-call-signature">sort</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">property</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">handler</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#sort-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>Sort the contents of this Container so the items are in order based on the given property.
|
||
For example: <code>sort('alpha')</code> would sort the elements based on the value of their <code>alpha</code> property.</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">property</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The property to lexically sort by.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">handler</span>: <span class="tsd-signature-type">Function</span></span><div class="tsd-comment tsd-typography"><p>Provide your own custom handler function. Will receive 2 children which it should compare and return a boolean.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#sort">sort</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17006</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="sparkle"><span>sparkle</span><a href="#sparkle" 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="sparkle-1"><span class="tsd-kind-call-signature">sparkle</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#sparkle-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">void</span></h4><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#sparkle">sparkle</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L5900">src/field/pokemon.ts:5900</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="suppressability"><span>suppress<wbr/>Ability</span><a href="#suppressability" 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="suppressability-1"><span class="tsd-kind-call-signature">suppressAbility</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#suppressability-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>Suppresses an ability and calls its onlose attributes</p>
|
||
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#suppressability">suppressAbility</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L2343">src/field/pokemon.ts:2343</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="swap"><span>swap</span><a href="#swap" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="swap-1"><span class="tsd-kind-call-signature">swap</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#swapt">T</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">GameObject</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">child1</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="field_arena.ArenaBase.html#swapt">T</a><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">child2</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="field_arena.ArenaBase.html#swapt">T</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#swap-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>Swaps the position of two Game Objects in this Container.
|
||
Both Game Objects must belong to this Container.</p>
|
||
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="swapt"><span class="tsd-kind-type-parameter">T</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">GameObject</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">child1</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="field_arena.ArenaBase.html#swapt">T</a></span><div class="tsd-comment tsd-typography"><p>The first Game Object to swap.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">child2</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="field_arena.ArenaBase.html#swapt">T</a></span><div class="tsd-comment tsd-typography"><p>The second Game Object to swap.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#swap">swap</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:17079</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="tint"><span>tint</span><a href="#tint" 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="tint-1"><span class="tsd-kind-call-signature">tint</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">color</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">alpha</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">duration</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">ease</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#tint-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">color</span>: <span class="tsd-signature-type">number</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">alpha</span>: <span class="tsd-signature-type">number</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">duration</span>: <span class="tsd-signature-type">number</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">ease</span>: <span class="tsd-signature-type">string</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 <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#tint">tint</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L5836">src/field/pokemon.ts:5836</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="toggledata"><span>toggle<wbr/>Data</span><a href="#toggledata" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="toggledata-1"><span class="tsd-kind-call-signature">toggleData</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#toggledata-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>Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.</p>
|
||
<p>If the Game Object has not been enabled for data (via <code>setDataEnabled</code>) then it will be enabled
|
||
before setting the value.</p>
|
||
<p>If the key doesn't already exist in the Data Manager then it is created.</p>
|
||
<p>When the value is first set, a <code>setdata</code> event is emitted from this Game Object.</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">key</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The key to toggle the value for.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#toggledata">toggleData</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:20113</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="toggleflyout"><span>toggle<wbr/>Flyout</span><a href="#toggleflyout" 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="toggleflyout-1"><span class="tsd-kind-call-signature">toggleFlyout</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">visible</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> <span class="tsd-signature-type">void</span><a href="#toggleflyout-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">visible</span>: <span class="tsd-signature-type">boolean</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 <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#toggleflyout">toggleFlyout</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L3891">src/field/pokemon.ts:3891</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="togglestats"><span>toggle<wbr/>Stats</span><a href="#togglestats" 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="togglestats-1"><span class="tsd-kind-call-signature">toggleStats</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">visible</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> <span class="tsd-signature-type">void</span><a href="#togglestats-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">visible</span>: <span class="tsd-signature-type">boolean</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 <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#togglestats">toggleStats</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L3887">src/field/pokemon.ts:3887</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="tojson"><span>toJSON</span><a href="#tojson" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="tojson-1"><span class="tsd-kind-call-signature">toJSON</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">JSONGameObject</span><a href="#tojson-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>Returns a JSON representation of the Game Object.</p>
|
||
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">JSONGameObject</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#tojson">toJSON</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:20223</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="transfersummon"><span>transfer<wbr/>Summon</span><a href="#transfersummon" 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="transfersummon-1"><span class="tsd-kind-call-signature">transferSummon</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">source</span><span class="tsd-signature-symbol">:</span> <a href="field_pokemon.default.html" class="tsd-signature-type tsd-kind-class">default</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#transfersummon-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>Transferring stat changes and Tags</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">source</span>: <a href="field_pokemon.default.html" class="tsd-signature-type tsd-kind-class">default</a></span><div class="tsd-comment tsd-typography"><p><a href="field_pokemon.default.html" class="tsd-kind-class"><code>Pokemon</code></a> the pokemon whose stats/Tags are to be passed on from, ie: the Pokemon using Baton Pass</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#transfersummon">transferSummon</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L5022">src/field/pokemon.ts:5022</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="transfertagsbysourceid"><span>transfer<wbr/>Tags<wbr/>By<wbr/>Source<wbr/>Id</span><a href="#transfertagsbysourceid" 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="transfertagsbysourceid-1"><span class="tsd-kind-call-signature">transferTagsBySourceId</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">sourceId</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">newSourceId</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><a href="#transfertagsbysourceid-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">sourceId</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">newSourceId</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 <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#transfertagsbysourceid">transferTagsBySourceId</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L5010">src/field/pokemon.ts:5010</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="tryplaysprite"><span>try<wbr/>Play<wbr/>Sprite</span><a href="#tryplaysprite" 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="tryplaysprite-1"><span class="tsd-kind-call-signature">tryPlaySprite</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">sprite</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Sprite</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">tintSprite</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Sprite</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#tryplaysprite-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>Attempts to animate a given Phaser.GameObjects.Sprite</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">sprite</span>: <span class="tsd-signature-type">Sprite</span></span><div class="tsd-comment tsd-typography"><p>Phaser.GameObjects.Sprite to animate</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">tintSprite</span>: <span class="tsd-signature-type">Sprite</span></span><div class="tsd-comment tsd-typography"><p>Phaser.GameObjects.Sprite placed on top of the sprite to add a color tint</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>true if the sprite was able to be animated</p>
|
||
<div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><h4 class="tsd-anchor-link" id="see-9">See<a href="#see-9" 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></h4><p>Phaser.GameObjects.Sprite.play</p>
|
||
</div></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#tryplaysprite">tryPlaySprite</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L1292">src/field/pokemon.ts:1292</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="tryrerollhiddenabilityseed"><span>try<wbr/>Reroll<wbr/>Hidden<wbr/>Ability<wbr/>Seed</span><a href="#tryrerollhiddenabilityseed" 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="tryrerollhiddenabilityseed-1"><span class="tsd-kind-call-signature">tryRerollHiddenAbilitySeed</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">thresholdOverride</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">applyModifiersToOverride</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">boolean</span><a href="#tryrerollhiddenabilityseed-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>Function that tries to set a Pokemon to have its hidden ability based on seed, if it exists.
|
||
For manual use only, usually to roll a Pokemon's hidden ability chance a second time.</p>
|
||
<p>The base hidden ability odds are <a href="../variables/data_balance_rates.BASE_HIDDEN_ABILITY_CHANCE.html" class="tsd-kind-variable"><code>BASE_HIDDEN_ABILITY_CHANCE</code></a> / <code>65536</code></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">thresholdOverride</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>number that is divided by <code>2^16</code> (<code>65536</code>) to get the HA chance, overrides haThreshold if set (bypassing HA rate modifiers such as Ability Charm)</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">applyModifiersToOverride</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>If <a href="field_pokemon.PlayerPokemon.html#tryrerollhiddenabilityseed-1" class="tsd-kind-parameter"><code>thresholdOverride</code></a> is set and this is true, will apply Ability Charm to <a href="field_pokemon.PlayerPokemon.html#tryrerollhiddenabilityseed-1" class="tsd-kind-parameter"><code>thresholdOverride</code></a></p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p><code>true</code> if the Pokemon has been set to have its hidden ability, <code>false</code> otherwise</p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#tryrerollhiddenabilityseed">tryRerollHiddenAbilitySeed</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L3352">src/field/pokemon.ts:3352</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="tryselectmove"><span>try<wbr/>Select<wbr/>Move</span><a href="#tryselectmove" 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="tryselectmove-1"><span class="tsd-kind-call-signature">trySelectMove</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">moveIndex</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">ignorePp</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> <span class="tsd-signature-type">boolean</span><a href="#tryselectmove-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">moveIndex</span>: <span class="tsd-signature-type">number</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">ignorePp</span>: <span class="tsd-signature-type">boolean</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="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#tryselectmove">trySelectMove</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L3799">src/field/pokemon.ts:3799</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="trysetshiny"><span>try<wbr/>Set<wbr/>Shiny</span><a href="#trysetshiny" 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="trysetshiny-1"><span class="tsd-kind-call-signature">trySetShiny</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">thresholdOverride</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="#trysetshiny-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>Function that tries to set a Pokemon shiny based on the trainer's trainer ID and secret ID.
|
||
Endless Pokemon in the end biome are unable to be set to shiny</p>
|
||
<p>The exact mechanic is that it calculates E as the XOR of the player's trainer ID and secret ID.
|
||
F is calculated as the XOR of the first 16 bits of the Pokemon's ID with the last 16 bits.
|
||
The XOR of E and F are then compared to the shinyThreshold (or <a href="field_pokemon.PlayerPokemon.html#trysetshiny-1" class="tsd-kind-parameter"><code>thresholdOverride</code></a> if set) to see whether or not to generate a shiny.
|
||
The base shiny odds are <a href="../variables/data_balance_rates.BASE_SHINY_CHANCE.html" class="tsd-kind-variable"><code>BASE_SHINY_CHANCE</code></a> / 65536</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">thresholdOverride</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>number that is divided by 2^16 (65536) to get the shiny chance, overrides shinyThreshold if set (bypassing shiny rate modifiers such as Shiny Charm)</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>true if the Pokemon has been set as a shiny, false otherwise</p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#trysetshiny">trySetShiny</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L3211">src/field/pokemon.ts:3211</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="trysetshinyseed"><span>try<wbr/>Set<wbr/>Shiny<wbr/>Seed</span><a href="#trysetshinyseed" 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="trysetshinyseed-1"><span class="tsd-kind-call-signature">trySetShinySeed</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">thresholdOverride</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">applyModifiersToOverride</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">boolean</span><a href="#trysetshinyseed-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>Function that tries to set a Pokemon shiny based on seed.
|
||
For manual use only, usually to roll a Pokemon's shiny chance a second time.
|
||
If it rolls shiny, or if it's already shiny, also sets a random variant and give the Pokemon the associated luck.</p>
|
||
<p>The base shiny odds are <a href="../variables/data_balance_rates.BASE_SHINY_CHANCE.html" class="tsd-kind-variable"><code>BASE_SHINY_CHANCE</code></a> / <code>65536</code></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">thresholdOverride</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>number that is divided by <code>2^16</code> (<code>65536</code>) to get the shiny chance, overrides shinyThreshold if set (bypassing shiny rate modifiers such as Shiny Charm)</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">applyModifiersToOverride</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>If <a href="field_pokemon.PlayerPokemon.html#trysetshinyseed-1" class="tsd-kind-parameter"><code>thresholdOverride</code></a> is set and this is true, will apply Shiny Charm and event modifiers to <a href="field_pokemon.PlayerPokemon.html#trysetshinyseed-1" class="tsd-kind-parameter"><code>thresholdOverride</code></a></p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p><code>true</code> if the Pokemon has been set as a shiny, <code>false</code> otherwise</p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#trysetshinyseed">trySetShinySeed</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L3265">src/field/pokemon.ts:3265</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="trysetstatus"><span>try<wbr/>Set<wbr/>Status</span><a href="#trysetstatus" 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="trysetstatus-1"><span class="tsd-kind-call-signature">trySetStatus</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">effect</span><span class="tsd-signature-symbol">?:</span> <a href="../enums/enums_status-effect.StatusEffect.html" class="tsd-signature-type tsd-kind-enum">StatusEffect</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">asPhase</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">sourcePokemon</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a href="field_pokemon.default.html" class="tsd-signature-type tsd-kind-class">default</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">turnsRemaining</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">sourceText</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">overrideStatus</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">quiet</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">boolean</span><a href="#trysetstatus-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">effect</span>: <a href="../enums/enums_status-effect.StatusEffect.html" class="tsd-signature-type tsd-kind-enum">StatusEffect</a></span></li><li><span><span class="tsd-kind-parameter">asPhase</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span></li><li><span><span class="tsd-kind-parameter">sourcePokemon</span>: <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a href="field_pokemon.default.html" class="tsd-signature-type tsd-kind-class">default</a><span class="tsd-signature-symbol"> = null</span></span></li><li><span><span class="tsd-kind-parameter">turnsRemaining</span>: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></span></li><li><span><span class="tsd-kind-parameter">sourceText</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><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">overrideStatus</span>: <span class="tsd-signature-type">boolean</span></span></li><li><span><span class="tsd-kind-parameter">quiet</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</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="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#trysetstatus">trySetStatus</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L5585">src/field/pokemon.ts:5585</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="untint"><span>untint</span><a href="#untint" 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="untint-1"><span class="tsd-kind-call-signature">untint</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">duration</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">ease</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#untint-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">duration</span>: <span class="tsd-signature-type">number</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">ease</span>: <span class="tsd-signature-type">string</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 <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#untint">untint</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L5855">src/field/pokemon.ts:5855</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="update"><span>update</span><a href="#update" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="update-1"><span class="tsd-kind-call-signature">update</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#update-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>To be overridden by custom GameObjects. Allows base objects to be used in a Pool.</p>
|
||
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>args</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#update">update</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:20218</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="updateeffectiveness"><span>update<wbr/>Effectiveness</span><a href="#updateeffectiveness" 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="updateeffectiveness-1"><span class="tsd-kind-call-signature">updateEffectiveness</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">effectiveness</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#updateeffectiveness-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>Show or hide the type effectiveness multiplier window
|
||
Passing undefined will hide the window</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">effectiveness</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#updateeffectiveness">updateEffectiveness</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L3883">src/field/pokemon.ts:3883</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="updatefusionpalette"><span>update<wbr/>Fusion<wbr/>Palette</span><a href="#updatefusionpalette" 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="updatefusionpalette-1"><span class="tsd-kind-call-signature">updateFusionPalette</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">ignoreOveride</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> <span class="tsd-signature-type">void</span><a href="#updatefusionpalette-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">ignoreOveride</span>: <span class="tsd-signature-type">boolean</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 <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#updatefusionpalette">updateFusionPalette</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L5906">src/field/pokemon.ts:5906</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="updateinfo"><span>update<wbr/>Info</span><a href="#updateinfo" 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="updateinfo-1"><span class="tsd-kind-call-signature">updateInfo</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">instant</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> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#updateinfo-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">instant</span>: <span class="tsd-signature-type">boolean</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#updateinfo">updateInfo</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L3875">src/field/pokemon.ts:3875</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="updatescale"><span>update<wbr/>Scale</span><a href="#updatescale" 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="updatescale-1"><span class="tsd-kind-call-signature">updateScale</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#updatescale-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">void</span></h4><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#updatescale">updateScale</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L1261">src/field/pokemon.ts:1261</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="updatespritepipelinedata"><span>update<wbr/>Sprite<wbr/>Pipeline<wbr/>Data</span><a href="#updatespritepipelinedata" 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="updatespritepipelinedata-1"><span class="tsd-kind-call-signature">updateSpritePipelineData</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#updatespritepipelinedata-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">void</span></h4><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#updatespritepipelinedata">updateSpritePipelineData</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/field/pokemon.ts#L1265">src/field/pokemon.ts:1265</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="willrender"><span>will<wbr/>Render</span><a href="#willrender" 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 tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="willrender-1"><span class="tsd-kind-call-signature">willRender</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">camera</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Camera</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#willrender-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>Compares the renderMask with the renderFlags to see if this Game Object will render or not.
|
||
Also checks the Game Object against the given Cameras exclusion list.</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">camera</span>: <span class="tsd-signature-type">Camera</span></span><div class="tsd-comment tsd-typography"><p>The Camera to check against this Game Object.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="field_pokemon.default.html">default</a>.<a href="field_pokemon.default.html#willrender">willRender</a></p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:20230</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="#abilityindex" 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/>Index</span></a><a href="#active" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>active</span></a><a href="#aitype"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ai<wbr/>Type</span></a><a href="#alpha" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>alpha</span></a><a href="#angle" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>angle</span></a><a href="#battledata" 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>battle<wbr/>Data</span></a><a href="#battleinfo" 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>battle<wbr/>Info</span></a><a href="#blendmode" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>blend<wbr/>Mode</span></a><a href="#body" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>body</span></a><a href="#bosssegmentindex"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>boss<wbr/>Segment<wbr/>Index</span></a><a href="#bosssegments"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>boss<wbr/>Segments</span></a><a href="#camerafilter" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>camera<wbr/>Filter</span></a><a href="#custompokemondata" 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>custom<wbr/>Pokemon<wbr/>Data</span></a><a href="#data" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data</span></a><a href="#depth" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>depth</span></a><a href="#displayheight" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>display<wbr/>Height</span></a><a href="#displaylist" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>display<wbr/>List</span></a><a href="#displayoriginx" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>display<wbr/>OriginX</span></a><a href="#displayoriginy" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>display<wbr/>OriginY</span></a><a href="#displaywidth" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>display<wbr/>Width</span></a><a href="#evocounter" 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>evo<wbr/>Counter</span></a><a href="#exclusive" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>exclusive</span></a><a href="#exp" 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>exp</span></a><a href="#fieldposition" 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>field<wbr/>Position</span></a><a href="#first" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>first</span></a><a href="#formindex" 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>form<wbr/>Index</span></a><a href="#friendship" 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>friendship</span></a><a href="#fusionabilityindex" 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>fusion<wbr/>Ability<wbr/>Index</span></a><a href="#fusioncustompokemondata" 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>fusion<wbr/>Custom<wbr/>Pokemon<wbr/>Data</span></a><a href="#fusionformindex" 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>fusion<wbr/>Form<wbr/>Index</span></a><a href="#fusiongender" 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>fusion<wbr/>Gender</span></a><a href="#fusionluck" 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>fusion<wbr/>Luck</span></a><a href="#fusionshiny" 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>fusion<wbr/>Shiny</span></a><a href="#fusionspecies" 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>fusion<wbr/>Species</span></a><a href="#fusionteratype" 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>fusion<wbr/>Tera<wbr/>Type</span></a><a href="#fusionvariant" 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>fusion<wbr/>Variant</span></a><a href="#gender" 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</span></a><a href="#haspostpipeline" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>has<wbr/>Post<wbr/>Pipeline</span></a><a href="#hastransformcomponent" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>has<wbr/>Transform<wbr/>Component</span></a><a href="#height" class="tsd-is-inherited tsd-is-external"><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="#hp" 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>hp</span></a><a href="#id" 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>id</span></a><a href="#ignoredestroy" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ignore<wbr/>Destroy</span></a><a href="#initialteamindex"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>initial<wbr/>Team<wbr/>Index</span></a><a href="#input" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>input</span></a><a href="#ispopulatedfromdatasource"><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/>Populated<wbr/>From<wbr/>Data<wbr/>Source</span></a><a href="#isterastallized" 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/>Terastallized</span></a><a href="#ivs" 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>ivs</span></a><a href="#last" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>last</span></a><a href="#length" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>length</span></a><a href="#level" 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>level</span></a><a href="#levelexp" 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>level<wbr/>Exp</span></a><a href="#list" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>list</span></a><a href="#localtransform" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>local<wbr/>Transform</span></a><a href="#luck" 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>luck</span></a><a href="#mask" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>mask</span></a><a href="#maskenabled" 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>mask<wbr/>Enabled</span></a><a href="#masksprite" 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>mask<wbr/>Sprite</span></a><a href="#maxsize" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>max<wbr/>Size</span></a><a href="#metbiome" 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>met<wbr/>Biome</span></a><a href="#metlevel" 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>met<wbr/>Level</span></a><a href="#metspecies" 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>met<wbr/>Species</span></a><a href="#metwave" 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>met<wbr/>Wave</span></a><a href="#moveset" 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>moveset</span></a><a href="#mysteryencounterbattleeffects" 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>mystery<wbr/>Encounter<wbr/>Battle<wbr/>Effects</span></a><a href="#name" 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>name</span></a><a href="#nature" 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>nature</span></a><a href="#next" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>next</span></a><a href="#nickname" 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>nickname</span></a><a href="#originx" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>originX</span></a><a href="#originy" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>originY</span></a><a href="#parentcontainer" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>parent<wbr/>Container</span></a><a href="#passive" 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>passive</span></a><a href="#pauseevolutions" 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>pause<wbr/>Evolutions</span></a><a href="#pokeball" 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>pokeball</span></a><a href="#pokerus" 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>pokerus</span></a><a href="#position" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>position</span></a><a href="#postfx" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>postFX</span></a><a href="#postpipelinedata" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>post<wbr/>Pipeline<wbr/>Data</span></a><a href="#postpipelines" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>post<wbr/>Pipelines</span></a><a href="#prefx" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>preFX</span></a><a href="#previous" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>previous</span></a><a href="#renderflags" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>render<wbr/>Flags</span></a><a href="#rotation" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>rotation</span></a><a href="#scale" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>scale</span></a><a href="#scalex" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>scaleX</span></a><a href="#scaley" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>scaleY</span></a><a href="#scene" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>scene</span></a><a href="#scrollfactorx" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>scroll<wbr/>FactorX</span></a><a href="#scrollfactory" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>scroll<wbr/>FactorY</span></a><a href="#shiny" 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>shiny</span></a><a href="#species" 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</span></a><a href="#state" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>state</span></a><a href="#stats" 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>stats</span></a><a href="#status" 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>status</span></a><a href="#stellartypesboosted" 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>stellar<wbr/>Types<wbr/>Boosted</span></a><a href="#summondata" 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>summon<wbr/>Data</span></a><a href="#switchoutstatus" 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>switch<wbr/>Out<wbr/>Status</span></a><a href="#tabindex" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tab<wbr/>Index</span></a><a href="#tempsummondata" 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>temp<wbr/>Summon<wbr/>Data</span></a><a href="#teratype" 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>tera<wbr/>Type</span></a><a href="#trainerslot"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>trainer<wbr/>Slot</span></a><a href="#turndata" 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>turn<wbr/>Data</span></a><a href="#type" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a><a href="#usedtms" 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>usedTMs</span></a><a href="#variant" 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>variant</span></a><a href="#visible" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>visible</span></a><a href="#w" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>w</span></a><a href="#wavedata" 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>wave<wbr/>Data</span></a><a href="#width" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>width</span></a><a href="#x" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>x</span></a><a href="#y" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>y</span></a><a href="#z" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>z</span></a><a href="#render_mask" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>RENDER_<wbr/>MASK</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="#add" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add</span></a><a href="#addat" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>At</span></a><a href="#addedtoscene" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>added<wbr/>To<wbr/>Scene</span></a><a href="#addexp" 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>add<wbr/>Exp</span></a><a href="#addlistener" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Listener</span></a><a href="#addtag" 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>add<wbr/>Tag</span></a><a href="#addtodisplaylist" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>To<wbr/>Display<wbr/>List</span></a><a href="#addtoparty"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>To<wbr/>Party</span></a><a href="#addtoupdatelist" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>To<wbr/>Update<wbr/>List</span></a><a href="#breakillusion" 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>break<wbr/>Illusion</span></a><a href="#bringtotop" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>bring<wbr/>To<wbr/>Top</span></a><a href="#calculatebasestats" 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>calculate<wbr/>Base<wbr/>Stats</span></a><a href="#calculatestabmultiplier" 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>calculate<wbr/>Stab<wbr/>Multiplier</span></a><a href="#calculatestats" 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>calculate<wbr/>Stats</span></a><a href="#canaddtag" 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>can<wbr/>Add<wbr/>Tag</span></a><a href="#canapplyability" 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>can<wbr/>Apply<wbr/>Ability</span></a><a href="#canbypassbosssegments"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>can<wbr/>Bypass<wbr/>Boss<wbr/>Segments</span></a><a href="#cansetstatus" 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>can<wbr/>Set<wbr/>Status</span></a><a href="#changeform" 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>change<wbr/>Form</span></a><a href="#checkifplayerhasabilityofstarter" 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>check<wbr/>If<wbr/>Player<wbr/>Has<wbr/>Ability<wbr/>Of<wbr/>Starter</span></a><a href="#clearalpha" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>clear<wbr/>Alpha</span></a><a href="#clearfusionspecies" 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>clear<wbr/>Fusion<wbr/>Species</span></a><a href="#clearfx" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>clearFX</span></a><a href="#clearmask" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>clear<wbr/>Mask</span></a><a href="#clearstatus" 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>clear<wbr/>Status</span></a><a href="#copyposition" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>copy<wbr/>Position</span></a><a href="#count" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>count</span></a><a href="#createbitmapmask" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Bitmap<wbr/>Mask</span></a><a href="#creategeometrymask" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Geometry<wbr/>Mask</span></a><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="#damage"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>damage</span></a><a href="#damageandupdate" 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>damage<wbr/>And<wbr/>Update</span></a><a href="#destroy" 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>destroy</span></a><a href="#destroysubstitute" 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>destroy<wbr/>Substitute</span></a><a href="#disableinteractive" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>disable<wbr/>Interactive</span></a><a href="#disablemask" 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>disable<wbr/>Mask</span></a><a href="#each" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>each</span></a><a href="#emit" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>emit</span></a><a href="#enablemask" 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>enable<wbr/>Mask</span></a><a href="#eventnames" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>event<wbr/>Names</span></a><a href="#exists" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>exists</span></a><a href="#faintcry" 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>faint<wbr/>Cry</span></a><a href="#fallbackvariantcolor" 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>fallback<wbr/>Variant<wbr/>Color</span></a><a href="#fieldsetup" 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>field<wbr/>Setup</span></a><a href="#findandremovetags" 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>find<wbr/>And<wbr/>Remove<wbr/>Tags</span></a><a href="#findtag" 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>find<wbr/>Tag</span></a><a href="#findtags" 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>find<wbr/>Tags</span></a><a href="#generateandpopulatemoveset"><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/>And<wbr/>Populate<wbr/>Moveset</span></a><a href="#generatefusionspecies" 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/>Fusion<wbr/>Species</span></a><a href="#generategender" 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/>Gender</span></a><a href="#generatename" 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/>Name</span></a><a href="#generatenature" 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/>Nature</span></a><a href="#generateshinyvariant" class="tsd-is-protected 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/>Shiny<wbr/>Variant</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="#getabilityattrs" 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/>Attrs</span></a><a href="#getaccuracymultiplier" 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/>Accuracy<wbr/>Multiplier</span></a><a href="#getall" class="tsd-is-inherited tsd-is-external"><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/>All</span></a><a href="#getalliedfield" 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/>Allied<wbr/>Field</span></a><a href="#getally" 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/>Ally</span></a><a href="#getat" class="tsd-is-inherited tsd-is-external"><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/>At</span></a><a href="#getattackdamage" 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/>Attack<wbr/>Damage</span></a><a href="#getattacktypeeffectiveness" 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/>Attack<wbr/>Type<wbr/>Effectiveness</span></a><a href="#getbasedamage" 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/>Damage</span></a><a href="#getbasevariant" 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/>Variant</span></a><a href="#getbattleinfo" 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/>Battle<wbr/>Info</span></a><a href="#getbattlerindex"><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/>Battler<wbr/>Index</span></a><a href="#getbattlespriteatlaspath" 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/>Battle<wbr/>Sprite<wbr/>Atlas<wbr/>Path</span></a><a href="#getbattlespriteid" 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/>Battle<wbr/>Sprite<wbr/>Id</span></a><a href="#getbattlespritekey" 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/>Battle<wbr/>Sprite<wbr/>Key</span></a><a href="#getbosssegmentindex"><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/>Boss<wbr/>Segment<wbr/>Index</span></a><a href="#getbounds" class="tsd-is-inherited tsd-is-external"><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/>Bounds</span></a><a href="#getboundstransformmatrix" class="tsd-is-inherited tsd-is-external"><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/>Bounds<wbr/>Transform<wbr/>Matrix</span></a><a href="#getbyname" class="tsd-is-inherited tsd-is-external"><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/>By<wbr/>Name</span></a><a href="#getcriticalhitresult" 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/>Critical<wbr/>Hit<wbr/>Result</span></a><a href="#getcritstage" 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/>Crit<wbr/>Stage</span></a><a href="#getdata" class="tsd-is-inherited tsd-is-external"><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/>Data</span></a><a href="#getdexattr" 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/>Dex<wbr/>Attr</span></a><a href="#getdisplaylist" class="tsd-is-inherited tsd-is-external"><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/>Display<wbr/>List</span></a><a href="#geteffectivestat" 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/>Effective<wbr/>Stat</span></a><a href="#geteggmoves" 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/>Egg<wbr/>Moves</span></a><a href="#getevolution" 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/>Evolution</span></a><a href="#getexpvalue" 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/>Exp<wbr/>Value</span></a><a href="#getfieldindex"><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/>Field<wbr/>Index</span></a><a href="#getfieldpositionoffset" 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/>Field<wbr/>Position<wbr/>Offset</span></a><a href="#getfirst" class="tsd-is-inherited tsd-is-external"><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/>First</span></a><a href="#getformkey" 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/>Form<wbr/>Key</span></a><a href="#getfusionbattlespriteatlaspath" 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/>Fusion<wbr/>Battle<wbr/>Sprite<wbr/>Atlas<wbr/>Path</span></a><a href="#getfusionbattlespriteid" 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/>Fusion<wbr/>Battle<wbr/>Sprite<wbr/>Id</span></a><a href="#getfusionbattlespritekey" 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/>Fusion<wbr/>Battle<wbr/>Sprite<wbr/>Key</span></a><a href="#getfusionformkey" 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/>Fusion<wbr/>Form<wbr/>Key</span></a><a href="#getfusiongender" 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/>Fusion<wbr/>Gender</span></a><a href="#getfusioniconatlaskey" 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/>Fusion<wbr/>Icon<wbr/>Atlas<wbr/>Key</span></a><a href="#getfusioniconid" 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/>Fusion<wbr/>Icon<wbr/>Id</span></a><a href="#getfusionspeciesform" 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/>Fusion<wbr/>Species<wbr/>Form</span></a><a href="#getfusionspriteid" 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/>Fusion<wbr/>Sprite<wbr/>Id</span></a><a href="#getgender" 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/>Gender</span></a><a href="#gethelditems" 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/>Held<wbr/>Items</span></a><a href="#gethpratio" 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/>Hp<wbr/>Ratio</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="#getindex" class="tsd-is-inherited tsd-is-external"><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/>Index</span></a><a href="#getindexlist" class="tsd-is-inherited tsd-is-external"><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/>Index<wbr/>List</span></a><a href="#getinversehp" 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/>Inverse<wbr/>Hp</span></a><a href="#getlastxmoves" 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/>LastXMoves</span></a><a href="#getlearnablelevelmoves" 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/>Learnable<wbr/>Level<wbr/>Moves</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="#getlocalpoint" class="tsd-is-inherited tsd-is-external"><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/>Local<wbr/>Point</span></a><a href="#getlocaltransformmatrix" class="tsd-is-inherited tsd-is-external"><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/>Local<wbr/>Transform<wbr/>Matrix</span></a><a href="#getluck" 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/>Luck</span></a><a href="#getmatchupscore" 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/>Matchup<wbr/>Score</span></a><a href="#getmaxhp" 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/>Max<wbr/>Hp</span></a><a href="#getmovecategory" 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/>Move<wbr/>Category</span></a><a href="#getmoveeffectiveness" 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/>Move<wbr/>Effectiveness</span></a><a href="#getmovehistory" 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/>Move<wbr/>History</span></a><a href="#getmovequeue" 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/>Move<wbr/>Queue</span></a><a href="#getmoveset" 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/>Moveset</span></a><a href="#getmovetype" 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/>Move<wbr/>Type</span></a><a href="#getname" 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/>Name</span></a><a href="#getnametorender" 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/>Name<wbr/>To<wbr/>Render</span></a><a href="#getnature" 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/>Nature</span></a><a href="#getnextmove"><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/>Next<wbr/>Move</span></a><a href="#getnexttargets"><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/>Next<wbr/>Targets</span></a><a href="#getopponent" 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/>Opponent</span></a><a href="#getopponentdescriptor" 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/>Opponent<wbr/>Descriptor</span></a><a href="#getopponents" 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/>Opponents</span></a><a href="#getparentrotation" class="tsd-is-inherited tsd-is-external"><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/>Parent<wbr/>Rotation</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="#getpokeball" 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/>Pokeball</span></a><a href="#getpostpipeline" class="tsd-is-inherited tsd-is-external"><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/>Post<wbr/>Pipeline</span></a><a href="#getrandom" class="tsd-is-inherited tsd-is-external"><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/>Random</span></a><a href="#getrestrictingtag" 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/>Restricting<wbr/>Tag</span></a><a href="#getspeciesform" 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/>Species<wbr/>Form</span></a><a href="#getsprite" 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</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="#getspritescale" 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/>Scale</span></a><a href="#getstat" 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/>Stat</span></a><a href="#getstats" 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/>Stats</span></a><a href="#getstatstage" 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/>Stat<wbr/>Stage</span></a><a href="#getstatstagemultiplier" 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/>Stat<wbr/>Stage<wbr/>Multiplier</span></a><a href="#getstatstages" 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/>Stat<wbr/>Stages</span></a><a href="#getsubstituteoffset" 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/>Substitute<wbr/>Offset</span></a><a href="#gettag" 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/>Tag</span></a><a href="#getteratype" 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/>Tera<wbr/>Type</span></a><a href="#gettintsprite" 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/>Tint<wbr/>Sprite</span></a><a href="#gettypes" 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/>Types</span></a><a href="#getunlockedeggmoves" 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/>Unlocked<wbr/>Egg<wbr/>Moves</span></a><a href="#getvariant" 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</span></a><a href="#getweight" 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/>Weight</span></a><a href="#getworldpoint" class="tsd-is-inherited tsd-is-external"><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/>World<wbr/>Point</span></a><a href="#getworldtransformmatrix" class="tsd-is-inherited tsd-is-external"><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/>World<wbr/>Transform<wbr/>Matrix</span></a><a href="#handlebosssegmentcleared"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>handle<wbr/>Boss<wbr/>Segment<wbr/>Cleared</span></a><a href="#hasability" 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>has<wbr/>Ability</span></a><a href="#hasabilitywithattr" 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>has<wbr/>Ability<wbr/>With<wbr/>Attr</span></a><a href="#hasfusionspecies" 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>has<wbr/>Fusion<wbr/>Species</span></a><a href="#haspassive" 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>has<wbr/>Passive</span></a><a href="#hassameabilityinrootform" 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>has<wbr/>Same<wbr/>Ability<wbr/>In<wbr/>Root<wbr/>Form</span></a><a href="#hasspecies" 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>has<wbr/>Species</span></a><a href="#hastrainer"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>has<wbr/>Trainer</span></a><a href="#heal" 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>heal</span></a><a href="#hideinfo" 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>hide<wbr/>Info</span></a><a href="#incdata" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>inc<wbr/>Data</span></a><a href="#init" 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>init</span></a><a href="#initbattleinfo"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>init<wbr/>Battle<wbr/>Info</span></a><a href="#initpostpipeline" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>init<wbr/>Post<wbr/>Pipeline</span></a><a href="#initshinysparkle" 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>init<wbr/>Shiny<wbr/>Sparkle</span></a><a href="#isactive" 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/>Active</span></a><a href="#isallowedinbattle" 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/>Allowed<wbr/>In<wbr/>Battle</span></a><a href="#isallowedinchallenge" 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/>Allowed<wbr/>In<wbr/>Challenge</span></a><a href="#isbaseshiny" 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/>Base<wbr/>Shiny</span></a><a href="#isboss"><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/>Boss</span></a><a href="#isbossimmune" 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/>Boss<wbr/>Immune</span></a><a href="#isdoubleshiny" 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/>Double<wbr/>Shiny</span></a><a href="#isfainted" 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/>Fainted</span></a><a href="#isfullhp" 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/>Full<wbr/>Hp</span></a><a href="#isfusion" 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/>Fusion</span></a><a href="#isfusionshiny" 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/>Fusion<wbr/>Shiny</span></a><a href="#isgrounded" 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/>Grounded</span></a><a href="#ismax" 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/>Max</span></a><a href="#ismega" 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/>Mega</span></a><a href="#ismoverestricted" 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/>Move<wbr/>Restricted</span></a><a href="#ismovetargetrestricted" 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/>Move<wbr/>Target<wbr/>Restricted</span></a><a href="#isoffsetbysubstitute" 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/>Offset<wbr/>By<wbr/>Substitute</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="#isonfield" 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/>On<wbr/>Field</span></a><a href="#isopponent" 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/>Opponent</span></a><a href="#isoppositegender" 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/>Opposite<wbr/>Gender</span></a><a href="#isplayer"><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/>Player</span></a><a href="#issafeguarded" 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/>Safeguarded</span></a><a href="#isshiny" 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/>Shiny</span></a><a href="#istrapped" 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/>Trapped</span></a><a href="#iterate" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>iterate</span></a><a href="#lapsetag" 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>lapse<wbr/>Tag</span></a><a href="#lapsetags" 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>lapse<wbr/>Tags</span></a><a href="#leavefield" 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>leave<wbr/>Field</span></a><a href="#listenercount" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>listener<wbr/>Count</span></a><a href="#listeners" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>listeners</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="#losehelditem" 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>lose<wbr/>Held<wbr/>Item</span></a><a href="#moveabove" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>move<wbr/>Above</span></a><a href="#movebelow" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>move<wbr/>Below</span></a><a href="#movedown" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>move<wbr/>Down</span></a><a href="#moveto" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>move<wbr/>To</span></a><a href="#moveup" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>move<wbr/>Up</span></a><a href="#off" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>off</span></a><a href="#on" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>on</span></a><a href="#once" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>once</span></a><a href="#onchilddestroyed" class="tsd-is-protected tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>on<wbr/>Child<wbr/>Destroyed</span></a><a href="#playanim" 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>play<wbr/>Anim</span></a><a href="#pointtocontainer" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>point<wbr/>To<wbr/>Container</span></a><a href="#populatevariantcolorcache" 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>populate<wbr/>Variant<wbr/>Color<wbr/>Cache</span></a><a href="#predestroy" class="tsd-is-protected tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>pre<wbr/>Destroy</span></a><a href="#pushmovehistory" 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>push<wbr/>Move<wbr/>History</span></a><a href="#queueimmunemessage" 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>queue<wbr/>Immune<wbr/>Message</span></a><a href="#randbattleseedint" 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>rand<wbr/>Battle<wbr/>Seed<wbr/>Int</span></a><a href="#randbattleseedintrange" 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>rand<wbr/>Battle<wbr/>Seed<wbr/>Int<wbr/>Range</span></a><a href="#recordeatenberry" 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>record<wbr/>Eaten<wbr/>Berry</span></a><a href="#remove" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove</span></a><a href="#removeall" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>All</span></a><a href="#removealllisteners" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>All<wbr/>Listeners</span></a><a href="#removeat" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>At</span></a><a href="#removebetween" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>Between</span></a><a href="#removedfromscene" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>removed<wbr/>From<wbr/>Scene</span></a><a href="#removefromdisplaylist" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>From<wbr/>Display<wbr/>List</span></a><a href="#removefromupdatelist" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>From<wbr/>Update<wbr/>List</span></a><a href="#removeinteractive" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>Interactive</span></a><a href="#removelistener" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>Listener</span></a><a href="#removepostpipeline" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>Post<wbr/>Pipeline</span></a><a href="#removetag" 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>remove<wbr/>Tag</span></a><a href="#removetagsbysourceid" 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>remove<wbr/>Tags<wbr/>By<wbr/>Source<wbr/>Id</span></a><a href="#replace" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>replace</span></a><a href="#resetbattleandwavedata" 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>reset<wbr/>Battle<wbr/>And<wbr/>Wave<wbr/>Data</span></a><a href="#resetpostpipeline" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>reset<wbr/>Post<wbr/>Pipeline</span></a><a href="#resetsprite" 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>reset<wbr/>Sprite</span></a><a href="#resetstatus" 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>reset<wbr/>Status</span></a><a href="#resetsummondata" 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>reset<wbr/>Summon<wbr/>Data</span></a><a href="#resettera" 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>reset<wbr/>Tera</span></a><a href="#resetturndata" 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>reset<wbr/>Turn<wbr/>Data</span></a><a href="#resetwavedata" 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>reset<wbr/>Wave<wbr/>Data</span></a><a href="#reverse" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>reverse</span></a><a href="#sendtoback" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>To<wbr/>Back</span></a><a href="#setabove" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Above</span></a><a href="#setactive" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Active</span></a><a href="#setall" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>All</span></a><a href="#setalpha" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Alpha</span></a><a href="#setangle" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Angle</span></a><a href="#setbelow" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Below</span></a><a href="#setblendmode" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Blend<wbr/>Mode</span></a><a href="#setboss"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Boss</span></a><a href="#setcustomnature" 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>set<wbr/>Custom<wbr/>Nature</span></a><a href="#setdata" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Data</span></a><a href="#setdataenabled" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Data<wbr/>Enabled</span></a><a href="#setdepth" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Depth</span></a><a href="#setdisplaysize" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Display<wbr/>Size</span></a><a href="#setexclusive" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Exclusive</span></a><a href="#setfieldposition" 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>set<wbr/>Field<wbr/>Position</span></a><a href="#setframerate" 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>set<wbr/>Frame<wbr/>Rate</span></a><a href="#setillusion" 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>set<wbr/>Illusion</span></a><a href="#setinteractive" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Interactive</span></a><a href="#setmask" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Mask</span></a><a href="#setmove" 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>set<wbr/>Move</span></a><a href="#setname" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Name</span></a><a href="#setnature" 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>set<wbr/>Nature</span></a><a href="#setposition" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Position</span></a><a href="#setpositionrelative" 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>set<wbr/>Position<wbr/>Relative</span></a><a href="#setpostpipeline" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Post<wbr/>Pipeline</span></a><a href="#setpostpipelinedata" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Post<wbr/>Pipeline<wbr/>Data</span></a><a href="#setrandomposition" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Random<wbr/>Position</span></a><a href="#setrotation" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Rotation</span></a><a href="#setscale" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Scale</span></a><a href="#setscrollfactor" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Scroll<wbr/>Factor</span></a><a href="#setsize" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Size</span></a><a href="#setstat" 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>set<wbr/>Stat</span></a><a href="#setstate" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>State</span></a><a href="#setstatstage" 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>set<wbr/>Stat<wbr/>Stage</span></a><a href="#setswitchoutstatus" 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>set<wbr/>Switch<wbr/>Out<wbr/>Status</span></a><a href="#settempability" 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>set<wbr/>Temp<wbr/>Ability</span></a><a href="#settoback" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>To<wbr/>Back</span></a><a href="#settotop" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>To<wbr/>Top</span></a><a href="#setvisible" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Visible</span></a><a href="#setw" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>setW</span></a><a href="#setx" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>setX</span></a><a href="#sety" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>setY</span></a><a href="#setz" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>setZ</span></a><a href="#showinfo" 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>show<wbr/>Info</span></a><a href="#shuffle" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>shuffle</span></a><a href="#shutdown" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>shutdown</span></a><a href="#sort" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>sort</span></a><a href="#sparkle" 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>sparkle</span></a><a href="#suppressability" 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>suppress<wbr/>Ability</span></a><a href="#swap" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>swap</span></a><a href="#tint" 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>tint</span></a><a href="#toggledata" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>toggle<wbr/>Data</span></a><a href="#toggleflyout" 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>toggle<wbr/>Flyout</span></a><a href="#togglestats" 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>toggle<wbr/>Stats</span></a><a href="#tojson" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>toJSON</span></a><a href="#transfersummon" 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>transfer<wbr/>Summon</span></a><a href="#transfertagsbysourceid" 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>transfer<wbr/>Tags<wbr/>By<wbr/>Source<wbr/>Id</span></a><a href="#tryplaysprite" 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>try<wbr/>Play<wbr/>Sprite</span></a><a href="#tryrerollhiddenabilityseed" 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>try<wbr/>Reroll<wbr/>Hidden<wbr/>Ability<wbr/>Seed</span></a><a href="#tryselectmove" 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>try<wbr/>Select<wbr/>Move</span></a><a href="#trysetshiny" 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>try<wbr/>Set<wbr/>Shiny</span></a><a href="#trysetshinyseed" 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>try<wbr/>Set<wbr/>Shiny<wbr/>Seed</span></a><a href="#trysetstatus" 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>try<wbr/>Set<wbr/>Status</span></a><a href="#untint" 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>untint</span></a><a href="#update" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update</span></a><a href="#updateeffectiveness" 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>update<wbr/>Effectiveness</span></a><a href="#updatefusionpalette" 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>update<wbr/>Fusion<wbr/>Palette</span></a><a href="#updateinfo" 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>update<wbr/>Info</span></a><a href="#updatescale" 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>update<wbr/>Scale</span></a><a href="#updatespritepipelinedata" 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>update<wbr/>Sprite<wbr/>Pipeline<wbr/>Data</span></a><a href="#willrender" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>will<wbr/>Render</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>
|