PokéRogue
    Preparing search index...

    Interface IEggOptions

    Egg options to override egg properties

    interface IEggOptions {
        eggDescriptor?: string;
        eggMoveIndex?: number;
        hatchWaves?: number;
        id?: number;
        isShiny?: boolean;
        overrideHiddenAbility?: boolean;
        pulled?: boolean;
        scene?: BattleScene;
        sourceType?: EggSourceType;
        species?: SpeciesId;
        tier?: EggTier;
        timestamp?: number;
        variantTier?: VariantTier;
    }
    Index

    Properties

    eggDescriptor? eggMoveIndex? hatchWaves? id? isShiny? overrideHiddenAbility? pulled? scene? sourceType? species? tier? timestamp? variantTier?

    Properties

    eggDescriptor?: string

    Can customize the message displayed for where the egg was obtained

    eggMoveIndex?: number

    Defines which egg move will be unlocked. 3 = rare egg move.

    hatchWaves?: number

    Sets how many waves it will take till this egg hatches.

    id?: number

    ID. Used to check if egg type will be manaphy (id % 204 === 0)

    isShiny?: boolean

    Defines if the hatched pokemon will be a shiny.

    overrideHiddenAbility?: boolean

    Defines if the egg will hatch with the hidden ability of this species. If no hidden ability exist, a random one will get choosen.

    pulled?: boolean

    Defines if the egg got pulled from a gacha or not. If true, egg pity and pull statistics will be applied. Egg will be automaticly added to the game data.

    scene?: BattleScene

    Legacy field, kept for backwards-compatibility

    sourceType?: EggSourceType

    Defines where the egg comes from. Applies specific modifiers. Will also define the text displayed in the egg list.

    species?: SpeciesId

    Sets the exact species that will hatch from this egg.

    tier?: EggTier

    Sets the tier of the egg. Only species of this tier can be hatched from this egg. Tier will be overriden if species eggOption is set.

    timestamp?: number

    Timestamp when this egg got created

    variantTier?: VariantTier

    Defines the variant of the pokemon that will hatch from this egg. If no variantTier is given the normal variant rates will apply.

    Settings

    Member Visibility

    On This Page

    Properties