2024-06-24 14:38:36 +00:00
|
|
|
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Egg | 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.Egg.html">Egg</a></li></ul><h1>Class Egg</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/e9fb13cce96794aaf46088b0947c09901d9f670e/src/data/egg.ts#L66">src/data/egg.ts:66</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="data_egg.Egg.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-06-22 00:21:13 +00:00
|
|
|
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="data_egg.Egg.html#_eggMoveIndex" class="tsd-index-link tsd-is-private"><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="data_egg.Egg.html#_hatchWaves" class="tsd-index-link tsd-is-private"><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.Egg.html#_id" class="tsd-index-link tsd-is-private"><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.Egg.html#_isShiny" class="tsd-index-link tsd-is-private"><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.Egg.html#_overrideHiddenAbility" class="tsd-index-link tsd-is-private"><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.Egg.html#_sourceType" class="tsd-index-link tsd-is-private"><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.Egg.html#_species" class="tsd-index-link tsd-is-private"><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.Egg.html#_tier" class="tsd-index-link tsd-is-private"><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.Egg.html#_timestamp" class="tsd-index-link tsd-is-private"><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.Egg.html#_variantTier" class="tsd-index-link tsd-is-private"><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>
|
|
|
|
|
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Accessors</h3><div class="tsd-index-list"><a href="data_egg.Egg.html#eggMoveIndex" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>egg<wbr/>Move<wbr/>Index</span></a>
|
|
|
|
|
<a href="data_egg.Egg.html#hatchWaves" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>hatch<wbr/>Waves</span></a>
|
|
|
|
|
<a href="data_egg.Egg.html#id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>id</span></a>
|
|
|
|
|
<a href="data_egg.Egg.html#isShiny" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>is<wbr/>Shiny</span></a>
|
|
|
|
|
<a href="data_egg.Egg.html#overrideHiddenAbility" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>override<wbr/>Hidden<wbr/>Ability</span></a>
|
|
|
|
|
<a href="data_egg.Egg.html#sourceType" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>source<wbr/>Type</span></a>
|
|
|
|
|
<a href="data_egg.Egg.html#species" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>species</span></a>
|
|
|
|
|
<a href="data_egg.Egg.html#tier" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>tier</span></a>
|
|
|
|
|
<a href="data_egg.Egg.html#timestamp" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>timestamp</span></a>
|
|
|
|
|
<a href="data_egg.Egg.html#variantTier" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>variant<wbr/>Tier</span></a>
|
|
|
|
|
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="data_egg.Egg.html#addEggToGameData" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Egg<wbr/>To<wbr/>Game<wbr/>Data</span></a>
|
|
|
|
|
<a href="data_egg.Egg.html#checkForPityTierOverrides" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>check<wbr/>For<wbr/>Pity<wbr/>Tier<wbr/>Overrides</span></a>
|
|
|
|
|
<a href="data_egg.Egg.html#generatePlayerPokemon" 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/>Player<wbr/>Pokemon</span></a>
|
|
|
|
|
<a href="data_egg.Egg.html#getEggDescriptor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Egg<wbr/>Descriptor</span></a>
|
|
|
|
|
<a href="data_egg.Egg.html#getEggHatchWavesMessage" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Egg<wbr/>Hatch<wbr/>Waves<wbr/>Message</span></a>
|
|
|
|
|
<a href="data_egg.Egg.html#getEggTierDefaultHatchWaves" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Egg<wbr/>Tier<wbr/>Default<wbr/>Hatch<wbr/>Waves</span></a>
|
|
|
|
|
<a href="data_egg.Egg.html#getEggTierFromSpeciesStarterValue" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Egg<wbr/>Tier<wbr/>From<wbr/>Species<wbr/>Starter<wbr/>Value</span></a>
|
|
|
|
|
<a href="data_egg.Egg.html#getEggTypeDescriptor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Egg<wbr/>Type<wbr/>Descriptor</span></a>
|
|
|
|
|
<a href="data_egg.Egg.html#getKey" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Key</span></a>
|
|
|
|
|
<a href="data_egg.Egg.html#increasePullStatistic" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>increase<wbr/>Pull<wbr/>Statistic</span></a>
|
2024-05-31 13:57:14 +00:00
|
|
|
<a href="data_egg.Egg.html#isManaphyEgg" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Manaphy<wbr/>Egg</span></a>
|
2024-06-22 00:21:13 +00:00
|
|
|
<a href="data_egg.Egg.html#rollEggMoveIndex" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>roll<wbr/>Egg<wbr/>Move<wbr/>Index</span></a>
|
|
|
|
|
<a href="data_egg.Egg.html#rollEggTier" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>roll<wbr/>Egg<wbr/>Tier</span></a>
|
|
|
|
|
<a href="data_egg.Egg.html#rollShiny" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>roll<wbr/>Shiny</span></a>
|
|
|
|
|
<a href="data_egg.Egg.html#rollSpecies" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>roll<wbr/>Species</span></a>
|
|
|
|
|
<a href="data_egg.Egg.html#rollVariant" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>roll<wbr/>Variant</span></a>
|
2024-06-24 14:38:36 +00: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_Egg" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Egg</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eggOptions</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="data_egg.Egg.html" class="tsd-signature-type tsd-kind-class">Egg</a><a href="#constructor.new_Egg" 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">eggOptions</span>: <a href="../interfaces/data_egg.IEggOptions.html" class="tsd-signature-type tsd-kind-interface">IEggOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="data_egg.Egg.html" class="tsd-signature-type tsd-kind-class">Egg</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/e9fb13cce96794aaf46088b0947c09901d9f670e/src/data/egg.ts#L140">src/data/egg.ts:140</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-private"><a id="_eggMoveIndex" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</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><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/e9fb13cce96794aaf46088b0947c09901d9f670e/src/data/egg.ts#L81">src/data/egg.ts:81</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="_hatchWaves" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</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><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/e9fb13cce96794aaf46088b0947c09901d9f670e/src/data/egg.ts#L75">src/data/egg.ts:75</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</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><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/e9fb13cce96794aaf46088b0947c09901d9f670e/src/data/egg.ts#L72">src/d
|
2024-06-22 00:21:13 +00:00
|
|
|
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>True if the egg is shiny</p>
|
2024-06-24 14:38:36 +00:00
|
|
|
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/e9fb13cce96794aaf46088b0947c09901d9f670e/src/data/egg.ts#L432">src/data/egg.ts:432</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="rollSpecies" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>roll<wbr/>Species</span><a href="#rollSpecies" 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-private"><li class="tsd-signature tsd-anchor-link"><a id="rollSpecies.rollSpecies-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">roll<wbr/>Species</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="../enums/enums_species.Species.html" class="tsd-signature-type tsd-kind-enum">Species</a><a href="#rollSpecies.rollSpecies-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><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="../enums/enums_species.Species.html" class="tsd-signature-type tsd-kind-enum">Species</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/e9fb13cce96794aaf46088b0947c09901d9f670e/src/data/egg.ts#L324">src/data/egg.ts:324</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-private"><a id="rollVariant" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>roll<wbr/>Variant</span><a href="#rollVariant" 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-private"><li class="tsd-signature tsd-anchor-link"><a id="rollVariant.rollVariant-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">roll<wbr/>Variant</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../enums/enums_variant_tiers.VariantTier.html" class="tsd-signature-type tsd-kind-enum">VariantTier</a><a href="#rollVariant.rollVariant-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/enums_variant_tiers.VariantTier.html" class="tsd-signature-type tsd-kind-enum">VariantTier</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/e9fb13cce96794aaf46088b0947c09901d9f670e/src/data/egg.ts#L450">src/data/egg.ts:450</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-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"><h4 class="uppercase">Member Visibility</h4><form><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=
|
