ShuriZma
/
pokerogue
mirror of https://github.com/pagefaultgames/pokerogue.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
pokerogue/main/classes/phases_egg_lapse_phase.EggL...

23 lines
26 KiB
HTML
Raw Normal View History

[skip ci] Deploy docs
2024-09-10 22:07:25 +00:00
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>EggLapsePhase | 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/phases_egg_lapse_phase.html">phases/egg-lapse-phase</a></li><li><a href="phases_egg_lapse_phase.EggLapsePhase.html">EggLapsePhase</a></li></ul><h1>Class EggLapsePhase</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Phase that handles updating eggs, and hatching any ready eggs
Also handles prompts for skipping animation, and calling the egg summary phase</p>
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a href="../hierarchy.html#phases/egg-lapse-phase.EggLapsePhase">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="phase.Phase.html" class="tsd-signature-type tsd-kind-class">Phase</a><ul class="tsd-hierarchy"><li><span class="target">EggLapsePhase</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/4808c07cf9e92714e4b7c0ba77a6b5e96fbe9c34/src/phases/egg-lapse-phase.ts#L17">src/phases/egg-lapse-phase.ts:17</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><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="phases_egg_lapse_phase.EggLapsePhase.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-09-01 22:17:02 +00:00
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="phases_egg_lapse_phase.EggLapsePhase.html#scene" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>scene</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="phases_egg_lapse_phase.EggLapsePhase.html#end" 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>end</span></a>
[skip ci] Deploy docs
2024-09-10 22:07:25 +00:00
<a href="phases_egg_lapse_phase.EggLapsePhase.html#generatePokemon" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>generate<wbr/>Pokemon</span></a>
<a href="phases_egg_lapse_phase.EggLapsePhase.html#hatchEggSilently" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>hatch<wbr/>Egg<wbr/>Silently</span></a>
<a href="phases_egg_lapse_phase.EggLapsePhase.html#hatchEggsRegular" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>hatch<wbr/>Eggs<wbr/>Regular</span></a>
<a href="phases_egg_lapse_phase.EggLapsePhase.html#hatchEggsSkipped" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>hatch<wbr/>Eggs<wbr/>Skipped</span></a>
<a href="phases_egg_lapse_phase.EggLapsePhase.html#showSummary" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>show<wbr/>Summary</span></a>
[skip ci] Deploy docs
2024-09-01 22:17:02 +00:00
<a href="phases_egg_lapse_phase.EggLapsePhase.html#start" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>start</span></a>
[skip ci] Deploy docs
2024-09-10 22:07:25 +00:00
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Constructors</h2></summary><section><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_EggLapsePhase" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Egg<wbr/>Lapse<wbr/>Phase</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scene</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="phases_egg_lapse_phase.EggLapsePhase.html" class="tsd-signature-type tsd-kind-class">EggLapsePhase</a><a href="#constructor.new_EggLapsePhase" 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">scene</span>: <a href="battle_scene.default.html" class="tsd-signature-type tsd-kind-class">default</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="phases_egg_lapse_phase.EggLapsePhase.html" class="tsd-signature-type tsd-kind-class">EggLapsePhase</a></h4><aside class="tsd-sources"><p>Overrides <a href="phase.Phase.html">Phase</a>.<a href="phase.Phase.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/4808c07cf9e92714e4b7c0ba77a6b5e96fbe9c34/src/phases/egg-lapse-phase.ts#L21">src/phases/egg-lapse-phase.ts:21</a></li></ul></aside></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="scene" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Protected</code><span>scene</span><a href="#scene" 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">scene</span><span class="tsd-signature-symbol">:</span> <a href="battle_scene.default.html" class="tsd-signature-type tsd-kind-class">default</a></div><aside class="tsd-sources"><p>Inherited from <a href="phase.Phase.html">Phase</a>.<a href="phase.Phase.html#scene">scene</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/4808c07cf9e92714e4b7c0ba77a6b5e96fbe9c34/src/phase.ts#L4">src/phase.ts:4</a></li></ul></aside></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Methods</h2></summary><section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="end" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>end</span><a href="#end" 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="end.end-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">egg</span>: <a href="data_egg.Egg.html" class="tsd-signature-type tsd-kind-class">Egg</a></span><div class="tsd-comment tsd-typography"><p>the egg to hatch</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="data_egg_hatch_data.EggHatchData.html" class="tsd-signature-type tsd-kind-class">EggHatchData</a></h4><p>the hatched PlayerPokemon</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/4808c07cf9e92714e4b7c0ba77a6b5e96fbe9c34/src/phases/egg-lapse-phase.ts#L125">src/phases/egg-lapse-phase.ts:125</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="hatchEggSilently" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>hatch<wbr/>Egg<wbr/>Silently</span><a href="#hatchEggSilently" 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="hatchEggSilently.hatchEggSilently-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">hatch<wbr/>Egg<wbr/>Silently</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">egg</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#hatchEggSilently.hatchEggSilently-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>Hatches an egg and stores it in the local EggHatchData array without animations
Also validates the achievements for the hatched pokemon and removes the egg</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">egg</span>: <a href="data_egg.Egg.html" class="tsd-signature-type tsd-kind-class">Egg</a></span><div class="tsd-comment tsd-typography"><p>egg to hatch</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/4808c07cf9e92714e4b7c0ba77a6b5e96fbe9c34/src/phases/egg-lapse-phase.ts#L92">src/phases/egg-lapse-phase.ts:92</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="hatchEggsRegular" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>hatch<wbr/>Eggs<wbr/>Regular</span><a href="#hatchEggsRegular" 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="hatchEggsRegular.hatchEggsRegular-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">hatch<wbr/>Eggs<wbr/>Regular</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eggsToHatch</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#hatchEggsRegular.hatchEggsRegular-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>Hatches eggs normally one by one, showing animations</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">eggsToHatch</span>: <a href="data_egg.Egg.html" class="tsd-signature-type tsd-kind-class">Egg</a><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>list of eggs to hatch</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/4808c07cf9e92714e4b7c0ba77a6b5e96fbe9c34/src/phases/egg-lapse-phase.ts#L64">src/phases/egg-lapse-phase.ts:64</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="hatchEggsSkipped" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>hatch<wbr/>Eggs<wbr/>Skipped</span><a href="#hatchEggsSkipped" 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="hatchEggsSkipped.hatchEggsSkipped-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">hatch<wbr/>Eggs<wbr/>Skipped</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eggsToHatch</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#hatchEggsSkipped.hatchEggsSkipped-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>Hatches eggs with no animations</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">eggsToHatch</span>: <a href="data_egg.Egg.html" class="tsd-signature-type tsd-kind-class">Egg</a><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>list of eggs to hatch</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/4808c07cf9e92714e4b7c0ba77a6b5e96fbe9c34/src/phases/egg-lapse-phase.ts#L76">src/phases/egg-lapse-phase.ts:76</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="showSummary" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>show<wbr/>Summary</span><a href="#showSummary" 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="showSummary.showSummary-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">show<wbr/>Summary</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#showSummary.showSummary-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">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/4808c07cf9e92714e4b7c0ba77a6b5e96fbe9c34/src/phases/egg-lapse-phase.ts#L82">src/phases/egg-lapse-phase.ts:82</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="start" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>start</span><a href="#start" 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="start.start-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">start</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#start.start-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">void</span></h4><aside class="tsd-sources"><p>Overrides <a href="phase.Phase.html">Phase</a>.<a href="phase.Phase.html#start">start</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/4808c07cf9e92714e4b7c0ba77a6b5e96fbe9c34/src/phases/egg-lapse-phase.ts#L25">src/phases/egg-lapse-phase.ts:25</a></li></ul></aside></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><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"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-c