PokéRogue
    Preparing search index...

    Class SwitchSummonPhase

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    doReturn fieldIndex lastPokemon partyMemberIndex phaseName player slotIndex switchType

    Methods

    end executeForAll getFieldIndex getParty getPokemon getSendOutText hideEnemyTrainer is isPlayer onEnd preSummon queuePostSummon showEnemyTrainer start summon summonWild switchAndSummon

    Constructors

    • Constructor for creating a new SwitchSummonPhase

      Parameters

      • switchType: SwitchType

        The type of switch behavior

      • fieldIndex: number

        Position on the battle field

      • slotIndex: number

        The index of pokemon (in party of 6) to switch into

      • doReturn: boolean

        Whether to render "comeback" dialogue

      • player: boolean = true

        Whether the switch came from the player or enemy; default true

      Returns SwitchSummonPhase

    Properties

    doReturn: boolean
    fieldIndex: number
    lastPokemon: Pokemon
    partyMemberIndex: number
    phaseName: "ReturnPhase" | "SwitchSummonPhase" = "SwitchSummonPhase"

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

    player: boolean
    slotIndex: number
    switchType: SwitchType

    Methods

    • Get the text to be displayed when a pokemon is forced to switch and leave the field.

      Parameters

      • switchedInPokemon: Pokemon

        The Pokemon having newly been sent in.

      Returns string

      The text to display.

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

      Type Parameters

      • K extends
            | "AddEnemyBuffModifierPhase"
            | "AttemptCapturePhase"
            | "AttemptRunPhase"
            | "BattleEndPhase"
            | "BerryPhase"
            | "CheckInterludePhase"
            | "CheckStatusEffectPhase"
            | "CheckSwitchPhase"
            | "CommandPhase"
            | "CommonAnimPhase"
            | "DamageAnimPhase"
            | "DynamicPhaseMarker"
            | "EggHatchPhase"
            | "EggLapsePhase"
            | "EggSummaryPhase"
            | "EncounterPhase"
            | "EndCardPhase"
            | "EndEvolutionPhase"
            | "EnemyCommandPhase"
            | "EvolutionPhase"
            | "ExpPhase"
            | "FaintPhase"
            | "FormChangePhase"
            | "GameOverPhase"
            | "GameOverModifierRewardPhase"
            | "HideAbilityPhase"
            | "HidePartyExpBarPhase"
            | "InitEncounterPhase"
            | "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.

    • Handles tweening and battle setup for a wild Pokemon that appears outside of the normal screen transition. Wild Pokemon will ease and fade in onto the field, then perform standard summon behavior. Currently only used by Mystery Encounters, as all other battle types pre-summon wild pokemon before screen transitions.

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods