pokerogue/main/classes/phases_egg_hatch_phase.EggHatchPhase.html

37 lines
33 KiB
HTML
Raw Normal View History

2024-09-01 23:17:02 +01:00
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>EggHatchPhase | 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_hatch_phase.html">phases/egg-hatch-phase</a></li><li><a href="phases_egg_hatch_phase.EggHatchPhase.html">EggHatchPhase</a></li></ul><h1>Class EggHatchPhase</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Class that represents egg hatching</p>
2024-09-29 04:01:52 +01:00
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a href="../hierarchy.html#phases/egg-hatch-phase.EggHatchPhase">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">EggHatchPhase</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/3e8b3930a8911e849d6e0153b9f6112214aee690/src/phases/egg-hatch-phase.ts#L22">src/phases/egg-hatch-phase.ts:22</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_hatch_phase.EggHatchPhase.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-09-01 23:17:02 +01:00
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="phases_egg_hatch_phase.EggHatchPhase.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_hatch_phase.EggHatchPhase.html#doEggShake" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>do<wbr/>Egg<wbr/>Shake</span></a>
<a href="phases_egg_hatch_phase.EggHatchPhase.html#doHatch" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>do<wbr/>Hatch</span></a>
<a href="phases_egg_hatch_phase.EggHatchPhase.html#doReveal" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>do<wbr/>Reveal</span></a>
<a href="phases_egg_hatch_phase.EggHatchPhase.html#doSpray" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>do<wbr/>Spray</span></a>
<a href="phases_egg_hatch_phase.EggHatchPhase.html#doSprayParticle" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>do<wbr/>Spray<wbr/>Particle</span></a>
<a href="phases_egg_hatch_phase.EggHatchPhase.html#end" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>end</span></a>
<a href="phases_egg_hatch_phase.EggHatchPhase.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_hatch_phase.EggHatchPhase.html#sin" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>sin</span></a>
<a href="phases_egg_hatch_phase.EggHatchPhase.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>
<a href="phases_egg_hatch_phase.EggHatchPhase.html#trySkip" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>try<wbr/>Skip</span></a>
2024-09-29 04:01:52 +01: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_EggHatchPhase" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Egg<wbr/>Hatch<wbr/>Phase</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scene</span>, <span class="tsd-kind-parameter">hatchScene</span>, <span class="tsd-kind-parameter">egg</span>, <span class="tsd-kind-parameter">eggsToHatchCount</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="phases_egg_hatch_phase.EggHatchPhase.html" class="tsd-signature-type tsd-kind-class">EggHatchPhase</a><a href="#constructor.new_EggHatchPhase" 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><li><span><span class="tsd-kind-parameter">hatchScene</span>: <a href="phases_egg_lapse_phase.EggLapsePhase.html" class="tsd-signature-type tsd-kind-class">EggLapsePhase</a></span></li><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></li><li><span><span class="tsd-kind-parameter">eggsToHatchCount</span>: <span class="tsd-signature-type">number</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="phases_egg_hatch_phase.EggHatchPhase.html" class="tsd-signature-type tsd-kind-class">EggHatchPhase</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/3e8b3930a8911e849d6e0153b9f6112214aee690/src/phases/egg-hatch-phase.ts#L69">src/phases/egg-hatch-phase.ts:69</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/3e8b3930a8911e849d6e0153b9f6112214aee690/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
2024-09-01 23:17:02 +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">intensity</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>of horizontal shaking. Doubled on the first call (where count is 0)</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">repeatCount</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>the number of times this function should be called (asynchronous recursion?!?)</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">count</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>the current number of times this function has been called.</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>nothing since it's a Promise<void></p>
2024-09-29 04:01:52 +01:00
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/3e8b3930a8911e849d6e0153b9f6112214aee690/src/phases/egg-hatch-phase.ts#L222">src/phases/egg-hatch-phase.ts:222</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="doHatch" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>do<wbr/>Hatch</span><a href="#doHatch" 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="doHatch.doHatch-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">do<wbr/>Hatch</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="#doHatch.doHatch-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>Plays the animation of an egg hatch</p>
</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/3e8b3930a8911e849d6e0153b9f6112214aee690/src/phases/egg-hatch-phase.ts#L284">src/phases/egg-hatch-phase.ts:284</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="doReveal" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>do<wbr/>Reveal</span><a href="#doReveal" 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="doReveal.doReveal-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">do<wbr/>Reveal</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="#doReveal.doReveal-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>Function to do the logic and animation of completing a hatch and revealing the Pokemon</p>
</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/3e8b3930a8911e849d6e0153b9f6112214aee690/src/phases/egg-hatch-phase.ts#L316">src/phases/egg-hatch-phase.ts:316</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="doSpray" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>do<wbr/>Spray</span><a href="#doSpray" 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="doSpray.doSpray-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">do<wbr/>Spray</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">intensity</span>, <span class="tsd-kind-parameter">offsetY</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="#doSpray.doSpray-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>Animates spraying</p>
2024-09-01 23:17:02 +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">intensity</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>number of times this is repeated (this is a badly named variable)</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">offsetY</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>how much to offset the Y coordinates</p>
2024-09-29 04:01:52 +01:00
</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/3e8b3930a8911e849d6e0153b9f6112214aee690/src/phases/egg-hatch-phase.ts#L388">src/phases/egg-hatch-phase.ts:388</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="doSprayParticle" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>do<wbr/>Spray<wbr/>Particle</span><a href="#doSprayParticle" 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="doSprayParticle.doSprayParticle-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">do<wbr/>Spray<wbr/>Particle</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">trigIndex</span>, <span class="tsd-kind-parameter">offsetY</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#doSprayParticle.doSprayParticle-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>Animates a particle used in the spray animation</p>
2024-09-01 23:17:02 +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">trigIndex</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>Used to modify the particle's vertical speed, is a random number from 0-7</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">offsetY</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>how much to offset the Y coordinate</p>
2024-09-29 04:01:52 +01:00
</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/3e8b3930a8911e849d6e0153b9f6112214aee690/src/phases/egg-hatch-phase.ts#L403">src/phases/egg-hatch-phase.ts:403</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><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"><li class="tsd-signature tsd-anchor-link"><a id="end.end-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">end</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="#end.end-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#end">end</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/3e8b3930a8911e849d6e0153b9f6112214aee690/src/phases/egg-hatch-phase.ts#L206">src/phases/egg-hatch-phase.ts:206</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="generatePokemon" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>generate<wbr/>Pokemon</span><a href="#generatePokemon" 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="generatePokemon.generatePokemon-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">generate<wbr/>Pokemon</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="field_pokemon.PlayerPokemon.html" class="tsd-signature-type tsd-kind-class">PlayerPokemon</a><a href="#generatePokemon.generatePokemon-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>Generates a Pokemon to be hatched by the egg
2024-09-10 23:07:25 +01:00
Also stores the generated pokemon in this.eggHatchData</p>
2024-09-01 23:17:02 +01:00
</div><h4 class="tsd-returns-title">Returns <a href="field_pokemon.PlayerPokemon.html" class="tsd-signature-type tsd-kind-class">PlayerPokemon</a></h4><p>the hatched PlayerPokemon</p>
2024-09-29 04:01:52 +01:00
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/3e8b3930a8911e849d6e0153b9f6112214aee690/src/phases/egg-hatch-phase.ts#L449">src/phases/egg-hatch-phase.ts:449</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="sin" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>sin</span><a href="#sin" 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="sin.sin-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">sin</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">index</span>, <span class="tsd-kind-parameter">amplitude</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#sin.sin-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>Helper function to generate sine. (Why is this not a Utils?!?)</p>
2024-09-01 23:17:02 +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">index</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>random number from 0-7 being passed in to scale pi/128</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">amplitude</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>Scaling</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>a number</p>
2024-09-29 04:01:52 +01:00
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/3e8b3930a8911e849d6e0153b9f6112214aee690/src/phases/egg-hatch-phase.ts#L379">src/phases/egg-hatch-phase.ts:379</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/3e8b3930a8911e849d6e0153b9f6112214aee690/src/phases/egg-hatch-phase.ts#L76">src/phases/egg-hatch-phase.ts:76</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="trySkip" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>try<wbr/>Skip</span><a href="#trySkip" 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="trySkip.trySkip-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">try<wbr/>Skip</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#trySkip.trySkip-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>Tries to skip the hatching animation</p>
2024-09-01 23:17:02 +01:00
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>false if cannot be skipped or already skipped. True otherwise</p>
2024-09-29 04:01:52 +01:00
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/3e8b3930a8911e849d6e0153b9f6112214aee690/src/phases/egg-hatch-phase.ts#L265">src/phases/egg-hatch-phase.ts:265</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-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></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><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-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"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><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></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#scene" class="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></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#doEggShake" class=""><svg class="tsd-kind-icon" viewBox="0