pokerogue/main/variables/overrides.default.html

34 lines
62 KiB
HTML
Raw Normal View History

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>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><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">&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">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 class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">EGG_IMMEDIATE_HATCH_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_SHINY_OVERRIDE</span><span class="tsd-signature-symbol">: </span><span class="t
Items listed will replace the normal rolls.
If less items are listed than rolled, only some items will be replaced
If more items are listed than rolled, only the first X items will be shown, where X is the number of items rolled.</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></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/>GENDER_<wbr/>OVERRIDE</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/>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></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></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></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</s
</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>
</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><a href="data_pokemon_species.allSpecies.html" class="tsd-kind-variable">allSpecies</a> in <code>src/data/pokemon-species.ts</code> for form indexes</p>
<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>
</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></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>
</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>
</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">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">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-07-28 05:24:03 +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/09e719204677134ab2880e642271fa13825a4a17/src/overrides.ts#L172">src/overrides.ts:172</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>