Class PhaseInterceptor

constructor

• new PhaseInterceptor(scene: BattleScene): PhaseInterceptor

  Initialize a new PhaseInterceptor.

  Parameters

  • scene: BattleScene

    The scene to be managed

  Returns PhaseInterceptor

  Remarks

  This overrides PhaseManager.startCurrentPhase to toggle the interceptor's state instead of immediately starting the next phase.

Readonlylog

checkMode

• checkMode(): void

  If this is at the target phase, unlock the interceptor and return control back to the caller once the calling phase has finished.

  Returns void

  Remarks

  This should not be called by anything other than PromptHandler.

clearLogs

• clearLogs(): void

  Clear all prior phase logs.

  Returns void

shiftPhase

• shiftPhase(): void

  Skip the next upcoming phase.

  Returns void

  Throws

  Error if currently running a phase.

  Remarks

  This function should be used for skipping phases not yet started. To end ones already in the process of running, use GameManager.endPhase.

  Example

  await game.phaseInterceptor.to("LoginPhase", false);
  game.phaseInterceptor.shiftPhase(); // skips LoginPhase without starting it
  Copy

to

• to(
      target:
          | "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",
      runTarget?: boolean,
  ): Promise<void>

  Method to transition to a target phase.

  Parameters

  • target:
        | "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"

    The name of the Phase to transition to

  • runTarget: boolean = true

    Whether or not to run the target phase before resolving; default true

  Returns Promise<void>

  A Promise that resolves once target has been reached.

  Remarks

  This will not resolve for any reason until the target phase has been reached.

  Example

  await game.phaseInterceptor.to("MoveEffectPhase", false);
  Copy