random-mirrors/pokerogue
1
0
Fork 0
mirror of https://github.com/pagefaultgames/pokerogue.git synced 2024-11-25 00:06:18 +00:00
Code Issues Packages Projects Releases Wiki Activity
1e699e453a
pokerogue/main/classes/data_move.MultiHitPowerIncrementAttr.html
github-actions[bot] 1e699e453a [skip ci] Deploy docs
2024-06-12 14:21:11 +00:00

33 lines
28 KiB
HTML
Raw Blame History

<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>MultiHitPowerIncrementAttr | 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.MultiHitPowerIncrementAttr.html">MultiHitPowerIncrementAttr</a></li></ul><h1>Class MultiHitPowerIncrementAttr</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Attribute used for multi-hit moves that increase power in increments of the
move&#39;s base power for each hit, namely Triple Kick and Triple Axel.</p>
</div><div class="tsd-comment tsd-typography"><h4>See</h4><p><a href="data_move.MultiHitPowerIncrementAttr.html#apply" class="tsd-kind-method"><code>apply</code></a></p>
</div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#data/move.MultiHitPowerIncrementAttr">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="data_move.VariablePowerAttr.html" class="tsd-signature-type tsd-kind-class">VariablePowerAttr</a><ul class="tsd-hierarchy"><li><span class="target">MultiHitPowerIncrementAttr</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/e5d9cfd10fbfbd9ccec36f22ef9a70360cdb84b7/src/data/move.ts#L3081">src/data/move.ts:3081</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.MultiHitPowerIncrementAttr.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>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="data_move.MultiHitPowerIncrementAttr.html#maxHits" 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>max<wbr/>Hits</span></a>
<a href="data_move.MultiHitPowerIncrementAttr.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>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="data_move.MultiHitPowerIncrementAttr.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.MultiHitPowerIncrementAttr.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_move.MultiHitPowerIncrementAttr.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.MultiHitPowerIncrementAttr.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.MultiHitPowerIncrementAttr.html#getUserBenefitScore" 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/>User<wbr/>Benefit<wbr/>Score</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_MultiHitPowerIncrementAttr" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Multi<wbr/>Hit<wbr/>Power<wbr/>Increment<wbr/>Attr</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">maxHits</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="data_move.MultiHitPowerIncrementAttr.html" class="tsd-signature-type tsd-kind-class">MultiHitPowerIncrementAttr</a><a href="#constructor.new_MultiHitPowerIncrementAttr" 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">maxHits</span>: <span class="tsd-signature-type">number</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="data_move.MultiHitPowerIncrementAttr.html" class="tsd-signature-type tsd-kind-class">MultiHitPowerIncrementAttr</a></h4><aside class="tsd-sources"><p>Overrides <a href="data_move.VariablePowerAttr.html">VariablePowerAttr</a>.<a href="data_move.VariablePowerAttr.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/e5d9cfd10fbfbd9ccec36f22ef9a70360cdb84b7/src/data/move.ts#L3085">src/data/move.ts:3085</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="maxHits" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>max<wbr/>Hits</span><a href="#maxHits" 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">max<wbr/>Hits</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The max number of base power increments allowed for this 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/e5d9cfd10fbfbd9ccec36f22ef9a70360cdb84b7/src/data/move.ts#L3083">src/data/move.ts:3083</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.VariablePowerAttr.html">VariablePowerAttr</a>.<a href="data_move.VariablePowerAttr.html#selfTarget">selfTarget</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/e5d9cfd10fbfbd9ccec36f22ef9a70360cdb84b7/src/data/move.ts#L718">src/data/move.ts:718</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>Increases power of move in increments of the base power for the amount of times
the move hit. In the case that the move is extended, it will circle back to the
original base power of the move after incrementing past the maximum amount of
hits.</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><div class="tsd-comment tsd-typography"><p><a href="field_pokemon.default.html" class="tsd-kind-class"><code>Pokemon</code></a> that used 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> that the move was used on</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>[0] <a href="utils.NumberHolder.html" class="tsd-kind-class"><code>Utils.NumberHolder</code></a> for final calculated power of move</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 attribute application succeeds</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="data_move.VariablePowerAttr.html">VariablePowerAttr</a>.<a href="data_move.VariablePowerAttr.html#apply">apply</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/e5d9cfd10fbfbd9ccec36f22ef9a70360cdb84b7/src/data/move.ts#L3102">src/data/move.ts:3102</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><a href="data_move.MoveCondition.html" class="tsd-signature-type tsd-kind-class">MoveCondition</a><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 <a href="data_move.MoveCondition.html" class="tsd-signature-type tsd-kind-class">MoveCondition</a><span class="tsd-signature-symbol"> | </span><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>Inherited from <a href="data_move.VariablePowerAttr.html">VariablePowerAttr</a>.<a href="data_move.VariablePowerAttr.html#getCondition">getCondition</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/e5d9cfd10fbfbd9ccec36f22ef9a70360cdb84b7/src/data/move.ts#L742">src/data/move.ts:742</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>
</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>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="data_move.VariablePowerAttr.html">VariablePowerAttr</a>.<a href="data_move.VariablePowerAttr.html#getFailedText">getFailedText</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/e5d9cfd10fbfbd9ccec36f22ef9a70360cdb84b7/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>
</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>
</div><aside class="tsd-sources"><p>Inherited from <a href="data_move.VariablePowerAttr.html">VariablePowerAttr</a>.<a href="data_move.VariablePowerAttr.html#getTargetBenefitScore">getTargetBenefitScore</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/e5d9cfd10fbfbd9ccec36f22ef9a70360cdb84b7/src/data/move.ts#L772">src/data/move.ts:772</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><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 tsd-is-inherited"><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>
</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>
</div><aside class="tsd-sources"><p>Inherited from <a href="data_move.VariablePowerAttr.html">VariablePowerAttr</a>.<a href="data_move.VariablePowerAttr.html#getUserBenefitScore">getUserBenefitScore</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/e5d9cfd10fbfbd9ccec36f22ef9a70360cdb84b7/src/data/move.ts#L763">src/data/move.ts:763</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="#maxHits" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>max<wbr/>Hits</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="#apply" class=""><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="#getCondition" class="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="#getFailedText" class="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="#getTargetBenefitScore" class="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="#getUserBenefitScore" class="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/>User<wbr/>Benefit<wbr/>Score</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>pokemon-rogue-battle</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><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>
Reference in New Issue View Git Blame Copy Permalink