PokéRogue
    Preparing search index...

    Interface RandomEncounterParams

    interface RandomEncounterParams {
        eventChance?: number;
        eventHiddenRerolls?: number;
        eventShinyRerolls?: number;
        hiddenAbilityChance?: number;
        hiddenRerolls?: number;
        includeLegendary?: boolean;
        includeMythical?: boolean;
        includeSubLegendary?: boolean;
        isBoss?: boolean;
        isEventEncounter?: BooleanHolder;
        level: number;
        maxShinyChance?: number;
        shinyChance?: number;
        shinyRerolls?: number;
        speciesFilter?: PokemonSpeciesFilter;
        speciesFunction?: () => PokemonSpecies;
    }
    Index

    Properties

    eventChance?: number

    The chance out of 100 to pick an event encounter

    50

    eventHiddenRerolls?: number

    Number of extra HA rerolls for event mons

    0

    eventShinyRerolls?: number

    Number of extra shiny rerolls for event mons

    0

    hiddenAbilityChance?: number

    The overridden HA chance, defaults to base

    hiddenRerolls?: number

    Number of rerolls for Hidden Ability (HA) that should be attempted

    0

    includeLegendary?: boolean

    Whether Legendaries can be encountered

    true

    includeMythical?: boolean

    Whether Mythicals can be encountered

    true

    includeSubLegendary?: boolean

    Whether Sub-legendaries can be encountered, mainly for event encounters

    true

    isBoss?: boolean

    Whether the Pokemon should be a Boss.

    false

    isEventEncounter?: BooleanHolder

    An optional BooleanHolder used to let the caller know if it pulled from an event.

    level: number

    The level of the mon

    maxShinyChance?: number

    The max shiny threshold after modifiers are applied. Values below 1 mean no maximum

    0 (no maximum)

    shinyChance?: number

    The overridden shiny chance, defaults to base

    shinyRerolls?: number

    Number of rerolls for shininess/variants that should be attempted

    0

    speciesFilter?: PokemonSpeciesFilter

    An optional filter for eligible mons, applied to the event encounter pool. If omitted, no filter will be applied.

    speciesFunction?: () => PokemonSpecies

    A custom function used to return the PokemonSpecies to generate