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_move.TerrainChangeAttr...

35 lines
33 KiB
HTML
Raw Normal View History

[skip ci] Deploy docs
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>TerrainChangeAttr | 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_move.html">data/move</a></li><li><a href="data_move.TerrainChangeAttr.html">TerrainChangeAttr</a></li></ul><h1>Class TerrainChangeAttr</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Base class defining all Move Effect Attributes</p>
</div><div class="tsd-comment tsd-typography"><h4>See</h4><p><a href="data_move.MoveEffectAttr.html#apply" class="tsd-kind-method"><code>apply</code></a></p>
[skip ci] Deploy docs
2024-06-12 17:50:35 +00:00
</div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#data/move.TerrainChangeAttr">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="data_move.MoveEffectAttr.html" class="tsd-signature-type tsd-kind-class">MoveEffectAttr</a><ul class="tsd-hierarchy"><li><span class="target">TerrainChangeAttr</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/85c77b74451cf7254432bed9c742975473775561/src/data/move.ts#L2015">src/data/move.ts:2015</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_move.TerrainChangeAttr.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-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_move.TerrainChangeAttr.html#firstHitOnly" 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>first<wbr/>Hit<wbr/>Only</span></a>
<a href="data_move.TerrainChangeAttr.html#selfTarget" 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>self<wbr/>Target</span></a>
<a href="data_move.TerrainChangeAttr.html#terrainType" 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>terrain<wbr/>Type</span></a>
<a href="data_move.TerrainChangeAttr.html#trigger" 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>trigger</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="data_move.TerrainChangeAttr.html#apply" 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</span></a>
<a href="data_move.TerrainChangeAttr.html#canApply" 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>can<wbr/>Apply</span></a>
<a href="data_move.TerrainChangeAttr.html#getCondition" class="tsd-index-link"><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_move.TerrainChangeAttr.html#getFailedText" 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/>Failed<wbr/>Text</span></a>
<a href="data_move.TerrainChangeAttr.html#getTargetBenefitScore" 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/>Target<wbr/>Benefit<wbr/>Score</span></a>
<a href="data_move.TerrainChangeAttr.html#getUserBenefitScore" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>User<wbr/>Benefit<wbr/>Score</span></a>
[skip ci] Deploy docs
2024-06-12 17:50:35 +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_TerrainChangeAttr" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Terrain<wbr/>Change<wbr/>Attr</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">terrainType</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="data_move.TerrainChangeAttr.html" class="tsd-signature-type tsd-kind-class">TerrainChangeAttr</a><a href="#constructor.new_TerrainChangeAttr" 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">terrainType</span>: <a href="../enums/data_terrain.TerrainType.html" class="tsd-signature-type tsd-kind-enum">TerrainType</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="data_move.TerrainChangeAttr.html" class="tsd-signature-type tsd-kind-class">TerrainChangeAttr</a></h4><aside class="tsd-sources"><p>Overrides <a href="data_move.MoveEffectAttr.html">MoveEffectAttr</a>.<a href="data_move.MoveEffectAttr.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/85c77b74451cf7254432bed9c742975473775561/src/data/move.ts#L2018">src/data/move.ts:2018</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="firstHitOnly" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>first<wbr/>Hit<wbr/>Only</span><a href="#firstHitOnly" 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">first<wbr/>Hit<wbr/>Only</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Should this effect only apply on the first hit?</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="data_move.MoveEffectAttr.html">MoveEffectAttr</a>.<a href="data_move.MoveEffectAttr.html#firstHitOnly">firstHitOnly</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/85c77b74451cf7254432bed9c742975473775561/src/data/move.ts#L795">src/data/move.ts:795</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="selfTarget" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>self<wbr/>Target</span><a href="#selfTarget" 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">self<wbr/>Target</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Should this <a href="data_move.default.html" class="tsd-kind-class"><code>Move</code></a> target the user?</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="data_move.MoveEffectAttr.html">MoveEffectAttr</a>.<a href="data_move.MoveEffectAttr.html#selfTarget">selfTarget</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/85c77b74451cf7254432bed9c742975473775561/src/data/move.ts#L718">src/data/move.ts:718</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="terrainType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>terrain<wbr/>Type</span><a href="#terrainType" 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">terrain<wbr/>Type</span><span class="tsd-signature-symbol">:</span> <a href="../enums/data_terrain.TerrainType.html" class="tsd-signature-type tsd-kind-enum">TerrainType</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/85c77b74451cf7254432bed9c742975473775561/src/data/move.ts#L2016">src/data/move.ts:2016</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="trigger" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>trigger</span><a href="#trigger" 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">trigger</span><span class="tsd-signature-symbol">:</span> <a href="../enums/data_move.MoveEffectTrigger.html" class="tsd-signature-type tsd-kind-enum">MoveEffectTrigger</a></div><div class="tsd-comment tsd-typography"><p>Defines when this effect should trigger in the move&#39;s effect order</p>
[skip ci] Deploy docs
2024-05-31 13:57:14 +00:00
</div><div class="tsd-comment tsd-typography"><h4>See</h4><p>MoveEffectPhase.start</p>
[skip ci] Deploy docs
2024-06-12 17:50:35 +00:00
</div><aside class="tsd-sources"><p>Inherited from <a href="data_move.MoveEffectAttr.html">MoveEffectAttr</a>.<a href="data_move.MoveEffectAttr.html#trigger">trigger</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/85c77b74451cf7254432bed9c742975473775561/src/data/move.ts#L793">src/data/move.ts:793</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><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"><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">user</span>, <span class="tsd-kind-parameter">target</span>, <span class="tsd-kind-parameter">move</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><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-comment tsd-typography"><p>Applies move effects so long as they are able based on <a href="data_move.MoveEffectAttr.html#canApply" class="tsd-kind-method"><code>canApply</code></a></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">user</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">target</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">move</span>: <a href="data_move.default.html" class="tsd-signature-type tsd-kind-class">default</a></span></li><li><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">boolean</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="data_move.MoveEffectAttr.html">MoveEffectAttr</a>.<a href="data_move.MoveEffectAttr.html#apply">apply</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/85c77b74451cf7254432bed9c742975473775561/src/data/move.ts#L2024">src/data/move.ts:2024</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="canApply" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>can<wbr/>Apply</span><a href="#canApply" 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="canApply.canApply-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">can<wbr/>Apply</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">user</span>, <span class="tsd-kind-parameter">target</span>, <span class="tsd-kind-parameter">move</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><a href="#canApply.canApply-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-comment tsd-typography"><p>Determines whether the <a href="data_move.default.html" class="tsd-kind-class"><code>Move</code></a>&#39;s effects are valid to <a href="data_move.MoveEffectAttr.html#apply" class="tsd-kind-method"><code>apply</code></a></p>
[skip ci] Deploy docs
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">user</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> using the move</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">target</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> target of the move</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">move</span>: <a href="data_move.default.html" class="tsd-signature-type tsd-kind-class">default</a></span><div class="tsd-comment tsd-typography"><p><a href="data_move.default.html" class="tsd-kind-class"><code>Move</code></a> with this attribute</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>Set of unique arguments needed by this attribute</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 basic application of the ability attribute should be possible</p>
[skip ci] Deploy docs
2024-06-12 17:50:35 +00:00
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="data_move.MoveEffectAttr.html">MoveEffectAttr</a>.<a href="data_move.MoveEffectAttr.html#canApply">canApply</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/85c77b74451cf7254432bed9c742975473775561/src/data/move.ts#L812">src/data/move.ts:812</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><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"><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">MoveConditionFunc</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">MoveConditionFunc</span></h4><p>the <a href="data_move.MoveCondition.html" class="tsd-kind-class"><code>MoveCondition</code></a> or MoveConditionFunc for this <a href="data_move.default.html" class="tsd-kind-class"><code>Move</code></a></p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="data_move.MoveEffectAttr.html">MoveEffectAttr</a>.<a href="data_move.MoveEffectAttr.html#getCondition">getCondition</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/85c77b74451cf7254432bed9c742975473775561/src/data/move.ts#L2028">src/data/move.ts:2028</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="getFailedText" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Failed<wbr/>Text</span><a href="#getFailedText" 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="getFailedText.getFailedText-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Failed<wbr/>Text</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">user</span>, <span class="tsd-kind-parameter">target</span>, <span class="tsd-kind-parameter">move</span>, <span class="tsd-kind-parameter">cancelled</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getFailedText.getFailedText-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">user</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> using the move</p>
[skip ci] Deploy docs
2024-05-31 13:57:14 +00:00
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">target</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> target of the move</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">move</span>: <a href="data_move.default.html" class="tsd-signature-type tsd-kind-class">default</a></span><div class="tsd-comment tsd-typography"><p><a href="data_move.default.html" class="tsd-kind-class"><code>Move</code></a> with this attribute</p>
</div><div class="tsd-comment tsd-typography"></div></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><div class="tsd-comment tsd-typography"><p><a href="utils.BooleanHolder.html" class="tsd-kind-class"><code>Utils.BooleanHolder</code></a> which stores if the move should fail</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>the string representing failure of this <a href="data_move.default.html" class="tsd-kind-class"><code>Move</code></a></p>
[skip ci] Deploy docs
2024-06-12 17:50:35 +00:00
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="data_move.MoveEffectAttr.html">MoveEffectAttr</a>.<a href="data_move.MoveEffectAttr.html#getFailedText">getFailedText</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/85c77b74451cf7254432bed9c742975473775561/src/data/move.ts#L754">src/data/move.ts:754</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="getTargetBenefitScore" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Target<wbr/>Benefit<wbr/>Score</span><a href="#getTargetBenefitScore" 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="getTargetBenefitScore.getTargetBenefitScore-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Target<wbr/>Benefit<wbr/>Score</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">user</span>, <span class="tsd-kind-parameter">target</span>, <span class="tsd-kind-parameter">move</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#getTargetBenefitScore.getTargetBenefitScore-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-comment tsd-typography"><p>Used by the Enemy AI to rank an attack based on a given target</p>
[skip ci] Deploy docs
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">user</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">target</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">move</span>: <a href="data_move.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><div class="tsd-comment tsd-typography"><h4>See</h4><p><a href="field_pokemon.EnemyPokemon.html#getNextMove" class="tsd-kind-method"><code>EnemyPokemon.getNextMove</code></a></p>
[skip ci] Deploy docs
2024-06-12 17:50:35 +00:00
</div><aside class="tsd-sources"><p>Inherited from <a href="data_move.MoveEffectAttr.html">MoveEffectAttr</a>.<a href="data_move.MoveEffectAttr.html#getTargetBenefitScore">getTargetBenefitScore</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/85c77b74451cf7254432bed9c742975473775561/src/data/move.ts#L772">src/data/move.ts:772</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getUserBenefitScore" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>User<wbr/>Benefit<wbr/>Score</span><a href="#getUserBenefitScore" 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="getUserBenefitScore.getUserBenefitScore-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>User<wbr/>Benefit<wbr/>Score</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">user</span>, <span class="tsd-kind-parameter">target</span>, <span class="tsd-kind-parameter">move</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#getUserBenefitScore.getUserBenefitScore-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-comment tsd-typography"><p>Used by the Enemy AI to rank an attack based on a given user</p>
[skip ci] Deploy docs
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">user</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">target</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">move</span>: <a href="data_move.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><div class="tsd-comment tsd-typography"><h4>See</h4><p><a href="field_pokemon.EnemyPokemon.html#getNextMove" class="tsd-kind-method"><code>EnemyPokemon.getNextMove</code></a></p>
[skip ci] Deploy docs
2024-06-12 17:50:35 +00:00
</div><aside class="tsd-sources"><p>Overrides <a href="data_move.MoveEffectAttr.html">MoveEffectAttr</a>.<a href="data_move.MoveEffectAttr.html#getUserBenefitScore">getUserBenefitScore</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/85c77b74451cf7254432bed9c742975473775561/src/data/move.ts#L2032">src/data/move.ts:2032</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-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><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-private" name="private"/><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>Private</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></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><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-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#firstHitOnly" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>first<wbr/>Hit<wbr/>Only</span></a><a href="#selfTarget" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>self<wbr/>Target</span></a><a href="#terrainType" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>terrain<wbr/>Type</span></a><