PokéRogue
    Preparing search index...

    Class EvolutionPhase

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    canCancel evoChain evolution evolutionBaseBg evolutionBg evolutionBgm evolutionBgOverlay evolutionContainer evolutionHandler evolutionOverlay fusionSpeciesEvolved lastLevel phaseName pokemon pokemonEvoSprite pokemonEvoTintSprite pokemonSprite pokemonTintSprite preEvolvedPokemonName

    Methods

    configureSprite doArcDownParticle doArcDownward doCircleInward doCircleInwardParticle doCycle doEvolution doSpiralUpward doSpiralUpwardParticle doSpray doSprayParticle end fadeOutEvolutionAssets fadeOutPokemonSprite getPokemonSprite handleFailedEvolution handleSuccessEvolution is onEvolutionComplete playEvolutionAnimation postEvolve prepareForCycle setMode setupEvolutionAssets setupPokemonSprites showFailedEvolutionUI showPauseEvolutionConfirmation start updateEvolvedPokemonSprites validate

    Constructors

    Properties

    canCancel: boolean

    Whether the evolution can be cancelled by the player

    evoChain: null | TweenChain = null
    evolution: null | SpeciesFormEvolution
    evolutionBaseBg: Image
    evolutionBg: Video
    evolutionBgm: null | AnySound
    evolutionBgOverlay: Rectangle
    evolutionContainer: Container

    Container for all assets used by the scene. When the scene is cleared, the children within this are destroyed.

    evolutionHandler: EvolutionSceneUiHandler
    evolutionOverlay: Rectangle
    fusionSpeciesEvolved: boolean
    lastLevel: number
    phaseName: "EvolutionPhase" | "FormChangePhase" = "EvolutionPhase"

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

    pokemon: PlayerPokemon
    pokemonEvoSprite: Sprite
    pokemonEvoTintSprite: Sprite
    pokemonSprite: Sprite
    pokemonTintSprite: Sprite
    preEvolvedPokemonName: string

    Methods

    • Configure the sprite, setting its pipeline data

      Parameters

      • pokemon: Pokemon

        The pokemon object that the sprite information is configured from

      • sprite: Sprite

        The sprite object to configure

      • setPipeline: boolean = true

        Whether to also set the pipeline; should be false if the sprite is only being updated with new sprite assets

      Returns Sprite

      The sprite object that was passed in

    • Return a tween chain that cycles the evolution sprites

      Parameters

      • cycles: number
      • lastCycle: number = 15
      • onComplete: () => void = ...

      Returns void

    • End the current phase and start a new one.

      Returns void

    • Fade out the evolution assets, show the failed evolution UI messages, and enqueue the EndEvolutionPhase

      Parameters

      • evolvedPokemon: Pokemon

        The evolved Pokemon

      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.

    • Show the confirmation prompt for pausing evolutions

      Parameters

      • endCallback: () => void

        The callback to call after either option is selected. This should end the evolution phase

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods