PokéRogue
    Preparing search index...
    Index

    Constructors

    Properties

    cachedReplacementMap:
        | Map<number, { formIndex: number; speciesId: SpeciesId }>
        | null = null
    disabled: boolean

    Whether the timed event manager is disabled. Used to disable events in testing.

    Methods

    • Assign each species/form pair a random other species/form pair for sprite replacement.

      Returns void

    • For events where Delibirdy gives extra items

      Returns string[]

      list of ids of ModifierTypes that Delibirdy hands out as a bonus

    • Returns readonly (
          | "POKEBALL"
          | "GREAT_BALL"
          | "ULTRA_BALL"
          | "ROGUE_BALL"
          | "MASTER_BALL"
          | "RARE_CANDY"
          | "RARER_CANDY"
          | "EVOLUTION_ITEM"
          | "RARE_EVOLUTION_ITEM"
          | "FORM_CHANGE_ITEM"
          | "RARE_FORM_CHANGE_ITEM"
          | "EVOLUTION_TRACKER_GIMMIGHOUL"
          | "MEGA_BRACELET"
          | "DYNAMAX_BAND"
          | "TERA_ORB"
          | "MAP"
          | "POTION"
          | "SUPER_POTION"
          | "HYPER_POTION"
          | "MAX_POTION"
          | "FULL_RESTORE"
          | "REVIVE"
          | "MAX_REVIVE"
          | "FULL_HEAL"
          | "SACRED_ASH"
          | "REVIVER_SEED"
          | "WHITE_HERB"
          | "ETHER"
          | "MAX_ETHER"
          | "ELIXIR"
          | "MAX_ELIXIR"
          | "PP_UP"
          | "PP_MAX"
          | "LURE"
          | "SUPER_LURE"
          | "MAX_LURE"
          | "SPECIES_STAT_BOOSTER"
          | "RARE_SPECIES_STAT_BOOSTER"
          | "TEMP_STAT_STAGE_BOOSTER"
          | "DIRE_HIT"
          | "BASE_STAT_BOOSTER"
          | "ATTACK_TYPE_BOOSTER"
          | "MINT"
          | "MYSTICAL_ROCK"
          | "TERA_SHARD"
          | "BERRY"
          | "TM_COMMON"
          | "TM_GREAT"
          | "TM_ULTRA"
          | "MEMORY_MUSHROOM"
          | "EXP_SHARE"
          | "EXP_BALANCE"
          | "OVAL_CHARM"
          | "EXP_CHARM"
          | "SUPER_EXP_CHARM"
          | "GOLDEN_EXP_CHARM"
          | "LUCKY_EGG"
          | "GOLDEN_EGG"
          | "SOOTHE_BELL"
          | "SCOPE_LENS"
          | "LEEK"
          | "EVIOLITE"
          | "SOUL_DEW"
          | "NUGGET"
          | "BIG_NUGGET"
          | "RELIC_GOLD"
          | "AMULET_COIN"
          | "GOLDEN_PUNCH"
          | "COIN_CASE"
          | "LOCK_CAPSULE"
          | "GRIP_CLAW"
          | "WIDE_LENS"
          | "MULTI_LENS"
          | "HEALING_CHARM"
          | "CANDY_JAR"
          | "BERRY_POUCH"
          | "FOCUS_BAND"
          | "QUICK_CLAW"
          | "KINGS_ROCK"
          | "LEFTOVERS"
          | "SHELL_BELL"
          | "TOXIC_ORB"
          | "FLAME_ORB"
          | "BATON"
          | "SHINY_CHARM"
          | "ABILITY_CHARM"
          | "CATCHING_CHARM"
          | "IV_SCANNER"
          | "DNA_SPLICERS"
          | "MINI_BLACK_HOLE"
          | "VOUCHER"
          | "VOUCHER_PLUS"
          | "VOUCHER_PREMIUM"
          | "GOLDEN_POKEBALL"
          | "SILVER_POKEBALL"
          | "ENEMY_DAMAGE_BOOSTER"
          | "ENEMY_DAMAGE_REDUCTION"
          | "ENEMY_HEAL"
          | "ENEMY_ATTACK_POISON_CHANCE"
          | "ENEMY_ATTACK_PARALYZE_CHANCE"
          | "ENEMY_ATTACK_BURN_CHANCE"
          | "ENEMY_STATUS_EFFECT_HEAL_CHANCE"
          | "ENEMY_ENDURE_CHANCE"
          | "ENEMY_FUSED_CHANCE"
          | "MYSTERY_ENCOUNTER_SHUCKLE_JUICE"
          | "MYSTERY_ENCOUNTER_OLD_GATEAU"
          | "MYSTERY_ENCOUNTER_BLACK_SLUDGE"
          | "MYSTERY_ENCOUNTER_MACHO_BRACE"
          | "MYSTERY_ENCOUNTER_GOLDEN_BUG_NET"
      )[]

    • Get the event sprite replacement for a given species and form, if it exists. If the active event has fillRandom enabled,
      will return a random replacement for any species/form pair that isn't explicitly listed in the pokemonReplacements array.

      Parameters

      • species: SpeciesId

        The species ID of the pokemon to check for a sprite replacement

      • formIndex: number = 0

        The form index of the pokemon to check for a sprite replacement. Defaults to 0

      Returns { formIndex: number; speciesId: SpeciesId } | null

      An object containing the species ID and form index of the replacement sprite, or null if no replacement exists.

    • Return the key replacement for the given i18n key if it exists in the active event, otherwise return the original key.

      Parameters

      • key: string

        The i18n key to check for a replacement

      Returns string

      The replacement key if it exists, otherwise the original key

    • Get the event trainer sprite replacement for a given trainer type, if it exists.

      Parameters

      • trainerType: TrainerType

        The trainer type to check for a sprite replacement

      Returns string | null

      The trainer type of the replacement sprite, or null if no replacement exists.

    • Gets all the modifier types associated with a certain wave during an event

      Parameters

      • wave: number

        the wave to check for associated rewards

      Returns (
          | "POKEBALL"
          | "GREAT_BALL"
          | "ULTRA_BALL"
          | "ROGUE_BALL"
          | "MASTER_BALL"
          | "RARE_CANDY"
          | "RARER_CANDY"
          | "EVOLUTION_ITEM"
          | "RARE_EVOLUTION_ITEM"
          | "FORM_CHANGE_ITEM"
          | "RARE_FORM_CHANGE_ITEM"
          | "EVOLUTION_TRACKER_GIMMIGHOUL"
          | "MEGA_BRACELET"
          | "DYNAMAX_BAND"
          | "TERA_ORB"
          | "MAP"
          | "POTION"
          | "SUPER_POTION"
          | "HYPER_POTION"
          | "MAX_POTION"
          | "FULL_RESTORE"
          | "REVIVE"
          | "MAX_REVIVE"
          | "FULL_HEAL"
          | "SACRED_ASH"
          | "REVIVER_SEED"
          | "WHITE_HERB"
          | "ETHER"
          | "MAX_ETHER"
          | "ELIXIR"
          | "MAX_ELIXIR"
          | "PP_UP"
          | "PP_MAX"
          | "LURE"
          | "SUPER_LURE"
          | "MAX_LURE"
          | "SPECIES_STAT_BOOSTER"
          | "RARE_SPECIES_STAT_BOOSTER"
          | "TEMP_STAT_STAGE_BOOSTER"
          | "DIRE_HIT"
          | "BASE_STAT_BOOSTER"
          | "ATTACK_TYPE_BOOSTER"
          | "MINT"
          | "MYSTICAL_ROCK"
          | "TERA_SHARD"
          | "BERRY"
          | "TM_COMMON"
          | "TM_GREAT"
          | "TM_ULTRA"
          | "MEMORY_MUSHROOM"
          | "EXP_SHARE"
          | "EXP_BALANCE"
          | "OVAL_CHARM"
          | "EXP_CHARM"
          | "SUPER_EXP_CHARM"
          | "GOLDEN_EXP_CHARM"
          | "LUCKY_EGG"
          | "GOLDEN_EGG"
          | "SOOTHE_BELL"
          | "SCOPE_LENS"
          | "LEEK"
          | "EVIOLITE"
          | "SOUL_DEW"
          | "NUGGET"
          | "BIG_NUGGET"
          | "RELIC_GOLD"
          | "AMULET_COIN"
          | "GOLDEN_PUNCH"
          | "COIN_CASE"
          | "LOCK_CAPSULE"
          | "GRIP_CLAW"
          | "WIDE_LENS"
          | "MULTI_LENS"
          | "HEALING_CHARM"
          | "CANDY_JAR"
          | "BERRY_POUCH"
          | "FOCUS_BAND"
          | "QUICK_CLAW"
          | "KINGS_ROCK"
          | "LEFTOVERS"
          | "SHELL_BELL"
          | "TOXIC_ORB"
          | "FLAME_ORB"
          | "BATON"
          | "SHINY_CHARM"
          | "ABILITY_CHARM"
          | "CATCHING_CHARM"
          | "IV_SCANNER"
          | "DNA_SPLICERS"
          | "MINI_BLACK_HOLE"
          | "VOUCHER"
          | "VOUCHER_PLUS"
          | "VOUCHER_PREMIUM"
          | "GOLDEN_POKEBALL"
          | "SILVER_POKEBALL"
          | "ENEMY_DAMAGE_BOOSTER"
          | "ENEMY_DAMAGE_REDUCTION"
          | "ENEMY_HEAL"
          | "ENEMY_ATTACK_POISON_CHANCE"
          | "ENEMY_ATTACK_PARALYZE_CHANCE"
          | "ENEMY_ATTACK_BURN_CHANCE"
          | "ENEMY_STATUS_EFFECT_HEAL_CHANCE"
          | "ENEMY_ENDURE_CHANCE"
          | "ENEMY_FUSED_CHANCE"
          | "MYSTERY_ENCOUNTER_SHUCKLE_JUICE"
          | "MYSTERY_ENCOUNTER_OLD_GATEAU"
          | "MYSTERY_ENCOUNTER_BLACK_SLUDGE"
          | "MYSTERY_ENCOUNTER_MACHO_BRACE"
          | "MYSTERY_ENCOUNTER_GOLDEN_BUG_NET"
      )[]

      array of strings of the event modifier reward types

      EventWaveReward

    • For events where defeated bosses (Gym Leaders, E4 etc) give out Voucher Plus even if they were defeated before

      Returns boolean

      Whether vouchers should be upgraded

    • Check if the current active event has any text replacements.
      This is used to determine whether the i18next proxy should be loaded.

      Returns boolean

      Whether the active event has text replacements

    • Check whether the current TimedEvent is active and for April Fools.

      Returns boolean

      Whether the April Fools event is currently active.