ShuriZma
/
pokerogue
mirror of https://github.com/pagefaultgames/pokerogue.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
pokerogue/main/classes/data_ability.FieldMultiplyB...

27 lines
30 KiB
HTML
Raw Normal View History

[skip ci] Deploy docs
2024-06-11 13:38:22 +00:00
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>FieldMultiplyBattleStatAbAttr | pokemon-rogue-battle</title><meta name="description" content="Documentation for pokemon-rogue-battle"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">pokemon-rogue-battle</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">pokemon-rogue-battle</a></li><li><a href="../modules/data_ability.html">data/ability</a></li><li><a href="data_ability.FieldMultiplyBattleStatAbAttr.html">FieldMultiplyBattleStatAbAttr</a></li></ul><h1>Class FieldMultiplyBattleStatAbAttr</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Multiplies a BattleStat if the checked Pokemon lacks this ability.
If this ability cannot stack, a BooleanHolder can be used to prevent this from stacking.</p>
</div><div class="tsd-comment tsd-typography"><h4>See</h4><ul>
<li><a href="../functions/data_ability.applyFieldBattleStatMultiplierAbAttrs.html" class="tsd-kind-function">applyFieldBattleStatMultiplierAbAttrs</a></li>
<li><a href="data_ability.FieldMultiplyBattleStatAbAttr.html#applyFieldBattleStat" class="tsd-kind-method">applyFieldBattleStat</a></li>
<li><a href="utils.BooleanHolder.html" class="tsd-kind-class">Utils.BooleanHolder</a></li>
</ul>
[skip ci] Deploy docs
2024-06-28 14:34:24 +00:00
</div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#data/ability.FieldMultiplyBattleStatAbAttr">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="data_ability.AbAttr.html" class="tsd-signature-type tsd-kind-class">AbAttr</a><ul class="tsd-hierarchy"><li><span class="target">FieldMultiplyBattleStatAbAttr</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/cd73c37d4b6685db01fd6a0be01588b83372d195/src/data/ability.ts#L1121">src/data/ability.ts:1121</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="data_ability.FieldMultiplyBattleStatAbAttr.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
[skip ci] Deploy docs
2024-06-11 13:38:22 +00:00
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="data_ability.FieldMultiplyBattleStatAbAttr.html#canStack" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>can<wbr/>Stack</span></a>
<a href="data_ability.FieldMultiplyBattleStatAbAttr.html#multiplier" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>multiplier</span></a>
<a href="data_ability.FieldMultiplyBattleStatAbAttr.html#showAbility" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>show<wbr/>Ability</span></a>
<a href="data_ability.FieldMultiplyBattleStatAbAttr.html#stat" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stat</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="data_ability.FieldMultiplyBattleStatAbAttr.html#addCondition" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Condition</span></a>
<a href="data_ability.FieldMultiplyBattleStatAbAttr.html#apply" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>apply</span></a>
<a href="data_ability.FieldMultiplyBattleStatAbAttr.html#applyFieldBattleStat" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>apply<wbr/>Field<wbr/>Battle<wbr/>Stat</span></a>
<a href="data_ability.FieldMultiplyBattleStatAbAttr.html#getCondition" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Condition</span></a>
<a href="data_ability.FieldMultiplyBattleStatAbAttr.html#getTriggerMessage" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Trigger<wbr/>Message</span></a>
[skip ci] Deploy docs
2024-06-28 14:34:24 +00:00
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_FieldMultiplyBattleStatAbAttr" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Field<wbr/>Multiply<wbr/>Battle<wbr/>Stat<wbr/>Ab<wbr/>Attr</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">stat</span>, <span class="tsd-kind-parameter">multiplier</span>, <span class="tsd-kind-parameter">canStack</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="data_ability.FieldMultiplyBattleStatAbAttr.html" class="tsd-signature-type tsd-kind-class">FieldMultiplyBattleStatAbAttr</a><a href="#constructor.new_FieldMultiplyBattleStatAbAttr" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">stat</span>: <a href="../enums/data_pokemon_stat.Stat.html" class="tsd-signature-type tsd-kind-enum">Stat</a></span></li><li><span><span class="tsd-kind-parameter">multiplier</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">canStack</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="data_ability.FieldMultiplyBattleStatAbAttr.html" class="tsd-signature-type tsd-kind-class">FieldMultiplyBattleStatAbAttr</a></h4><aside class="tsd-sources"><p>Overrides <a href="data_ability.AbAttr.html">AbAttr</a>.<a href="data_ability.AbAttr.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/cd73c37d4b6685db01fd6a0be01588b83372d195/src/data/ability.ts#L1126">src/data/ability.ts:1126</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-private"><a id="canStack" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>can<wbr/>Stack</span><a href="#canStack" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">can<wbr/>Stack</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/cd73c37d4b6685db01fd6a0be01588b83372d195/src/data/ability.ts#L1124">src/data/ability.ts:1124</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="multiplier" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>multiplier</span><a href="#multiplier" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">multiplier</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/cd73c37d4b6685db01fd6a0be01588b83372d195/src/data/ability.ts#L1123">src/data/ability.ts:1123</a></li></ul></aside></section><section class="tsd-panel tsd-
[skip ci] Deploy docs
2024-06-11 13:38:22 +00:00
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">pokemon</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 this 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><div class="tsd-comment tsd-typography"><p>boolean unused</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">stat</span>: <a href="../enums/data_pokemon_stat.Stat.html" class="tsd-signature-type tsd-kind-enum">Stat</a></span><div class="tsd-comment tsd-typography"><p><a href="../enums/data_pokemon_stat.Stat.html" class="tsd-kind-enum"><code>Stat</code></a> the type of the checked stat</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">statValue</span>: <a href="utils.NumberHolder.html" class="tsd-signature-type tsd-kind-class">NumberHolder</a></span><div class="tsd-comment tsd-typography"><p><a href="utils.NumberHolder.html" class="tsd-kind-class"><code>Utils.NumberHolder</code></a> the value of the checked stat</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">checkedPokemon</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 this ability is targeting</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">hasApplied</span>: <a href="utils.BooleanHolder.html" class="tsd-signature-type tsd-kind-class">BooleanHolder</a></span><div class="tsd-comment tsd-typography"><p><a href="utils.BooleanHolder.html" class="tsd-kind-class"><code>Utils.BooleanHolder</code></a> whether or not another multiplier has been applied to this stat</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><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>{any[]} unused</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 this changed the checked stat, false otherwise.</p>
[skip ci] Deploy docs
2024-06-28 14:34:24 +00:00
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/cd73c37d4b6685db01fd6a0be01588b83372d195/src/data/ability.ts#L1145">src/data/ability.ts:1145</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="getCondition" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Condition</span><a href="#getCondition" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="getCondition.getCondition-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Condition</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AbAttrCondition</span><a href="#getCondition.getCondition-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AbAttrCondition</span></h4><aside class="tsd-sources"><p>Inherited from <a href="data_ability.AbAttr.html">AbAttr</a>.<a href="data_ability.AbAttr.html#getCondition">getCondition</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/cd73c37d4b6685db01fd6a0be01588b83372d195/src/data/ability.ts#L143">src/data/ability.ts:143</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="getTriggerMessage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Trigger<wbr/>Message</span><a href="#getTriggerMessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="getTriggerMessage.getTriggerMessage-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Trigger<wbr/>Message</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">pokemon</span>, <span class="tsd-kind-parameter">abilityName</span>, <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getTriggerMessage.getTriggerMessage-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">pokemon</span>: <a href="field_pokemon.default.html" class="tsd-signature-type tsd-kind-class">default</a></span></li><li><span><span class="tsd-kind-parameter">abilityName</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag ts-flagRest">Rest</code> <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></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources"><p>Inherited from <a href="data_ability.AbAttr.html">AbAttr</a>.<a href="data_ability.AbAttr.html#getTriggerMessage">getTriggerMessage</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/cd73c37d4b6685db01fd6a0be01588b83372d195/src/data/ability.ts#L139">src/data/ability.ts:139</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordio