# default | pokemon-rogue-battle
Documentation for pokemon-rogue-battle

# Variable default

default: {
ABILITY_OVERRIDE: Abilities ;
ACHIEVEMENTS_REUNLOCK_OVERRIDE: boolean;
ARENA_TINT_OVERRIDE: null | TimeOfDay ;
BATTLE_TYPE_OVERRIDE: null | BattleStyle ;
BYPASS_TUTORIAL_SKIP_OVERRIDE: boolean;
DAILY_RUN_SEED_OVERRIDE: null | string;
DISABLE_STANDARD_TRAINERS_OVERRIDE: boolean;
EGG_FREE_GACHA_PULLS_OVERRIDE: boolean;
EGG_GACHA_PULL_COUNT_OVERRIDE: number;
EGG_IMMEDIATE_HATCH_OVERRIDE: boolean;
EGG_SHINY_OVERRIDE: boolean;
EGG_TIER_OVERRIDE: null | EggTier ;
EGG_VARIANT_OVERRIDE: null | VariantTier ;
FREE_CANDY_UPGRADE_OVERRIDE: boolean;
GENDER_OVERRIDE: null | Gender ;
HAS_PASSIVE_ABILITY_OVERRIDE: null | boolean;
ITEM_REWARD_OVERRIDE: ModifierOverride [];
ITEM_UNLOCK_OVERRIDE: Unlockables [];
LEVEL_CAP_OVERRIDE: number;
MOVESET_OVERRIDE: Moves | Moves [];
MYSTERY_ENCOUNTER_OVERRIDE: null | MysteryEncounterType ;
MYSTERY_ENCOUNTER_RATE_OVERRIDE: null | number;
MYSTERY_ENCOUNTER_TIER_OVERRIDE: null | MysteryEncounterTier ;
NEVER_CRIT_OVERRIDE: boolean;
OPP_ABILITY_OVERRIDE: Abilities ;
OPP_FORM_OVERRIDES: Partial<Record< Species , number>>;
OPP_FUSION_OVERRIDE: boolean;
OPP_FUSION_SPECIES_OVERRIDE: number;
OPP_GENDER_OVERRIDE: null | Gender ;
OPP_HAS_PASSIVE_ABILITY_OVERRIDE: null | boolean;
OPP_HEALTH_SEGMENTS_OVERRIDE: number;
OPP_HELD_ITEMS_OVERRIDE: ModifierOverride [];
OPP_IVS_OVERRIDE: number | number[];
OPP_LEVEL_OVERRIDE: number;
OPP_MODIFIER_OVERRIDE: ModifierOverride [];
OPP_MOVESET_OVERRIDE: Moves | Moves [];
OPP_PASSIVE_ABILITY_OVERRIDE: Abilities ;
OPP_SHINY_OVERRIDE: null | boolean;
OPP_SPECIES_OVERRIDE: number;
OPP_STATUS_OVERRIDE: StatusEffect ;
OPP_VARIANT_OVERRIDE: null | Variant ;
PASSIVE_ABILITY_OVERRIDE: Abilities ;
POKEBALL_OVERRIDE: { active: boolean; pokeballs: PokeballCounts };
SEED_OVERRIDE: string;
SHINY_OVERRIDE: null | boolean;
STARTER_FORM_OVERRIDES: Partial<Record< Species , number>>;
STARTER_FUSION_OVERRIDE: boolean;
STARTER_FUSION_SPECIES_OVERRIDE: number;
STARTER_SPECIES_OVERRIDE: number;
STARTING_BIOME_OVERRIDE: Biome ;
STARTING_HELD_ITEMS_OVERRIDE: ModifierOverride [];
STARTING_LEVEL_OVERRIDE: number;
STARTING_MODIFIER_OVERRIDE: ModifierOverride [];
STARTING_MONEY_OVERRIDE: number;
STARTING_WAVE_OVERRIDE: number;
STATUS_ACTIVATION_OVERRIDE: null | boolean;
STATUS_OVERRIDE: StatusEffect ;
UNLIMITED_EGG_COUNT_OVERRIDE: boolean;
VARIANT_OVERRIDE: null | Variant ;
WAIVE_ROLL_FEE_OVERRIDE: boolean;
WAIVE_SHOP_FEES_OVERRIDE: boolean;
WEATHER_OVERRIDE: WeatherType ;
XP_MULTIPLIER_OVERRIDE: null | number;
}

#### Type declaration

- ##### `Readonly` ABILITY_OVERRIDE: Abilities

