<!DOCTYPE html><htmlclass="default"lang="en"><head><metacharSet="utf-8"/><metahttp-equiv="x-ua-compatible"content="IE=edge"/><title>HitHealAttr | pokemon-rogue-battle</title><metaname="description"content="Documentation for pokemon-rogue-battle"/><metaname="viewport"content="width=device-width, initial-scale=1"/><linkrel="stylesheet"href="../assets/style.css"/><linkrel="stylesheet"href="../assets/highlight.css"/><scriptdefersrc="../assets/main.js"></script><scriptasyncsrc="../assets/icons.js"id="tsd-icons-script"></script><scriptasyncsrc="../assets/search.js"id="tsd-search-script"></script><scriptasyncsrc="../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><headerclass="tsd-page-toolbar"><divclass="tsd-toolbar-contents container"><divclass="table-cell"id="tsd-search"data-base=".."><divclass="field"><labelfor="tsd-search-field"class="tsd-widget tsd-toolbar-icon search no-caption"><svgwidth="16"height="16"viewBox="0 0 16 16"fill="none"><usehref="../assets/icons.svg#icon-search"></use></svg></label><inputtype="text"id="tsd-search-field"aria-label="Search"/></div><divclass="field"><divid="tsd-toolbar-links"></div></div><ulclass="results"><liclass="state loading">Preparing search index...</li><liclass="state failure">The search index is not available</li></ul><ahref="../index.html"class="title">pokemon-rogue-battle</a></div><divclass="table-cell"id="tsd-widgets"><ahref="#"class="tsd-widget tsd-toolbar-icon menu no-caption"data-toggle="menu"aria-label="Menu"><svgwidth="16"height="16"viewBox="0 0 16 16"fill="none"><usehref="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><divclass="container container-main"><divclass="col-content"><divclass="tsd-page-title"><ulclass="tsd-breadcrumb"><li><ahref="../index.html">pokemon-rogue-battle</a></li><li><ahref="../modules/data_move.html">data/move</a></li><li><ahref="data_move.HitHealAttr.html">HitHealAttr</a></li></ul><h1>Class HitHealAttr</h1></div><sectionclass="tsd-panel tsd-comment"><divclass="tsd-comment tsd-typography"><p>Heals user as a side effect of a move that hits a target.
Healing is based on <ahref="data_move.HitHealAttr.html#healRatio"class="tsd-kind-property"><code>healRatio</code></a> * the amount of damage dealt or a stat of the target.</p>
</div></section></div></details></section></section><sectionclass="tsd-panel-group tsd-member-group"><h2>Constructors</h2><sectionclass="tsd-panel tsd-member"><aid="constructor"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>constructor</span><ahref="#constructor"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass="tsd-signature tsd-anchor-link"><aid="constructor.new_HitHealAttr"class="tsd-anchor"></a><spanclass="tsd-kind-constructor-signature">new <wbr/>Hit<wbr/>Heal<wbr/>Attr</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">healRatio</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">healStat</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><ahref="data_move.HitHealAttr.html"class="tsd-signature-type tsd-kind-class">HitHealAttr</a><ahref="#constructor.new_HitHealAttr"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">healRatio</span>: <spanclass="tsd-signature-type">number</span></span></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">healStat</span>: <ahref="../enums/data_pokemon_stat.Stat.html"class="tsd-signature-type tsd-kind-enum">Stat</a></span></li></ul></div><h4class="tsd-returns-title">Returns <ahref="data_move.HitHealAttr.html"class="tsd-signature-type tsd-kind-class">HitHealAttr</a></h4><asideclass="tsd-sources"><p>Overrides <ahref="data_move.MoveEffectAttr.html">MoveEffectAttr</a>.<ahref="data_move.MoveEffectAttr.html#constructor">constructor</a></p><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/283714bd0fa1776ae4d408d8fcb0d75d7901fe91/src/data/move.ts#L1239">src/data/move.ts:1239</a></li></ul></aside></li></ul></section></section><sectionclass="tsd-panel-group tsd-member-group"><h2>Properties</h2><sectionclass="tsd-panel tsd-member tsd-is-inherited"><aid="firstHitOnly"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>first<wbr/>Hit<wbr/>Only</span><ahref="#firstHitOnly"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">first<wbr/>Hit<wbr/>Only</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">boolean</span></div><divclass="tsd-comment tsd-typography"><p>Should this effect only apply on the first hit?</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from <ahref="data_move.MoveEffectAttr.html">MoveEffectAttr</a>.<ahref="data_move.MoveEffectAttr.html#firstHitOnly">firstHitOnly</a></p><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/283714bd0fa1776ae4d408d8fcb0d75d7901fe91/src/data/move.ts#L590">src/data/move.ts:590</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-private"><aid="healRatio"class="tsd-anchor"></a><h3class="tsd-anchor-link"><codeclass="tsd-tag ts-flagPrivate">Private</code><span>heal<wbr/>Ratio</span><ahref="#healRatio"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">heal<wbr/>Ratio</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">number</span></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/283714bd0fa1776ae4d408d8fcb0d75d7901fe91/src/data/move.ts#L1235">src/data/move.ts:1235</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-private"><aid="healStat"class="tsd-anchor"></a><h3class="tsd-anchor-link"><codeclass="tsd-tag ts-flagPrivate">Private</code><span>heal<wbr/>Stat</span><ahref="#healStat"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">heal<wbr/>Stat</span><spanclass="tsd-signature-symbol">:</span><ahref="../enums/data_pokemon_stat.Stat.html"class="tsd-signature-type tsd-kind-enum">Stat</a></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/283714bd0fa1776ae4d408d8fcb0d75d7901fe91/src/data/move.ts#L1237">src/data/move.ts:1237</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-private"><aid="message"class="tsd-anchor"></a><h3class="tsd-anchor-link"><codeclass="tsd-tag ts-flagPrivate">Private</code><span>message</span><ahref="#message"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">message</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/283714bd0fa1776ae4d408d8fcb0d75d7901fe91/src/data/move.ts#L1236">src/data/move.ts:1236</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited"><aid="selfTarget"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>self<wbr/>Target</span><ahref="#selfTarget"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">self<wbr/>Target</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">boolean</span></div><divclass="tsd-comment tsd-typography"><p>Should this <ahref="data_move.default.html"class="tsd-kind-class"><code>Move</code></a> target the user?</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from <ahref="data_move.MoveEffectAttr.html">MoveEffectAttr</a>.<ahref="data_move.MoveEffectAttr.html#selfTarget">selfTarget</a></p><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/283714bd0fa1776ae4d408d8fcb0d75d7901fe91/src/data/move.ts#L513">src/data/move.ts:513</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited"><aid="trigger"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>trigger</span><ahref="#trigger"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">trigger</span><spanclass="tsd-signature-symbol">:</span><ahref="../enums/data_move.MoveEffectTrigger.html"class="tsd-signature-type tsd-kind-enum">MoveEffectTrigger</a></div><divclass="tsd-comment tsd-typography"><p>Defines when this effect should trigger in the move's effect order</p>
</div><asideclass="tsd-sources"><p>Inherited from <ahref="data_move.MoveEffectAttr.html">MoveEffectAttr</a>.<ahref="data_move.MoveEffectAttr.html#trigger">trigger</a></p><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/283714bd0fa1776ae4d408d8fcb0d75d7901fe91/src/data/move.ts#L588">src/data/move.ts:588</a></li></ul></aside></section></section><sectionclass="tsd-panel-group tsd-member-group"><h2>Methods</h2><sectionclass="tsd-panel tsd-member"><aid="apply"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>apply</span><ahref="#apply"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass="tsd-signature tsd-anchor-link"><aid="apply.apply-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">apply</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">user</span>, <spanclass="tsd-kind-parameter">target</span>, <spanclass="tsd-kind-parameter">move</span>, <spanclass="tsd-kind-parameter">args</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">boolean</span><ahref="#apply.apply-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Heals the user the determined amount and possibly displays a message about regaining health.
If the target has the <ahref="data_ability.ReverseDrainAbAttr.html"class="tsd-kind-class"><code>ReverseDrainAbAttr</code></a>, all healing is instead converted
to damage to the user.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">user</span>: <ahref="field_pokemon.default.html"class="tsd-signature-type tsd-kind-class">default</a></span><divclass="tsd-comment tsd-typography"><p><ahref="field_pokemon.default.html"class="tsd-kind-class"><code>Pokemon</code></a> using this move</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">target</span>: <ahref="field_pokemon.default.html"class="tsd-signature-type tsd-kind-class">default</a></span><divclass="tsd-comment tsd-typography"><p><ahref="field_pokemon.default.html"class="tsd-kind-class"><code>Pokemon</code></a> target of this move</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">move</span>: <ahref="data_move.default.html"class="tsd-signature-type tsd-kind-class">default</a></span><divclass="tsd-comment tsd-typography"><p><ahref="data_move.default.html"class="tsd-kind-class"><code>Move</code></a> being used</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">boolean</span></h4><p>true if the function succeeds</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">user</span>: <ahref="field_pokemon.default.html"class="tsd-signature-type tsd-kind-class">default</a></span><divclass="tsd-comment tsd-typography"><p><ahref="field_pokemon.default.html"class="tsd-kind-class"><code>Pokemon</code></a> using the move</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">target</span>: <ahref="field_pokemon.default.html"class="tsd-signature-type tsd-kind-class">default</a></span><divclass="tsd-comment tsd-typography"><p><ahref="field_pokemon.default.html"class="tsd-kind-class"><code>Pokemon</code></a> target of the move</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">move</span>: <ahref="data_move.default.html"class="tsd-signature-type tsd-kind-class">default</a></span><divclass="tsd-comment tsd-typography"><p><ahref="data_move.default.html"class="tsd-kind-class"><code>Move</code></a> with this attribute</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">args</span>: <spanclass="tsd-signature-type">any</span><spanclass="tsd-signature-symbol">[]</span></span><divclass="tsd-comment tsd-typography"><p>Set of unique arguments needed by this attribute</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">boolean</span></h4><p>true if basic application of the ability attribute should be possible</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">target</span>: <ahref="field_pokemon.default.html"class="tsd-signature-type tsd-kind-class">default</a></span><divclass="tsd-comment tsd-typography"><p><ahref="field_pokemon.default.html"class="tsd-kind-class"><code>Pokemon</code></a> target of the move</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">move</span>: <ahref="data_move.default.html"class="tsd-signature-type tsd-kind-class">default</a></span><divclass="tsd-comment tsd-typography"><p><ahref="data_move.default.html"class="tsd-kind-class"><code>Move</code></a> with this attribute</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">cancelled</span>: <ahref="utils.BooleanHolder.html"class="tsd-signature-type tsd-kind-class">BooleanHolder</a></span><divclass="tsd-comment tsd-typography"><p><ahref="utils.BooleanHolder.html"class="tsd-kind-class"><code>Utils.BooleanHolder</code></a> which stores if the move should fail</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">string</span></h4><p>the string representing failure of this <ahref="data_move.default.html"class="tsd-kind-class"><code>Move</code></a></p>
<divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from <ahref="data_move.MoveEffectAttr.html">MoveEffectAttr</a>.<ahref="data_move.MoveEffectAttr.html#getFailedText">getFailedText</a></p><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/283714bd0fa1776ae4d408d8fcb0d75d7901fe91/src/data/move.ts#L549">src/data/move.ts:549</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited"><aid="getTargetBenefitScore"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>get<wbr/>Target<wbr/>Benefit<wbr/>Score</span><ahref="#getTargetBenefitScore"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited"><liclass="tsd-signature tsd-anchor-link"><aid="getTargetBenefitScore.getTargetBenefitScore-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">get<wbr/>Target<wbr/>Benefit<wbr/>Score</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">user</span>, <spanclass="tsd-kind-parameter">target</span>, <spanclass="tsd-kind-parameter">move</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">number</span><ahref="#getTargetBenefitScore.getTargetBenefitScore-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Used by the Enemy AI to rank an attack based on a given target</p>
</div><asideclass="tsd-sources"><p>Inherited from <ahref="data_move.MoveEffectAttr.html">MoveEffectAttr</a>.<ahref="data_move.MoveEffectAttr.html#getTargetBenefitScore">getTargetBenefitScore</a></p><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/283714bd0fa1776ae4d408d8fcb0d75d7901fe91/src/data/move.ts#L567">src/data/move.ts:567</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="getUserBenefitScore"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>get<wbr/>User<wbr/>Benefit<wbr/>Score</span><ahref="#getUserBenefitScore"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass="tsd-signature tsd-anchor-link"><aid="getUserBenefitScore.getUserBenefitScore-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">get<wbr/>User<wbr/>Benefit<wbr/>Score</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">user</span>, <spanclass="tsd-kind-parameter">target</span>, <spanclass="tsd-kind-parameter">move</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">number</span><ahref="#getUserBenefitScore.getUserBenefitScore-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Used by the Enemy AI to rank an attack based on a given user</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">user</span>: <ahref="field_pokemon.default.html"class="tsd-signature-type tsd-kind-class">default</a></span><divclass="tsd-comment tsd-typography"><p><ahref="field_pokemon.default.html"class="tsd-kind-class"><code>Pokemon</code></a> using this move</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">target</span>: <ahref="field_pokemon.default.html"class="tsd-signature-type tsd-kind-class">default</a></span><divclass="tsd-comment tsd-typography"><p><ahref="field_pokemon.default.html"class="tsd-kind-class"><code>Pokemon</code></a> target of this move</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">move</span>: <ahref="data_move.default.html"class="tsd-signature-type tsd-kind-class">default</a></span><divclass="tsd-comment tsd-typography"><p><ahref="data_move.default.html"class="tsd-kind-class"><code>Move</code></a> being used</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">number</span></h4><p>an integer. Higher means enemy is more likely to use that move.</p>
