pokemon-rogue-battle
    Preparing search index...

    Class CommandPhase

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    fieldIndex phaseName

    Methods

    cancel end executeForAll getFieldIndex getPokemon handleCommand hideEnemyTrainer is showEnemyTrainer start

    Constructors

    Properties

    fieldIndex: number
    phaseName: "CommandPhase"

    The string name of the phase, used to identify the phase type for is

    Methods

    • Process the command phase logic based on the selected command

      Parameters

      • command: FIGHT | TERA

        The kind of command to handle

      • cursor: number

        The index of option that the cursor is on, or -1 if no option is selected

      • OptionaluseMode: MoveUseMode

        The mode to use for the move, if applicable. For switches, a boolean that specifies whether the switch is a Baton switch.

      • Optionalmove: TurnMove

        For Command.FIGHT, the move to use

      Returns boolean

      Whether the command was successful

    • Process the command phase logic based on the selected command

      Parameters

      • command: BALL

        The kind of command to handle

      • cursor: number

        The index of option that the cursor is on, or -1 if no option is selected

      Returns boolean

      Whether the command was successful

    • Process the command phase logic based on the selected command

      Parameters

      • command: POKEMON

        The kind of command to handle

      • cursor: number

        The index of option that the cursor is on, or -1 if no option is selected

      • useBaton: boolean

      Returns boolean

      Whether the command was successful

    • Process the command phase logic based on the selected command

      Parameters

      • command: RUN

        The kind of command to handle

      • cursor: number

        The index of option that the cursor is on, or -1 if no option is selected

      Returns boolean

      Whether the command was successful

    • Process the command phase logic based on the selected command

      Parameters

      • command: Command

        The kind of command to handle

      • cursor: number

        The index of option that the cursor is on, or -1 if no option is selected

      • OptionaluseMode: boolean | MoveUseMode

        The mode to use for the move, if applicable. For switches, a boolean that specifies whether the switch is a Baton switch.

      • Optionalmove: TurnMove

        For Command.FIGHT, the move to use

      Returns boolean

      Whether the command was successful

    • Check if the phase is of the given type without requiring instanceof.

      Type Parameters

      • K extends
            | "ActivatePriorityQueuePhase"
            | "AddEnemyBuffModifierPhase"
            | "AttemptCapturePhase"
            | "AttemptRunPhase"
            | "BattleEndPhase"
            | "BerryPhase"
            | "CheckInterludePhase"
            | "CheckStatusEffectPhase"
            | "CheckSwitchPhase"
            | "CommandPhase"
            | "CommonAnimPhase"
            | "DamageAnimPhase"
            | "EggHatchPhase"
            | "EggLapsePhase"
            | "EggSummaryPhase"
            | "EncounterPhase"
            | "EndCardPhase"
            | "EndEvolutionPhase"
            | "EnemyCommandPhase"
            | "EvolutionPhase"
            | "ExpPhase"
            | "FaintPhase"
            | "FormChangePhase"
            | "GameOverPhase"
            | "GameOverModifierRewardPhase"
            | "HideAbilityPhase"
            | "HidePartyExpBarPhase"
            | "LearnMovePhase"
            | "LevelCapPhase"
            | "LevelUpPhase"
            | "LoadMoveAnimPhase"
            | "LoginPhase"
            | "MessagePhase"
            | "ModifierRewardPhase"
            | "MoneyRewardPhase"
            | "MoveAnimPhase"
            | "MoveChargePhase"
            | "MoveEffectPhase"
            | "MoveEndPhase"
            | "MoveHeaderPhase"
            | "MovePhase"
            | "MysteryEncounterPhase"
            | "MysteryEncounterOptionSelectedPhase"
            | "MysteryEncounterBattlePhase"
            | "MysteryEncounterBattleStartCleanupPhase"
            | "MysteryEncounterRewardsPhase"
            | "PostMysteryEncounterPhase"
            | "NewBattlePhase"
            | "NewBiomeEncounterPhase"
            | "NextEncounterPhase"
            | "ObtainStatusEffectPhase"
            | "PartyExpPhase"
            | "PartyHealPhase"
            | "PokemonAnimPhase"
            | "PokemonHealPhase"
            | "PokemonTransformPhase"
            | "PositionalTagPhase"
            | "PostGameOverPhase"
            | "PostSummonPhase"
            | "PostTurnStatusEffectPhase"
            | "QuietFormChangePhase"
            | "ReloadSessionPhase"
            | "ResetStatusPhase"
            | "ReturnPhase"
            | "RevivalBlessingPhase"
            | "RibbonModifierRewardPhase"
            | "ScanIvsPhase"
            | "SelectBiomePhase"
            | "SelectChallengePhase"
            | "SelectGenderPhase"
            | "SelectModifierPhase"
            | "SelectStarterPhase"
            | "SelectTargetPhase"
            | "ShinySparklePhase"
            | "ShowAbilityPhase"
            | "ShowPartyExpBarPhase"
            | "ShowTrainerPhase"
            | "StatStageChangePhase"
            | "SummonMissingPhase"
            | "SummonPhase"
            | "SwitchBiomePhase"
            | "SwitchPhase"
            | "SwitchSummonPhase"
            | "TeraPhase"
            | "TitlePhase"
            | "ToggleDoublePositionPhase"
            | "TrainerVictoryPhase"
            | "TurnEndPhase"
            | "TurnInitPhase"
            | "TurnStartPhase"
            | "UnavailablePhase"
            | "UnlockPhase"
            | "VictoryPhase"
            | "WeatherEffectPhase"

      Parameters

      • phase: K

        The string name of the phase to check.

      Returns this is PhaseMap[K]

      Whether this phase is of the provided type.

      This does not check for subclasses! It only checks if the phase is exactly the given type. This method exists to avoid circular import issues, as using instanceof would require importing each phase.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods