random-mirrors
/
pokerogue
mirror of https://github.com/pagefaultgames/pokerogue.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
pokerogue/main/interfaces/data_egg.IEggOptions.html

35 lines
27 KiB
HTML
Raw Permalink Normal View History

[skip ci] Deploy docs
2024-07-28 00:48:18 +01:00
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>IEggOptions | 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_egg.html">data/egg</a></li><li><a href="data_egg.IEggOptions.html">IEggOptions</a></li></ul><h1>Interface IEggOptions</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Egg options to override egg properties</p>
[skip ci] Deploy docs
2024-11-18 18:42:56 +00:00
</div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">IEggOptions</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="data_egg.IEggOptions.html#eggDescriptor">eggDescriptor</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="data_egg.IEggOptions.html#eggMoveIndex">eggMoveIndex</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="data_egg.IEggOptions.html#hatchWaves">hatchWaves</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="data_egg.IEggOptions.html#id">id</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="data_egg.IEggOptions.html#isShiny">isShiny</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="data_egg.IEggOptions.html#overrideHiddenAbility">overrideHiddenAbility</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="data_egg.IEggOptions.html#pulled">pulled</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="data_egg.IEggOptions.html#scene">scene</a><span class="tsd-signature-symbol">?: </span><a href="../classes/battle_scene.default.html" class="tsd-signature-type tsd-kind-class">default</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="data_egg.IEggOptions.html#sourceType">sourceType</a><span class="tsd-signature-symbol">?: </span><a href="../enums/enums_egg_source_types.EggSourceType.html" class="tsd-signature-type tsd-kind-enum">EggSourceType</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="data_egg.IEggOptions.html#species">species</a><span class="tsd-signature-symbol">?: </span><a href="../enums/enums_species.Species.html" class="tsd-signature-type tsd-kind-enum">Species</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="data_egg.IEggOptions.html#tier">tier</a><span class="tsd-signature-symbol">?: </span><a href="../enums/enums_egg_type.EggTier.html" class="tsd-signature-type tsd-kind-enum">EggTier</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="data_egg.IEggOptions.html#timestamp">timestamp</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="data_egg.IEggOptions.html#variantTier">variantTier</a><span class="tsd-signature-symbol">?: </span><a href="../enums/enums_variant_tier.VariantTier.html" class="tsd-signature-type tsd-kind-enum">VariantTier</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/0c920ba195c8fa8470694f5a1f4b3157438aa256/src/data/egg.ts#L19">src/data/egg.ts:19</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><detail
[skip ci] Deploy docs
2024-09-27 22:52:07 +01:00
<a href="data_egg.IEggOptions.html#eggMoveIndex" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>egg<wbr/>Move<wbr/>Index?</span></a>
[skip ci] Deploy docs
2024-06-22 01:21:13 +01:00
<a href="data_egg.IEggOptions.html#hatchWaves" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>hatch<wbr/>Waves?</span></a>
<a href="data_egg.IEggOptions.html#id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id?</span></a>
<a href="data_egg.IEggOptions.html#isShiny" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Shiny?</span></a>
<a href="data_egg.IEggOptions.html#overrideHiddenAbility" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>override<wbr/>Hidden<wbr/>Ability?</span></a>
<a href="data_egg.IEggOptions.html#pulled" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>pulled?</span></a>
<a href="data_egg.IEggOptions.html#scene" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>scene?</span></a>
<a href="data_egg.IEggOptions.html#sourceType" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>source<wbr/>Type?</span></a>
<a href="data_egg.IEggOptions.html#species" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>species?</span></a>
<a href="data_egg.IEggOptions.html#tier" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tier?</span></a>
<a href="data_egg.IEggOptions.html#timestamp" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>timestamp?</span></a>
<a href="data_egg.IEggOptions.html#variantTier" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>variant<wbr/>Tier?</span></a>
[skip ci] Deploy docs
2024-09-27 22:52:07 +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-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"><a id="eggDescriptor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>egg<wbr/>Descriptor</span><a href="#eggDescriptor" 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">egg<wbr/>Descriptor</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Can customize the message displayed for where the egg was obtained</p>
[skip ci] Deploy docs
2024-11-18 18:42:56 +00:00
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/0c920ba195c8fa8470694f5a1f4b3157438aa256/src/data/egg.ts#L57">src/data/egg.ts:57</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="eggMoveIndex" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>egg<wbr/>Move<wbr/>Index</span><a href="#eggMoveIndex" 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">egg<wbr/>Move<wbr/>Index</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>Defines which egg move will be unlocked. 3 = rare egg 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/0c920ba195c8fa8470694f5a1f4b3157438aa256/src/data/egg.ts#L50">src/data/egg.ts:50</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="hatchWaves" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>hatch<wbr/>Waves</span><a href="#hatchWaves" 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">hatch<wbr/>Waves</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>Sets how many waves it will take till this egg hatches.</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/0c920ba195c8fa8470694f5a1f4b3157438aa256/src/data/egg.ts#L40">src/data/egg.ts:40</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>id</span><a href="#id" 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">id</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>Id. Used to check if egg type will be manaphy (id % 204 === 0)</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/0c920ba195c8fa8470694f5a1f4b3157438aa256/src/data/egg.ts#L21">src/data/egg.ts:21</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="isShiny" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>is<wbr/>Shiny</span><a href="#isShiny" 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">is<wbr/>Shiny</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Defines if the hatched pokemon will be a shiny.</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/0c920ba195c8fa8470694f5a1f4b3157438aa256/src/data/egg.ts#L46">src/data/egg.ts:46</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="overrideHiddenAbility" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>override<wbr/>Hidden<wbr/>Ability</span><a href="#overrideHiddenAbility" 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">override<wbr/>Hidden<wbr/>Ability</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Defines if the egg will hatch with the hidden ability of this species.
[skip ci] Deploy docs
2024-07-28 00:48:18 +01:00
If no hidden ability exist, a random one will get choosen.</p>
[skip ci] Deploy docs
2024-11-18 18:42:56 +00:00
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/0c920ba195c8fa8470694f5a1f4b3157438aa256/src/data/egg.ts#L54">src/data/egg.ts:54</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="pulled" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>pulled</span><a href="#pulled" 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">pulled</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Defines if the egg got pulled from a gacha or not. If true, egg pity and pull statistics will be applyed.
[skip ci] Deploy docs
2024-06-22 01:21:13 +01:00
Egg will be automaticly added to the game data.
NEEDS scene eggOption to work.</p>
[skip ci] Deploy docs
2024-11-18 18:42:56 +00:00
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/0c920ba195c8fa8470694f5a1f4b3157438aa256/src/data/egg.ts#L28">src/data/egg.ts:28</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="scene" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</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="../classes/battle_scene.default.html" class="tsd-signature-type tsd-kind-class">default</a></div><div class="tsd-comment tsd-typography"><p>Needs to be defined if eggOption pulled is defined or if no species or isShiny is degined since this will be needed to generate them.</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/0c920ba195c8fa8470694f5a1f4b3157438aa256/src/data/egg.ts#L34">src/data/egg.ts:34</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="sourceType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>source<wbr/>Type</span><a href="#sourceType" 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">source<wbr/>Type</span><span class="tsd-signature-symbol">?:</span> <a href="../enums/enums_egg_source_types.EggSourceType.html" class="tsd-signature-type tsd-kind-enum">EggSourceType</a></div><div class="tsd-comment tsd-typography"><p>Defines where the egg comes from. Applies specific modifiers.
[skip ci] Deploy docs
2024-06-22 01:21:13 +01:00
Will also define the text displayed in the egg list.</p>
[skip ci] Deploy docs
2024-11-18 18:42:56 +00:00
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/0c920ba195c8fa8470694f5a1f4b3157438aa256/src/data/egg.ts#L32">src/data/egg.ts:32</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="species" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>species</span><a href="#species" 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">species</span><span class="tsd-signature-symbol">?:</span> <a href="../enums/enums_species.Species.html" class="tsd-signature-type tsd-kind-enum">Species</a></div><div class="tsd-comment tsd-typography"><p>Sets the exact species that will hatch from this egg.
[skip ci] Deploy docs
2024-06-22 01:21:13 +01:00
Needs scene eggOption if not provided.</p>
[skip ci] Deploy docs
2024-11-18 18:42:56 +00:00
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/0c920ba195c8fa8470694f5a1f4b3157438aa256/src/data/egg.ts#L44">src/data/egg.ts:44</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="tier" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>tier</span><a href="#tier" 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">tier</span><span class="tsd-signature-symbol">?:</span> <a href="../enums/enums_egg_type.EggTier.html" class="tsd-signature-type tsd-kind-enum">EggTier</a></div><div class="tsd-comment tsd-typography"><p>Sets the tier of the egg. Only species of this tier can be hatched from this egg.
[skip ci] Deploy docs
2024-06-22 01:21:13 +01:00
Tier will be overriden if species eggOption is set.</p>
[skip ci] Deploy docs
2024-11-18 18:42:56 +00:00
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/0c920ba195c8fa8470694f5a1f4b3157438aa256/src/data/egg.ts#L38">src/data/egg.ts:38</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="timestamp" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>timestamp</span><a href="#timestamp" 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">timestamp</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>Timestamp when this egg got created</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/0c920ba195c8fa8470694f5a1f4b3157438aa256/src/data/egg.ts#L23">src/data/egg.ts:23</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="variantTier" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>variant<wbr/>Tier</span><a href="#variantTier" 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">variant<wbr/>Tier</span><span class="tsd-signature-symbol">?:</span> <a href="../enums/enums_variant_tier.VariantTier.html" class="tsd-signature-type tsd-kind-enum">VariantTier</a></div><div class="tsd-comment tsd-typography"><p>Defines the variant of the pokemon that will hatch from this egg. If no variantTier is given the normal variant rates will apply.</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/0c920ba195c8fa8470694f5a1f4b3157438aa256/src/data/egg.ts#L48">src/data/egg.ts:48</a></li></ul></aside></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-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="#eggDescriptor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>egg<wbr/>Descriptor</span></a><a href="#eggMoveIndex" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>egg<wbr/>Move<wbr/>Index</span></a><a href="#hatchWaves" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>hatch<wbr/>Waves</span></a><a href="#id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id</span></a><a href="#isShiny" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Shiny</span></a><a href="#overrideHiddenAbility" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>override<wbr/>Hidden<wbr/>Ability</span></a><a href="#pulled" class="">