<!DOCTYPE html><htmlclass="default"lang="en"><head><metacharSet="utf-8"/><metahttp-equiv="x-ua-compatible"content="IE=edge"/><title>SpeciesStatBoosterModifier | pokemon-rogue-battle</title><metaname="description"content="Documentation for pokemon-rogue-battle"/><metaname="viewport"content="width=device-width, initial-scale=1"/><linkrel="stylesheet"href="../assets/style.css"/><linkrel="stylesheet"href="../assets/highlight.css"/><scriptdefersrc="../assets/main.js"></script><scriptasyncsrc="../assets/icons.js"id="tsd-icons-script"></script><scriptasyncsrc="../assets/search.js"id="tsd-search-script"></script><scriptasyncsrc="../assets/navigation.js"id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme=localStorage.getItem("tsd-theme")||"os";document.body.style.display="none";setTimeout(()=>app?app.showPage():document.body.style.removeProperty("display"),500)</script><headerclass="tsd-page-toolbar"><divclass="tsd-toolbar-contents container"><divclass="table-cell"id="tsd-search"data-base=".."><divclass="field"><labelfor="tsd-search-field"class="tsd-widget tsd-toolbar-icon search no-caption"><svgwidth="16"height="16"viewBox="0 0 16 16"fill="none"><usehref="../assets/icons.svg#icon-search"></use></svg></label><inputtype="text"id="tsd-search-field"aria-label="Search"/></div><divclass="field"><divid="tsd-toolbar-links"></div></div><ulclass="results"><liclass="state loading">Preparing search index...</li><liclass="state failure">The search index is not available</li></ul><ahref="../index.html"class="title">pokemon-rogue-battle</a></div><divclass="table-cell"id="tsd-widgets"><ahref="#"class="tsd-widget tsd-toolbar-icon menu no-caption"data-toggle="menu"aria-label="Menu"><svgwidth="16"height="16"viewBox="0 0 16 16"fill="none"><usehref="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><divclass="container container-main"><divclass="col-content"><divclass="tsd-page-title"><ulclass="tsd-breadcrumb"><li><ahref="../index.html">pokemon-rogue-battle</a></li><li><ahref="../modules/modifier_modifier.html">modifier/modifier</a></li><li><ahref="modifier_modifier.SpeciesStatBoosterModifier.html">SpeciesStatBoosterModifier</a></li></ul><h1>Class SpeciesStatBoosterModifier</h1></div><sectionclass="tsd-panel tsd-comment"><divclass="tsd-comment tsd-typography"><p>Modifier used for held items that apply <ahref="../enums/data_pokemon_stat.Stat.html"class="tsd-kind-enum"><code>Stat</code></a> boost(s) using a
multiplier if the holder is of a specific <ahref="../enums/enums_species.Species.html"class="tsd-kind-enum"><code>Species</code></a>.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from <ahref="modifier_modifier.StatBoosterModifier.html">StatBoosterModifier</a>.<ahref="modifier_modifier.StatBoosterModifier.html#multiplier">multiplier</a></p><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/2ccb48093009af37b2d263c892b743a9f38ac8fd/src/modifier/modifier.ts#L721">src/modifier/modifier.ts:721</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited"><aid="pokemonId"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>pokemon<wbr/>Id</span><ahref="#pokemonId"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">pokemon<wbr/>Id</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">number</span></div><asideclass="tsd-sources"><p>Inherited from <ahref="modifier_modifier.StatBoosterModifier.html">StatBoosterModifier</a>.<ahref="modifier_modifier.StatBoosterModifier.html#pokemonId">pokemonId</a></p><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/2ccb48093009af37b2d263c892b743a9f38ac8fd/src/modifier/modifier.ts#L472">src/modifier/modifier.ts:472</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-private"><aid="species"class="tsd-anchor"></a><h3class="tsd-anchor-link"><codeclass="tsd-tag ts-flagPrivate">Private</code><span>species</span><ahref="#species"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">species</span><spanclass="tsd-signature-symbol">:</span><ahref="../enums/enums_species.Species.html"class="tsd-signature-type tsd-kind-enum">Species</a><spanclass="tsd-signature-symbol">[]</span></div><divclass="tsd-comment tsd-typography"><p>The species that the held item's stat boost(s) apply to</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/2ccb48093009af37b2d263c892b743a9f38ac8fd/src/modifier/modifier.ts#L834">src/modifier/modifier.ts:834</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited"><aid="stackCount"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>stack<wbr/>Count</span><ahref="#stackCount"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">stack<wbr/>Count</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">number</span></div><asideclass="tsd-sources"><p>Inherited from <ahref="modifier_modifier.StatBoosterModifier.html">StatBoosterModifier</a>.<ahref="modifier_modifier.StatBoosterModifier.html#stackCount">stackCount</a></p><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/2ccb48093009af37b2d263c892b743a9f38ac8fd/src/modifier/modifier.ts#L150">src/modifier/modifier.ts:150</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><aid="stats"class="tsd-anchor"></a><h3class="tsd-anchor-link"><codeclass="tsd-tag ts-flagProtected">Protected</code><span>stats</span><ahref="#stats"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">stats</span><spanclass="tsd-signature-symbol">:</span><ahref="../enums/data_pokemon_stat.Stat.html"class="tsd-signature-type tsd-kind-enum">Stat</a><spanclass="tsd-signature-symbol">[]</span></div><divclass="tsd-comment tsd-typography"><p>The stats that the held item boosts</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from <ahref="modifier_modifier.StatBoosterModifier.html">StatBoosterModifier</a>.<ahref="modifier_modifier.StatBoosterModifier.html#stats">stats</a></p><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/2ccb48093009af37b2d263c892b743a9f38ac8fd/src/modifier/modifier.ts#L719">src/modifier/modifier.ts:719</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited"><aid="type"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>type</span><ahref="#type"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">type</span><spanclass="tsd-signature-symbol">:</span><ahref="modifier_modifier_type.ModifierType.html"class="tsd-signature-type tsd-kind-class">ModifierType</a></div><asideclass="tsd-sources"><p>Inherited from <ahref="modifier_modifier.StatBoosterModifier.html">StatBoosterModifier</a>.<ahref="modifier_modifier.StatBoosterModifier.html#type">type</a></p><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/2ccb48093009af37b2d263c892b743a9f38ac8fd/src/modifier/modifier.ts#L132">src/modifier/modifier.ts:132</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited"><aid="virtualStackCount"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>virtual<wbr/>Stack<wbr/>Count</span><ahref="#virtualStackCount"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">virtual<wbr/>Stack<wbr/>Count</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">number</span></div><asideclass="tsd-sources"><p>Inherited from <ahref="modifier_modifier.StatBoosterModifier.html">StatBoosterModifier</a>.<ahref="modifier_modifier.StatBoosterModifier.html#virtualStackCount">virtualStackCount</a></p><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/2ccb48093009af37b2d263c892b743a9f38ac8fd/src/modifier/modifier.ts#L151">src/modifier/modifier.ts:151</a></li></ul></aside></section></section><sectionclass="tsd-panel-group tsd-member-group"><h2>Methods</h2><sectionclass="tsd-panel tsd-member tsd-is-inherited"><aid="add"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>add</span><ahref="#add"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited"><liclass="tsd-signature tsd-anchor-link"><aid="add.add-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">add</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">modifiers</span>, <spanclass="tsd-kind-parameter">virtual</span>, <spanclass="tsd-kind-parameter">scene</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">boolean</span><ahref="#add.add-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">modifiers</span>: <ahref="modifier_modifier.PersistentModifier.html"class="tsd-signature-type tsd-kind-class">PersistentModifier</a><spanclass="tsd-signature-symbol">[]</span></span></li><li><span><spanclass="tsd-kind-parameter">virtual</span>: <spanclass="tsd-signature-type">boolean</span></span></li><li><span><spanclass="tsd-kind-parameter">scene</span>: <ahref="battle_scene.default.html"class="tsd-signature-type tsd-kind-class">default</a></span></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">boolean</span></h4><
[2] <ahref="utils.NumberHolder.html"class="tsd-kind-class"><code>Utils.NumberHolder</code></a> that holds the resulting value of the stat</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">boolean</span></h4><p>true if the stat boost applies successfully, false otherwise</p>
</div><asideclass="tsd-sources"><p>Inherited from <ahref="modifier_modifier.StatBoosterModifier.html">StatBoosterModifier</a>.<ahref="modifier_modifier.StatBoosterModifier.html#apply">apply</a></p><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/2ccb48093009af37b2d263c892b743a9f38ac8fd/src/modifier/modifier.ts#L769">src/modifier/modifier.ts:769</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="clone"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>clone</span><ahref="#clone"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass="tsd-signature tsd-anchor-link"><aid="clone.clone-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">clone</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><ahref="modifier_modifier.SpeciesStatBoosterModifier.html"class="tsd-signature-type tsd-kind-class">SpeciesStatBoosterModifier</a><ahref="#clone.clone-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><h4class="tsd-returns-title">Returns <ahref="modifier_modifier.SpeciesStatBoosterModifier.html"class="tsd-signature-type tsd-kind-class">SpeciesStatBoosterModifier</a></h4><asideclass="tsd-sources"><p>Overrides <ahref="modifier_modifier.StatBoosterModifier.html">StatBoosterModifier</a>.<ahref="modifier_modifier.StatBoosterModifier.html#clone">clone</a></p><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/2ccb48093009af37b2d263c892b743a9f38ac8fd/src/modifier/modifier.ts#L842">src/modifier/modifier.ts:842</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="contains"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>contains</span><ahref="#contains"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass="tsd-signature tsd-anchor-link"><aid="contains.contains-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">contains</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">speciesId</span>, <spanclass="tsd-kind-parameter">stat</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">boolean</span><ahref="#contains.contains-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Checks if either parameter is included in the corresponding lists</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">speciesId</span>: <ahref="../enums/enums_species.Species.html"class="tsd-signature-type tsd-kind-enum">Species</a></span><divclass="tsd-comment tsd-typography"><p><ahref="../enums/enums_species.Species.html"class="tsd-kind-enum"><code>Species</code></a> being checked</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">stat</span>: <ahref="../enums/data_pokemon_stat.Stat.html"class="tsd-signature-type tsd-kind-enum">Stat</a></span><divclass="tsd-comment tsd-typography"><p><ahref="../enums/data_pokemon_stat.Stat.html"class="tsd-kind-enum"><code>Stat</code></a> being checked</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">boolean</span></h4><p>true if both parameters are in <ahref="modifier_modifier.SpeciesStatBoosterModifier.html#species"class="tsd-kind-property"><code>species</code></a> and <ahref="modifier_modifier.StatBoosterModifier.html#stats"class="tsd-kind-property"><code>stats</code></a> respectively, false otherwise</p>
(or its fused species) is listed in <ahref="modifier_modifier.SpeciesStatBoosterModifier.html#species"class="tsd-kind-property"><code>species</code></a>.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">args</span>: <spanclass="tsd-signature-type">any</span><spanclass="tsd-signature-symbol">[]</span></span><divclass="tsd-comment tsd-typography"><p>[0] <ahref="field_pokemon.default.html"class="tsd-kind-class"><code>Pokemon</code></a> that holds the held item
[1] <ahref="../enums/data_pokemon_stat.Stat.html"class="tsd-kind-enum"><code>Stat</code></a> being checked at the time
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">boolean</span></h4><p>true if the stat could be boosted, false otherwise</p>
