pokerogue/main/classes/data_ability.PreSwitchOutFo...

16 lines
28 KiB
HTML
Raw Normal View History

2024-05-31 13:57:14 +00:00
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>PreSwitchOutFormChangeAbAttr | 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.PreSwitchOutFormChangeAbAttr.html">PreSwitchOutFormChangeAbAttr</a></li></ul><h1>Class PreSwitchOutFormChangeAbAttr</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Attribute for form changes that occur on switching out</p>
</div><div class="tsd-comment tsd-typography"><h4>See</h4><p><a href="data_ability.PreSwitchOutFormChangeAbAttr.html#applyPreSwitchOut" class="tsd-kind-method"><code>applyPreSwitchOut</code></a></p>
2024-06-07 20:53:39 +00:00
</div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#data/ability.PreSwitchOutFormChangeAbAttr">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="data_ability.PreSwitchOutAbAttr.html" class="tsd-signature-type tsd-kind-class">PreSwitchOutAbAttr</a><ul class="tsd-hierarchy"><li><span class="target">PreSwitchOutFormChangeAbAttr</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/636cb9c8f2a33340415a3a97cbf9acdf4f4524e2/src/data/ability.ts#L1923">src/data/ability.ts:1923</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.PreSwitchOutFormChangeAbAttr.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
2024-05-31 13:57:14 +00:00
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="data_ability.PreSwitchOutFormChangeAbAttr.html#formFunc" 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>form<wbr/>Func</span></a>
<a href="data_ability.PreSwitchOutFormChangeAbAttr.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>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="data_ability.PreSwitchOutFormChangeAbAttr.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.PreSwitchOutFormChangeAbAttr.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.PreSwitchOutFormChangeAbAttr.html#applyPreSwitchOut" 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/>Pre<wbr/>Switch<wbr/>Out</span></a>
<a href="data_ability.PreSwitchOutFormChangeAbAttr.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.PreSwitchOutFormChangeAbAttr.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>
2024-06-07 20:53:39 +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_PreSwitchOutFormChangeAbAttr" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Pre<wbr/>Switch<wbr/>Out<wbr/>Form<wbr/>Change<wbr/>Ab<wbr/>Attr</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">formFunc</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="data_ability.PreSwitchOutFormChangeAbAttr.html" class="tsd-signature-type tsd-kind-class">PreSwitchOutFormChangeAbAttr</a><a href="#constructor.new_PreSwitchOutFormChangeAbAttr" 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">formFunc</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">p</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span></span><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">p</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></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">p</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">number</span></h4></li></ul></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <a href="data_ability.PreSwitchOutFormChangeAbAttr.html" class="tsd-signature-type tsd-kind-class">PreSwitchOutFormChangeAbAttr</a></h4><aside class="tsd-sources"><p>Overrides <a href="data_ability.PreSwitchOutAbAttr.html">PreSwitchOutAbAttr</a>.<a href="data_ability.PreSwitchOutAbAttr.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/636cb9c8f2a33340415a3a97cbf9acdf4f4524e2/src/data/ability.ts#L1926">src/data/ability.ts:1926</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="formFunc" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>form<wbr/>Func</span><a href="#formFunc" 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">form<wbr/>Func</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">p</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="formFu
2024-05-31 13:57:14 +00:00
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">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 pokemon switching out and changing form <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">passive</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>N/A</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>N/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><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></h4><p>true if the form change was successful</p>
2024-06-07 20:53:39 +00:00
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="data_ability.PreSwitchOutAbAttr.html">PreSwitchOutAbAttr</a>.<a href="data_ability.PreSwitchOutAbAttr.html#applyPreSwitchOut">applyPreSwitchOut</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/636cb9c8f2a33340415a3a97cbf9acdf4f4524e2/src/data/ability.ts#L1939">src/data/ability.ts:1939</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.PreSwitchOutAbAttr.html">PreSwitchOutAbAttr</a>.<a href="data_ability.PreSwitchOutAbAttr.html#getCondition">getCondition</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/636cb9c8f2a33340415a3a97cbf9acdf4f4524e2/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.PreSwitchOutAbAttr.html">PreSwitchOutAbAttr</a>.<a href="data_ability.PreSwitchOutAbAttr.html#getTriggerMessage">getTriggerMessage</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/636cb9c8f2a33340415a3a97cbf9acdf4f4524e2/src/data/abi