- ##### `Readonly` ACHIEVEMENTS_REUNLOCK_OVERRIDE: boolean

  Set to `true` to be able to re-earn already unlocked achievements

- ##### `Readonly` ARENA_TINT_OVERRIDE: null | TimeOfDay

- ##### `Readonly` BATTLE_TYPE_OVERRIDE: null | BattleStyle

  If `null`, ignore this override.

  If `"single"`, set every non-trainer battle to be a single battle.

  If `"double"`, set every battle (including trainer battles) to be a double battle.

  If `"even-doubles"`, follow the `"double"` rule on even wave numbers, and follow the `"single"` rule on odd wave numbers.

  If `"odd-doubles"`, follow the `"double"` rule on odd wave numbers, and follow the `"single"` rule on even wave numbers.

- ##### `Readonly` BYPASS_TUTORIAL_SKIP_OVERRIDE: boolean

  Set to `true` to show all tutorials

- ##### `Readonly` DAILY_RUN_SEED_OVERRIDE: null | string

- ##### `Readonly` DISABLE_STANDARD_TRAINERS_OVERRIDE: boolean

  If `true`, disable all non-scripted opponent trainer encounters.

- ##### `Readonly` EGG_FREE_GACHA_PULLS_OVERRIDE: boolean

- ##### `Readonly` EGG_GACHA_PULL_COUNT_OVERRIDE: number

- ##### `Readonly` EGG_IMMEDIATE_HATCH_OVERRIDE: boolean

- ##### `Readonly` EGG_SHINY_OVERRIDE: boolean

- ##### `Readonly` EGG_TIER_OVERRIDE: null | EggTier

- ##### `Readonly` EGG_VARIANT_OVERRIDE: null | VariantTier

- ##### `Readonly` FREE_CANDY_UPGRADE_OVERRIDE: boolean

- ##### `Readonly` GENDER_OVERRIDE: null | Gender

- ##### `Readonly` HAS_PASSIVE_ABILITY_OVERRIDE: null | boolean

- ##### `Readonly` ITEM_REWARD_OVERRIDE: ModifierOverride []

  Override array of `ModifierOverride`s used to replace the generated item rolls after a wave.

  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.

  Note that, for all items in the array, `count` is not used.

- ##### `Readonly` ITEM_UNLOCK_OVERRIDE: Unlockables []

  Forces an item to be UNLOCKED

- ##### `Readonly` LEVEL_CAP_OVERRIDE: number

  Sets the level cap to this number during experience gain calculations. Set to `0` to disable override & use normal wave-based level caps, or any negative number to set it to 9 quadrillion (effectively disabling it).

- ##### `Readonly` MOVESET_OVERRIDE: Moves | Moves []

- ##### `Readonly` MYSTERY_ENCOUNTER_OVERRIDE: null | MysteryEncounterType

- ##### `Readonly` MYSTERY_ENCOUNTER_RATE_OVERRIDE: null | number

  `1` (almost never) to `256` (always), set to `null` to disable the override

  Note: Make sure `STARTING_WAVE_OVERRIDE > 10`, otherwise MEs won't trigger

- ##### `Readonly` MYSTERY_ENCOUNTER_TIER_OVERRIDE: null | MysteryEncounterTier

- ##### `Readonly` NEVER_CRIT_OVERRIDE: boolean

- ##### `Readonly` OPP_ABILITY_OVERRIDE: Abilities

- ##### `Readonly` OPP_FORM_OVERRIDES: Partial<Record< Species , number>>

- ##### `Readonly` OPP_FUSION_OVERRIDE: boolean

  This will make all opponents fused Pokemon

- ##### `Readonly` OPP_FUSION_SPECIES_OVERRIDE: number

  This will override the species of the fusion only when the opponent is already a fusion

- ##### `Readonly` OPP_GENDER_OVERRIDE: null | Gender

- ##### `Readonly` OPP_HAS_PASSIVE_ABILITY_OVERRIDE: null | boolean

- ##### `Readonly` OPP_HEALTH_SEGMENTS_OVERRIDE: number

  Override to give the enemy Pokemon a given amount of health segments

  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

- ##### `Readonly` OPP_HELD_ITEMS_OVERRIDE: ModifierOverride []

  Override array of `ModifierOverride`s used to provide held items to enemies on spawn.

- ##### `Readonly` OPP_IVS_OVERRIDE: number | number[]

- ##### `Readonly` OPP_LEVEL_OVERRIDE: number

