pokerogue/main/classes/data_ability.PostSummonStatChangeOnArenaAbAttr.html

23 lines
26 KiB
HTML
Raw Normal View History

2024-05-31 14:57:14 +01:00
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>PostSummonStatChangeOnArenaAbAttr | 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.PostSummonStatChangeOnArenaAbAttr.html">PostSummonStatChangeOnArenaAbAttr</a></li></ul><h1>Class PostSummonStatChangeOnArenaAbAttr</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Applies a stat change after a Pokémon is summoned,
conditioned on the presence of a specific arena tag.</p>
2024-06-16 23:55:44 +01:00
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#data/ability.PostSummonStatChangeOnArenaAbAttr">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="data_ability.PostSummonStatChangeAbAttr.html" class="tsd-signature-type tsd-kind-class">PostSummonStatChangeAbAttr</a><ul class="tsd-hierarchy"><li><span class="target">PostSummonStatChangeOnArenaAbAttr</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/40ade2da1d7c845cac8228cfac17d5128d454aaa/src/data/ability.ts#L3521">src/data/ability.ts:3521</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.PostSummonStatChangeOnArenaAbAttr.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
2024-05-31 14:57:14 +01:00
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="data_ability.PostSummonStatChangeOnArenaAbAttr.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.PostSummonStatChangeOnArenaAbAttr.html#tagType" 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>tag<wbr/>Type</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.PostSummonStatChangeOnArenaAbAttr.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.PostSummonStatChangeOnArenaAbAttr.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.PostSummonStatChangeOnArenaAbAttr.html#applyPostSummon" 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/>Post<wbr/>Summon</span></a>
<a href="data_ability.PostSummonStatChangeOnArenaAbAttr.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.PostSummonStatChangeOnArenaAbAttr.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>
</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_PostSummonStatChangeOnArenaAbAttr" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Post<wbr/>Summon<wbr/>Stat<wbr/>Change<wbr/>On<wbr/>Arena<wbr/>Ab<wbr/>Attr</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">tagType</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="data_ability.PostSummonStatChangeOnArenaAbAttr.html" class="tsd-signature-type tsd-kind-class">PostSummonStatChangeOnArenaAbAttr</a><a href="#constructor.new_PostSummonStatChangeOnArenaAbAttr" 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-comment tsd-typography"><p>Creates an instance of PostSummonStatChangeOnArenaAbAttr.
Initializes the stat change to increase Attack by 1 stage if the specified arena tag is present.</p>
2024-06-13 23:45:37 +01: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">tagType</span>: <a href="../enums/enums_arena_tag_type.ArenaTagType.html" class="tsd-signature-type tsd-kind-enum">ArenaTagType</a></span><div class="tsd-comment tsd-typography"><p>The type of arena tag to check for.</p>
2024-06-16 23:55:44 +01:00
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="data_ability.PostSummonStatChangeOnArenaAbAttr.html" class="tsd-signature-type tsd-kind-class">PostSummonStatChangeOnArenaAbAttr</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="data_ability.PostSummonStatChangeAbAttr.html">PostSummonStatChangeAbAttr</a>.<a href="data_ability.PostSummonStatChangeAbAttr.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/40ade2da1d7c845cac8228cfac17d5128d454aaa/src/data/ability.ts#L3535">src/data/ability.ts:3535</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-inherited"><a id="showAbility" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>show<wbr/>Ability</span><a href="#showAbility" 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">show<wbr/>Ability</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="data_ability.PostSummonStatChangeAbAttr.html">PostSummonStatChangeAbAttr</a>.<a href="data_ability.PostSummonStatChangeAbAttr.html#showAbility">showAbility</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/40ade2da1d7c845cac8228cfac17d5128d454aaa/src/data/ability.ts#L126">src/data/ability.ts:126</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="tagType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>tag<wbr/>Type</span><a href="#tagType" 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">tag<wbr/>Type</span><span class="tsd-signature-symbol">:</span> <a href="../enums/enums_arena_tag_type.ArenaTagType.html" class="tsd-signature-type tsd-kind-enum">ArenaTagType</a></div><div class="tsd-comment tsd-typography"><p>The type of arena tag that conditions the stat change.</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/40ade2da1d7c845cac8228cfac17d5128d454aaa/src/data/ability.ts#L3527">src/data/ability.ts:3527</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="addCondition" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>add<wbr/>Condition</span><a href="#addCondition" 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="addCondition.addCondition-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">add<wbr/>Condition</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">condition</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="data_ability.AbAttr.html" class="tsd-signature-type tsd-kind-class">AbAttr</a><a href="#addCondition.addCondition-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">condition</span>: <span class="tsd-signature-type">AbAttrCondition</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="data_ability.AbAttr.html" class="tsd-signature-type tsd-kind-class">AbAttr</a></h4><aside class="tsd-sources"><p>Inherited from <a href="data_ability.PostSummonStatChangeAbAttr.html">PostSummonStatChangeAbAttr</a>.<a href="data_ability.PostSummonStatChangeAbAttr.html#addCondition">addCondition</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/40ade2da1d7c845cac8228cfac17d5128d454aaa/src/data/ability.ts#L145">src/data/ability.ts:145</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apply" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>apply</span><a href="#apply" 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="apply.apply-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">apply</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">pokemon</span>, <span class="tsd-kind-parameter">passive</span>, <span class="tsd-kind-parameter">cancelled</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">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span><a href="#apply.apply-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">passive</span>: <span class="tsd-signature-type">boolean</span></span></li><li><span><span class="tsd-kind-parameter">cancelled</span>: <a href="utils.BooleanHolder.html" class="tsd-signature-type tsd-kind-class">BooleanHolder</a></span></li><li><span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span><span class="tsd-signa
2024-05-31 14:57:14 +01:00
This is used in Wind Rider 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">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>The Pokémon being summoned.</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>Whether the effect is passive.</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>Additional arguments.</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><ul>
<li>Returns true if the stat change was applied, otherwise false.</li>
</ul>
2024-06-16 23:55:44 +01:00
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="data_ability.PostSummonStatChangeAbAttr.html">PostSummonStatChangeAbAttr</a>.<a href="data_ability.PostSummonStatChangeAbAttr.html#applyPostSummon">applyPostSummon</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/40ade2da1d7c845cac8228cfac17d5128d454aaa/src/data/ability.ts#L3549">src/data/ability.ts:3549</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.PostSummonStatChangeAbAttr.html">PostSummonStatChangeAbAttr</a>.<a href="data_ability.PostSummonStatChangeAbAttr.html#getCondition">getCondition</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/40ade2da1d7c845cac8228cfac17d5128d454aaa/src/data/ability.ts#L141">src/data/ability.ts:141</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.PostSummonStatChangeAbAttr.html">PostSummonStatChangeAbAttr</a>.<a href="data_ability.PostSummonStatChangeAbAttr.html#getTriggerMessage">getTriggerMessage</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/