PokéRogue
    Preparing search index...

    Class ObtainStatusEffectPhase

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    battlerIndex fieldIndex phaseName player sleepTurnsRemaining? sourcePokemon statusEffect statusMessage

    Methods

    end executeForAll getPokemon hideEnemyTrainer is showEnemyTrainer start

    Constructors

    • Parameters

      • battlerIndex: BattlerIndex

        The BattlerIndex of the Pokemon obtaining the status effect.

      • statusEffect: StatusEffect

        The StatusEffect being applied.

      • sourcePokemon: null | Pokemon = null

        The Pokemon applying the status effect to the target, or null if the status is applied from a non-Pokemon source (hazards, etc.); default null.

      • OptionalsleepTurnsRemaining: number

        The number of turns to set StatusEffect.SLEEP for; defaults to a random number between 2 and 4 and is unused for non-Sleep statuses.

      • sourceText: null | string = null

        The text to show for the source of the status effect, if any; default null.

      • statusMessage: string = ""

        A string containing text to be displayed upon status setting; defaults to normal key for status if empty or omitted.

      Returns ObtainStatusEffectPhase

      stop passing null to the phase

    Properties

    battlerIndex: number

    The battler index this phase refers to, or the pokemon ID if greater than 3. TODO: Make this either use IDs or BattlerIndexes, not a weird mix of both

    fieldIndex: number

    Remove in favor of battlerIndex pleas for fuck's sake

    phaseName: "ObtainStatusEffectPhase"

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

    player: boolean
    sleepTurnsRemaining?: number

    The number of turns to set StatusEffect.SLEEP for; defaults to a random number between 2 and 4 and is unused for non-Sleep statuses.

    sourcePokemon: null | Pokemon = null

    The Pokemon applying the status effect to the target, or null if the status is applied from a non-Pokemon source (hazards, etc.); default null.

    statusEffect: StatusEffect

    The StatusEffect being applied.

    statusMessage: string = ""

    A string containing text to be displayed upon status setting; defaults to normal key for status if empty or omitted.

    Methods

    • End the current phase and start a new one.

      Returns void

    • 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.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods