PokéRogue
    Preparing search index...

    Interface NewBattleInitialProps

    Interface representing the type of a new battle config as it is constructed.

    interface NewBattleInitialProps {
        battleType?: WILD | TRAINER | MYSTERY_ENCOUNTER;
        double?: boolean;
        mysteryEncounterType?: MysteryEncounterType;
        trainer?: Trainer;
        trainerData?: TrainerData;
        waveIndex: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    battleType? double? mysteryEncounterType? trainer? trainerData? waveIndex

    Properties

    battleType?: WILD | TRAINER | MYSTERY_ENCOUNTER

    The type of battle to create.

    double?: boolean

    Whether the battle is a double battle.

    ⚠️ Mystery Encounters will ignore this property and set it to false.

    mysteryEncounterType?: MysteryEncounterType

    The type of Mystery Encounter to spawn. Only present in data initialized from a saved session, and will be undefined for non-ME battles.

    trainer?: Trainer

    The Trainer to spawn. Only present in processed data and will be undefined for non-trainer battles.

    trainerData?: TrainerData

    Saved data used to initialize the trainer. Only present in data initialized from a saved session, and will be undefined for non-trainer battles.

    waveIndex: number

    The wave number of the NEW wave to spawn. Will always be >=1 (barring save data corruption).

    Settings

    Member Visibility

    On This Page

    Properties