pokerogue/main/variables/overrides.default.html

47 lines
46 KiB
HTML
Raw Normal View History

2024-09-27 22:52:07 +01:00
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>default | 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/overrides.html">overrides</a></li><li><a href="overrides.default.html">default</a></li></ul><h1>Variable default</h1></div><div class="tsd-signature"><span class="tsd-kind-variable">default</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">ABILITY_OVERRIDE</span><span class="tsd-signature-symbol">: </span><a href="../enums/enums_abilities.Abilities.html" class="tsd-signature-type tsd-kind-enum">Abilities</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">ARENA_TINT_OVERRIDE</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../enums/enums_time_of_day.TimeOfDay.html" class="tsd-signature-type tsd-kind-enum">TimeOfDay</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">BATTLE_TYPE_OVERRIDE</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;double&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;single&quot;</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">BYPASS_TUTORIAL_SKIP_OVERRIDE</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">EGG_FREE_GACHA_PULLS_OVERRIDE</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">EGG_GACHA_PULL_COUNT_OVERRIDE</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">EGG_<wbr/>FREE_<wbr/>GACHA_<wbr/>PULLS_<wbr/>OVERRIDE</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">EGG_<wbr/>GACHA_<wbr/>PULL_<wbr/>COUNT_<wbr/>OVERRIDE</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">EGG_<wbr/>IMMEDIATE_<wbr/>HATCH_<wbr/>OVERRIDE</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">EGG_<wbr/>SHINY_<wbr/>OVERRIDE</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">EGG_<wbr/>TIER_<wbr/>OVERRIDE</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../enums/enums_egg_type.EggTier.html" class="tsd-signature-type tsd-kind-enum">EggTier</a></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">EGG_<wbr/>VARIANT_<wbr/>OVERRIDE</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../enums/enums_variant_tier.VariantTier.html" class="tsd-signature-type tsd-kind-enum">VariantTier</a></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">FREE_<wbr/>CANDY_<wbr/>UPGRADE_<wbr/>OVERRIDE</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">GENDER_<wbr/>OVERRIDE</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../enums/data_gender.Gender.html" class="tsd-signature-type tsd-kind-enum">Gender</a></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">ITEM_<wbr/>REWARD_<wbr/>OVERRIDE</span><span class="tsd-signature-symbol">: </span><a href="../types/modifier_modifier_type.ModifierOverride.html" class="tsd-signature-type tsd-kind-type-alias">ModifierOverride</a><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><p>Override array of <a href="../types/modifier_modifier_type.ModifierOverride.html" class="tsd-kind-type-alias"><code>ModifierOverride</code></a>s used to replace the generated item rolls after a wave.</p>
2024-08-17 18:01:18 +01:00
<p>If less entries are listed than rolled, only those entries will be used to replace the corresponding items while the rest randomly generated.
If more entries are listed than rolled, only the first X entries will be used, where X is the number of items rolled.</p>
<p>Note that, for all items in the array, <code>count</code> is not used.</p>
2024-09-27 22:52:07 +01:00
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">ITEM_<wbr/>UNLOCK_<wbr/>OVERRIDE</span><span class="tsd-signature-symbol">: </span><a href="../enums/system_unlockables.Unlockables.html" class="tsd-signature-type tsd-kind-enum">Unlockables</a><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><p>Forces an item to be UNLOCKED</p>
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">MOVESET_<wbr/>OVERRIDE</span><span class="tsd-signature-symbol">: </span><a href="../enums/enums_moves.Moves.html" class="tsd-signature-type tsd-kind-enum">Moves</a><span class="tsd-signature-symbol"> | </span><a href="../enums/enums_moves.Moves.html" class="tsd-signature-type tsd-kind-enum">Moves</a><span class="tsd-signature-symbol">[]</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">MYSTERY_<wbr/>ENCOUNTER_<wbr/>OVERRIDE</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../enums/enums_mystery_encounter_type.MysteryEncounterType.html" class="tsd-signature-type tsd-kind-enum">MysteryEncounterType</a></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">MYSTERY_<wbr/>ENCOUNTER_<wbr/>RATE_<wbr/>OVERRIDE</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><p>1 to 256, set to null to ignore</p>
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">MYSTERY_<wbr/>ENCOUNTER_<wbr/>TIER_<wbr/>OVERRIDE</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../enums/enums_mystery_encounter_tier.MysteryEncounterTier.html" class="tsd-signature-type tsd-kind-enum">MysteryEncounterTier</a></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">NEVER_<wbr/>CRIT_<wbr/>OVERRIDE</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">OPP_<wbr/>ABILITY_<wbr/>OVERRIDE</span><span class="tsd-signature-symbol">: </span><a href="../enums/enums_abilities.Abilities.html" class="tsd-signature-type tsd-kind-enum">Abilities</a></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">OPP_<wbr/>FORM_<wbr/>OVERRIDES</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><a href="../enums/enums_species.Species.html" class="tsd-signature-type tsd-kind-enum">Species</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">OPP_<wbr/>GENDER_<wbr/>OVERRIDE</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../enums/data_gender.Gender.html" class="tsd-signature-type tsd-kind-enum">Gender</a></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">OPP_<wbr/>HEALTH_<wbr/>SEGMENTS_<wbr/>OVERRIDE</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><p>Override to give the enemy Pokemon a given amount of health segments</p>
2024-09-10 23:07:25 +01:00
<p>0 (default): the health segments will be handled normally based on wave, level and species
1: the Pokemon will have a single health segment and therefore will not be a boss
2+: the Pokemon will be a boss with the given number of health segments</p>
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">OPP_<wbr/>HELD_<wbr/>ITEMS_<wbr/>OVERRIDE</span><span class="tsd-signature-symbol">: </span><a href="../types/modifier_modifier_type.ModifierOverride.html" class="tsd-signature-type tsd-kind-type-alias">ModifierOverride</a><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><p>Override array of <a href="../types/modifier_modifier_type.ModifierOverride.html" class="tsd-kind-type-alias"><code>ModifierOverride</code></a>s used to provide held items to enemies on spawn.</p>
2024-08-17 18:01:18 +01:00
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">OPP_<wbr/>IVS_<wbr/>OVERRIDE</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">OPP_<wbr/>LEVEL_<wbr/>OVERRIDE</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">OPP_<wbr/>MODIFIER_<wbr/>OVERRIDE</span><span class="tsd-signature-symbol">: </span><a href="../types/modifier_modifier_type.ModifierOverride.html" class="tsd-signature-type tsd-kind-type-alias">ModifierOverride</a><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><p>Override array of <a href="../types/modifier_modifier_type.ModifierOverride.html" class="tsd-kind-type-alias"><code>ModifierOverride</code></a>s used to provide modifiers to enemies.</p>
<p>Note that any previous modifiers are cleared.</p>
2024-09-27 22:52:07 +01:00
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">OPP_<wbr/>MOVESET_<wbr/>OVERRIDE</span><span class="tsd-signature-symbol">: </span><a href="../enums/enums_moves.Moves.html" class="tsd-signature-type tsd-kind-enum">Moves</a><span class="tsd-signature-symbol"> | </span><a href="../enums/enums_moves.Moves.html" class="tsd-signature-type tsd-kind-enum">Moves</a><span class="tsd-signature-symbol">[]</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">OPP_<wbr/>PASSIVE_<wbr/>ABILITY_<wbr/>OVERRIDE</span><span class="tsd-signature-symbol">: </span><a href="../enums/enums_abilities.Abilities.html" class="tsd-signature-type tsd-kind-enum">Abilities</a></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">OPP_<wbr/>SHINY_<wbr/>OVERRIDE</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">OPP_<wbr/>SPECIES_<wbr/>OVERRIDE</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">OPP_<wbr/>STATUS_<wbr/>OVERRIDE</span><span class="tsd-signature-symbol">: </span><a href="../enums/enums_status_effect.StatusEffect.html" class="tsd-signature-type tsd-kind-enum">StatusEffect</a></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">OPP_<wbr/>VARIANT_<wbr/>OVERRIDE</span><span class="tsd-signature-symbol">: </span><a href="../types/data_variant.Variant.html" class="tsd-signature-type tsd-kind-type-alias">Variant</a></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">PASSIVE_<wbr/>ABILITY_<wbr/>OVERRIDE</span><span class="tsd-signature-symbol">: </span><a href="../enums/enums_abilities.Abilities.html" class="tsd-signature-type tsd-kind-enum">Abilities</a></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">POKEBALL_<wbr/>OVERRIDE</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">active</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">pokeballs</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/battle_scene.PokeballCounts.html" class="tsd-signature-type tsd-kind-interface">PokeballCounts</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">active</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">pokeballs</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/battle_scene.PokeballCounts.html" class="tsd-signature-type tsd-kind-interface">PokeballCounts</a></h5></li></ul></li><li class="tsd-parameter"><h5><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">SEED_<wbr/>OVERRIDE</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>a specific seed (default: a random string of 24 characters)</p>
2024-07-28 00:48:18 +01:00
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">SHINY_<wbr/>OVERRIDE</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">STARTER_<wbr/>FORM_<wbr/>OVERRIDES</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><a href="../enums/enums_species.Species.html" class="tsd-signature-type tsd-kind-enum">Species</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h5><div class="tsd-comment tsd-typography"><p>Set the form index of any starter in the party whose <code>speciesId</code> is inside this override</p>
2024-09-27 22:52:07 +01:00
</div><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="See" class="tsd-anchor"></a>See<a href="#See" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>allSpecies in <code>src/data/pokemon-species.ts</code> for form indexes</p>
2024-07-28 00:48:18 +01:00
<h4 class="tsd-anchor-link"><a id="Example" class="tsd-anchor"></a>Example<a href="#Example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">STARTER_FORM_OVERRIDES</span><span class="hl-1"> = {</span><br/><span class="hl-1"> </span><span class="hl-2">[Species.</span><span class="hl-5">DARMANITAN</span><span class="hl-2">]:</span><span class="hl-1"> </span><span class="hl-0">1</span><br/><span class="hl-1">}</span>
</code><button>Copy</button></pre>
</div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">STARTER_<wbr/>SPECIES_<wbr/>OVERRIDE</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><p>SPECIES OVERRIDE
will only apply to the first starter in your party or each enemy pokemon
default is 0 to not override</p>
</div><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-1" class="tsd-anchor"></a>Example<a href="#Example-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-5">SPECIES_OVERRIDE</span><span class="hl-1"> = </span><span class="hl-2">Species</span><span class="hl-1">.</span><span class="hl-2">Bulbasaur</span><span class="hl-1">;</span>
</code><button type="button">Copy</button></pre>
2024-08-17 18:01:18 +01:00
</div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">STARTING_<wbr/>BIOME_<wbr/>OVERRIDE</span><span class="tsd-signature-symbol">: </span><a href="../enums/enums_biome.Biome.html" class="tsd-signature-type tsd-kind-enum">Biome</a></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">STARTING_<wbr/>HELD_<wbr/>ITEMS_<wbr/>OVERRIDE</span><span class="tsd-signature-symbol">: </span><a href="../types/modifier_modifier_type.ModifierOverride.html" class="tsd-signature-type tsd-kind-type-alias">ModifierOverride</a><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><p>Override array of <a href="../types/modifier_modifier_type.ModifierOverride.html" class="tsd-kind-type-alias"><code>ModifierOverride</code></a>s used to provide held items to first party member when starting a new game.</p>
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">STARTING_<wbr/>LEVEL_<wbr/>OVERRIDE</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><p>default 5 or 20 for Daily</p>
2024-07-28 00:48:18 +01:00
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">STARTING_<wbr/>MODIFIER_<wbr/>OVERRIDE</span><span class="tsd-signature-symbol">: </span><a href="../types/modifier_modifier_type.ModifierOverride.html" class="tsd-signature-type tsd-kind-type-alias">ModifierOverride</a><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><p>Overrides labeled <code>MODIFIER</code> deal with any modifier so long as it doesn't require a party
member to hold it (typically this is, extends, or generates a ModifierType),
like <code>EXP_SHARE</code>, <code>CANDY_JAR</code>, etc.</p>
<p>Overrides labeled <code>HELD_ITEM</code> specifically pertain to any entry in modifierTypes that
extends, or generates a PokemonHeldItemModifierType, like <code>SOUL_DEW</code>, <code>TOXIC_ORB</code>, etc.</p>
<p>Note that, if count is not provided, it will default to 1.</p>
<p>Additionally, note that some held items and modifiers are grouped together via
a ModifierTypeGenerator and require pre-generation arguments to get
a specific item from that group. If a type is not set, the generator will either
use the party to weight item choice or randomly pick an item.</p>
</div><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example-2" class="tsd-anchor"></a>Example<a href="#Example-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code><span class="hl-8">// Will have a quantity of 2 in-game</span><br/><span class="hl-5">STARTING_MODIFIER_OVERRIDE</span><span class="hl-1"> = [{</span><span class="hl-2">name:</span><span class="hl-1"> </span><span class="hl-7">&quot;EXP_SHARE&quot;</span><span class="hl-1">, </span><span class="hl-2">count:</span><span class="hl-1"> </span><span class="hl-0">2</span><span class="hl-1">}]</span><br/><span class="hl-8">// Will have a quantity of 1 in-game</span><br/><span class="hl-5">STARTING_HELD_ITEM_OVERRIDE</span><span class="hl-1"> = [{</span><span class="hl-2">name:</span><span class="hl-1"> </span><span class="hl-7">&quot;LUCKY_EGG&quot;</span><span class="hl-1">}]</span><br/><span class="hl-8">// Type must be given to get a specific berry</span><br/><span class="hl-5">STARTING_HELD_ITEM_OVERRIDE</span><span class="hl-1"> = [{</span><span class="hl-2">name:</span><span class="hl-1"> </span><span class="hl-7">&quot;BERRY&quot;</span><span class="hl-1">, </span><span class="hl-2">type:</span><span class="hl-1"> </span><span class="hl-2">BerryType</span><span class="hl-1">.</span><span class="hl-5">SITRUS</span><span class="hl-1">}]</span><br/><span class="hl-8">// A random berry will be generated at runtime</span><br/><span class="hl-5">STARTING_HELD_ITEM_OVERRIDE</span><span class="hl-1"> = [{</span><span class="hl-2">name:</span><span class="hl-1"> </span><span class="hl-7">&quot;BERRY&quot;</span><span class="hl-1">}]</span>
</code><button>Copy</button></pre>
</div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">STARTING_<wbr/>MONEY_<wbr/>OVERRIDE</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><p>default 1000</p>
2024-08-17 18:01:18 +01:00
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">STARTING_<wbr/>WAVE_<wbr/>OVERRIDE</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">STATUS_<wbr/>OVERRIDE</span><span class="tsd-signature-symbol">: </span><a href="../enums/enums_status_effect.StatusEffect.html" class="tsd-signature-type tsd-kind-enum">StatusEffect</a></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">VARIANT_<wbr/>OVERRIDE</span><span class="tsd-signature-symbol">: </span><a href="../types/data_variant.Variant.html" class="tsd-signature-type tsd-kind-type-alias">Variant</a></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">WAIVE_<wbr/>ROLL_<wbr/>FEE_<wbr/>OVERRIDE</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>Sets reroll price to 0</p>
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">WAIVE_<wbr/>SHOP_<wbr/>FEES_<wbr/>OVERRIDE</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>Sets all shop item prices to 0</p>
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">WEATHER_<wbr/>OVERRIDE</span><span class="tsd-signature-symbol">: </span><a href="../enums/enums_weather_type.WeatherType.html" class="tsd-signature-type tsd-kind-enum">WeatherType</a></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">XP_<wbr/>MULTIPLIER_<wbr/>OVERRIDE</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><p>Multiplies XP gained by this value including 0. Set to null to ignore the override</p>
2024-09-29 04:01:52 +01:00
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/3e8b3930a8911e849d6e0153b9f6112214aee690/src/overrides.ts#L209">src/overrides.ts:209</a></li></ul></aside></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></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>pokemon-rogue-battle</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>