- ##### `Readonly` OPP_MODIFIER_OVERRIDE: ModifierOverride []

  Override array of `ModifierOverride`s used to provide modifiers to enemies.

  Note that any previous modifiers are cleared.

- ##### `Readonly` OPP_MOVESET_OVERRIDE: Moves | Moves []

- ##### `Readonly` OPP_PASSIVE_ABILITY_OVERRIDE: Abilities

- ##### `Readonly` OPP_SHINY_OVERRIDE: null | boolean

- ##### `Readonly` OPP_SPECIES_OVERRIDE: number

- ##### `Readonly` OPP_STATUS_OVERRIDE: StatusEffect

- ##### `Readonly` OPP_VARIANT_OVERRIDE: null | Variant

- ##### `Readonly` PASSIVE_ABILITY_OVERRIDE: Abilities

- ##### `Readonly` POKEBALL_OVERRIDE: { active: boolean; pokeballs: PokeballCounts }

- ##### `Readonly` SEED_OVERRIDE: string

  a specific seed (default: a random string of 24 characters)

- ##### `Readonly` SHINY_OVERRIDE: null | boolean

- ##### `Readonly` STARTER_FORM_OVERRIDES: Partial<Record< Species , number>>

  Set the form index of any starter in the party whose `speciesId` is inside this override

  #### See

  allSpecies in `src/data/pokemon-species.ts` for form indexes

  #### Example

      const STARTER_FORM_OVERRIDES = {
        [Species.DARMANITAN]: 1
      }

- ##### `Readonly` STARTER_FUSION_OVERRIDE: boolean

  This will force your starter to be a random fusion

- ##### `Readonly` STARTER_FUSION_SPECIES_OVERRIDE: number

  This will override the species of the fusion

- ##### `Readonly` STARTER_SPECIES_OVERRIDE: number

  SPECIES OVERRIDE will only apply to the first starter in your party or each enemy pokemon default is 0 to not override

  #### Example

      SPECIES_OVERRIDE = Species.Bulbasaur;

- ##### `Readonly` STARTING_BIOME_OVERRIDE: Biome

- ##### `Readonly` STARTING_HELD_ITEMS_OVERRIDE: ModifierOverride []

  Override array of `ModifierOverride`s used to provide held items to first party member when starting a new game.

- ##### `Readonly` STARTING_LEVEL_OVERRIDE: number

  default 5 or 20 for Daily

- ##### `Readonly` STARTING_MODIFIER_OVERRIDE: ModifierOverride []

  Overrides labeled `MODIFIER` 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 `EXP_SHARE`, `CANDY_JAR`, etc.

  Overrides labeled `HELD_ITEM` specifically pertain to any entry in modifierTypes that extends, or generates a PokemonHeldItemModifierType, like `SOUL_DEW`, `TOXIC_ORB`, etc.

  Note that, if count is not provided, it will default to 1.

  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.

  #### Example

      // Will have a quantity of 2 in-game
      STARTING_MODIFIER_OVERRIDE = [{name: "EXP_SHARE", count: 2}]
      // Will have a quantity of 1 in-game
      STARTING_HELD_ITEM_OVERRIDE = [{name: "LUCKY_EGG"}]
      // Type must be given to get a specific berry
      STARTING_HELD_ITEM_OVERRIDE = [{name: "BERRY", type: BerryType.SITRUS}]
      // A random berry will be generated at runtime
      STARTING_HELD_ITEM_OVERRIDE = [{name: "BERRY"}]

- ##### `Readonly` STARTING_MONEY_OVERRIDE: number

  default 1000

- ##### `Readonly` STARTING_WAVE_OVERRIDE: number

- ##### `Readonly` STATUS_ACTIVATION_OVERRIDE: null | boolean

  Set to `true` to force Paralysis and Freeze to always activate, or `false` to force them to not activate

- ##### `Readonly` STATUS_OVERRIDE: StatusEffect

- ##### `Readonly` UNLIMITED_EGG_COUNT_OVERRIDE: boolean

- ##### `Readonly` VARIANT_OVERRIDE: null | Variant

- ##### `Readonly` WAIVE_ROLL_FEE_OVERRIDE: boolean

  Sets reroll price to 0

- ##### `Readonly` WAIVE_SHOP_FEES_OVERRIDE: boolean

  Sets all shop item prices to 0

- ##### `Readonly` WEATHER_OVERRIDE: WeatherType

- ##### `Readonly` XP_MULTIPLIER_OVERRIDE: null | number

  Multiplies XP gained by this value including 0. Set to null to ignore the override.

- Defined in src/overrides.ts:266