pokerogue/main/classes/system_achv.HealAchv.html

21 lines
33 KiB
HTML
Raw Normal View History

2024-06-24 20:01:36 +01:00
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>HealAchv | 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/system_achv.html">system/achv</a></li><li><a href="system_achv.HealAchv.html">HealAchv</a></li></ul><h1>Class HealAchv</h1></div><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#system/achv.HealAchv">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="system_achv.Achv.html" class="tsd-signature-type tsd-kind-class">Achv</a><ul class="tsd-hierarchy"><li><span class="target">HealAchv</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/bc5de8810b4fccd209d6a90a67997afa389e5d05/src/system/achv.ts#L114">src/system/achv.ts:114</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="system_achv.HealAchv.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
2024-05-31 14:57:14 +01:00
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="system_achv.HealAchv.html#description" 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>description</span></a>
<a href="system_achv.HealAchv.html#hasParent" 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>has<wbr/>Parent</span></a>
2024-06-02 00:54:33 +01:00
<a href="system_achv.HealAchv.html#healAmount" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>heal<wbr/>Amount</span></a>
2024-05-31 14:57:14 +01:00
<a href="system_achv.HealAchv.html#iconImage" 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>icon<wbr/>Image</span></a>
<a href="system_achv.HealAchv.html#id" 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>id</span></a>
2024-06-02 00:54:33 +01:00
<a href="system_achv.HealAchv.html#localizationKey" 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>localization<wbr/>Key</span></a>
2024-05-31 14:57:14 +01:00
<a href="system_achv.HealAchv.html#name" 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>name</span></a>
<a href="system_achv.HealAchv.html#parentId" 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>parent<wbr/>Id</span></a>
<a href="system_achv.HealAchv.html#score" 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>score</span></a>
<a href="system_achv.HealAchv.html#secret" 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>secret</span></a>
2024-06-07 23:34:52 +01:00
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="system_achv.HealAchv.html#getDescription" 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/>Description</span></a>
<a href="system_achv.HealAchv.html#getIconImage" 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/>Icon<wbr/>Image</span></a>
2024-05-31 14:57:14 +01:00
<a href="system_achv.HealAchv.html#getName" 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/>Name</span></a>
<a href="system_achv.HealAchv.html#getTier" 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/>Tier</span></a>
<a href="system_achv.HealAchv.html#setSecret" 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>set<wbr/>Secret</span></a>
<a href="system_achv.HealAchv.html#validate" 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>validate</span></a>
2024-06-24 20:01:36 +01: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_HealAchv" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Heal<wbr/>Achv</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">localizationKey</span>, <span class="tsd-kind-parameter">name</span>, <span class="tsd-kind-parameter">healAmount</span>, <span class="tsd-kind-parameter">iconImage</span>, <span class="tsd-kind-parameter">score</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="system_achv.HealAchv.html" class="tsd-signature-type tsd-kind-class">HealAchv</a><a href="#constructor.new_HealAchv" 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">localizationKey</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">healAmount</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">iconImage</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">score</span>: <span class="tsd-signature-type">number</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="system_achv.HealAchv.html" class="tsd-signature-type tsd-kind-class">HealAchv</a></h4><aside class="tsd-sources"><p>Overrides <a href="system_achv.Achv.html">Achv</a>.<a href="system_achv.Achv.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/bc5de8810b4fccd209d6a90a67997afa389e5d05/src/system/achv.ts#L117">src/system/achv.ts:117</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="description" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>description</span><a href="#description" 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">description</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="system_achv.Achv.html">Achv</a>.<a href="system_achv.Achv.html#description">description</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/bc5de8810b4fccd209d6a90a67997afa389e5d05/src/system/achv.ts#L22">src/system/achv.ts:22</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="hasParent" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>has<wbr/>Parent</span><a href="#hasParent" 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">has<wbr/>Parent</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="system_achv.Achv.html">Achv</a>.<a href="system_achv.Achv.html#hasParent">hasParent</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/
2024-06-13 23:45:37 +01: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">playerGender</span>: <a href="../enums/enums_player_gender.PlayerGender.html" class="tsd-signature-type tsd-kind-enum">PlayerGender</a></span><div class="tsd-comment tsd-typography"><p>the gender of the player</p>
2024-06-09 17:41:38 +01:00
</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 name of the achievement localized for the player gender</p>
2024-06-24 20:01:36 +01:00
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="system_achv.Achv.html">Achv</a>.<a href="system_achv.Achv.html#getName">getName</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/bc5de8810b4fccd209d6a90a67997afa389e5d05/src/system/achv.ts#L46">src/system/achv.ts:46</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="getTier" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Tier</span><a href="#getTier" 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="getTier.getTier-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Tier</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../enums/system_achv.AchvTier.html" class="tsd-signature-type tsd-kind-enum">AchvTier</a><a href="#getTier.getTier-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="../enums/system_achv.AchvTier.html" class="tsd-signature-type tsd-kind-enum">AchvTier</a></h4><aside class="tsd-sources"><p>Inherited from <a href="system_achv.Achv.html">Achv</a>.<a href="system_achv.Achv.html#getTier">getTier</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/bc5de8810b4fccd209d6a90a67997afa389e5d05/src/system/achv.ts#L70">src/system/achv.ts:70</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="setSecret" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Secret</span><a href="#setSecret" 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="setSecret.setSecret-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set<wbr/>Secret</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">hasParent</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><a href="#setSecret.setSecret-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><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">hasParent</span>: <span class="tsd-signature-type">boolean</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><aside class="tsd-sources"><p>Inherited from <a href="system_achv.Achv.html">Achv</a>.<a href="system_achv.Achv.html#setSecret">setSecret</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/bc5de8810b4fccd209d6a90a67997afa389e5d05/src/system/achv.ts#L60">src/system/achv.ts:60</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="validate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>validate</span><a href="#validate" 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="validate.validate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">validate</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scene</span>, <span class="t