pokerogue/beta/interfaces/data_abilities_ability.PreDefendModifyDamageAbAttrParams.html
2025-08-10 14:46:38 +00:00

21 lines
20 KiB
HTML
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>PreDefendModifyDamageAbAttrParams | 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/data_abilities_ability.html">data/abilities/ability</a></li><li><a href="" aria-current="page">PreDefendModifyDamageAbAttrParams</a></li></ul><h1>Interface PreDefendModifyDamageAbAttrParams</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Shared interface for parameters of several <a href="../classes/data_abilities_ability.PreDefendAbAttr.html" class="tsd-kind-class"><code>PreDefendAbAttr</code></a> ability attributes that modify damage.</p>
</div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">PreDefendModifyDamageAbAttrParams</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#damage">damage</a><span class="tsd-signature-symbol">:</span> <a href="../classes/utils_common.NumberHolder.html" class="tsd-signature-type tsd-kind-class">NumberHolder</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#move">move</a><span class="tsd-signature-symbol">:</span> <a href="../classes/data_moves_move.Move.html" class="tsd-signature-type tsd-kind-class">Move</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#opponent">opponent</a><span class="tsd-signature-symbol">:</span> <a href="../classes/field_pokemon.Pokemon.html" class="tsd-signature-type tsd-kind-class">Pokemon</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#passive">passive</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#pokemon">pokemon</a><span class="tsd-signature-symbol">:</span> <a href="../classes/field_pokemon.Pokemon.html" class="tsd-signature-type tsd-kind-class">Pokemon</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#simulated">simulated</a><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></div><section class="tsd-panel tsd-hierarchy" data-refl="1587"><h4>Hierarchy (<a href="../hierarchy.html#data/abilities/ability.PreDefendModifyDamageAbAttrParams">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="data_abilities_ability.AugmentMoveInteractionAbAttrParams.html" class="tsd-signature-type tsd-kind-interface">AugmentMoveInteractionAbAttrParams</a><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">PreDefendModifyDamageAbAttrParams</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/028deedd5993436a33ce42b26914a5bb91a4ba3d/src/data/abilities/ability.ts#L564">src/data/abilities/ability.ts:564</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="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></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">Properties</h3><div class="tsd-index-list"><a href="#damage" 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>damage</span></a>
<a href="#move" 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>move</span></a>
<a href="#opponent" 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>opponent</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="#pokemon" 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>pokemon</span></a>
<a href="#simulated" 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>simulated?</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-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"><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><div class="tsd-signature"><span class="tsd-kind-property">damage</span><span class="tsd-signature-symbol">:</span> <a href="../classes/utils_common.NumberHolder.html" class="tsd-signature-type tsd-kind-class">NumberHolder</a></div><div class="tsd-comment tsd-typography"><p>Holder for the amount of damage that will be dealt by a move</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/028deedd5993436a33ce42b26914a5bb91a4ba3d/src/data/abilities/ability.ts#L566">src/data/abilities/ability.ts:566</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="move"><span>move</span><a href="#move" aria-label="Permalink" 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">move</span><span class="tsd-signature-symbol">:</span> <a href="../classes/data_moves_move.Move.html" class="tsd-signature-type tsd-kind-class">Move</a></div><div class="tsd-comment tsd-typography"><p>The move used by (or against, for defend attributes) the pokemon with the ability</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="data_abilities_ability.AugmentMoveInteractionAbAttrParams.html">AugmentMoveInteractionAbAttrParams</a>.<a href="data_abilities_ability.AugmentMoveInteractionAbAttrParams.html#move">move</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/028deedd5993436a33ce42b26914a5bb91a4ba3d/src/data/abilities/ability.ts#L556">src/data/abilities/ability.ts:556</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="opponent"><span>opponent</span><a href="#opponent" aria-label="Permalink" 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">opponent</span><span class="tsd-signature-symbol">:</span> <a href="../classes/field_pokemon.Pokemon.html" class="tsd-signature-type tsd-kind-class">Pokemon</a></div><div class="tsd-comment tsd-typography"><p>The pokemon on the other side of the interaction</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="data_abilities_ability.AugmentMoveInteractionAbAttrParams.html">AugmentMoveInteractionAbAttrParams</a>.<a href="data_abilities_ability.AugmentMoveInteractionAbAttrParams.html#opponent">opponent</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/028deedd5993436a33ce42b26914a5bb91a4ba3d/src/data/abilities/ability.ts#L558">src/data/abilities/ability.ts:558</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="passive"><code class="tsd-tag">Optional</code><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><div class="tsd-comment tsd-typography"><p>(For callers of <a href="../functions/data_abilities_apply-ab-attrs.applyAbAttrs.html" class="tsd-kind-function"><code>applyAbAttrs</code></a>): If provided, <strong>only</strong> apply ability attributes of the passive (true) or active (false).</p>
<p>This should almost always be left undefined, as otherwise it will <em>only</em> apply attributes of <em>either</em> the pokemon's passive (true) or
non-passive (false) ability. In almost all cases, you want to apply attributes that are from either.</p>
<p>(For implementations of <a href="../classes/data_abilities_ability.AbAttr.html" class="tsd-kind-class"><code>AbAttr</code></a>): This will <em>never</em> be undefined, and will be <code>true</code> if the ability being applied
is the pokemon's passive, and <code>false</code> otherwise.</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="data_abilities_ability.AugmentMoveInteractionAbAttrParams.html">AugmentMoveInteractionAbAttrParams</a>.<a href="data_abilities_ability.AugmentMoveInteractionAbAttrParams.html#passive">passive</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/028deedd5993436a33ce42b26914a5bb91a4ba3d/src/data/abilities/ability.ts#L306">src/data/abilities/ability.ts:306</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="pokemon"><code class="tsd-tag">Readonly</code><span>pokemon</span><a href="#pokemon" aria-label="Permalink" 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">pokemon</span><span class="tsd-signature-symbol">:</span> <a href="../classes/field_pokemon.Pokemon.html" class="tsd-signature-type tsd-kind-class">Pokemon</a></div><div class="tsd-comment tsd-typography"><p>The pokemon that has the ability being applied</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="data_abilities_ability.AugmentMoveInteractionAbAttrParams.html">AugmentMoveInteractionAbAttrParams</a>.<a href="data_abilities_ability.AugmentMoveInteractionAbAttrParams.html#pokemon">pokemon</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/028deedd5993436a33ce42b26914a5bb91a4ba3d/src/data/abilities/ability.ts#L286">src/data/abilities/ability.ts:286</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="simulated"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>simulated</span><a href="#simulated" aria-label="Permalink" 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">simulated</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Whether the ability's effects are being simulated (for instance, during AI damage calculations).</p>
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks">Remarks<a href="#remarks" aria-label="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>Used to prevent message flyouts and other effects from being triggered.</p>
</div><div class="tsd-tag-defaultValue"><h4 class="tsd-anchor-link" id="default-value">Default Value<a href="#default-value" aria-label="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><code>false</code></p>
</div></div><aside class="tsd-sources"><p>Inherited from <a href="data_abilities_ability.AugmentMoveInteractionAbAttrParams.html">AugmentMoveInteractionAbAttrParams</a>.<a href="data_abilities_ability.AugmentMoveInteractionAbAttrParams.html#simulated">simulated</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/028deedd5993436a33ce42b26914a5bb91a4ba3d/src/data/abilities/ability.ts#L295">src/data/abilities/ability.ts:295</a></li></ul></aside></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-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="#damage"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>damage</span></a><a href="#move" 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>move</span></a><a href="#opponent" 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>opponent</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="#pokemon" 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>pokemon</span></a><a href="#simulated" 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>simulated</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>