PokéRogue
    Preparing search index...

    Class SummaryUiHandler

    A basic abstract class to act as a holder and processor for UI elements.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    abilityContainer abilityPrompt active candyCountText candyIcon candyOverlay candyShadow championRibbon cursor descriptionScrollTween extraMoveRowContainer friendshipIcon friendshipOverlay friendshipShadow friendshipText fusionShinyIcon genderText ivContainer levelText mode moveAccuracyText moveCategoryIcon moveCursor moveCursorBlinkTimer moveCursorObj moveDescriptionText moveEffectContainer moveEffectContainerTitle moveEffectsVisible movePowerText moveRowsContainer movesContainer movesContainerDescriptionsTitle movesContainerMovesTitle moveSelect moveSelectFunction nameText newMove numberText passiveContainer permStatsContainer playerParty pokeball pokemon pokemonSprite selectCallback selectedMoveCursorObj selectedMoveIndex shinyIcon shinyOverlay splicedIcon statsContainer statsContainerExpBarTitle statsContainerExpTitle statsContainerItemTitle statsContainerStatsTitle status statusContainer statusVisible summaryContainer summaryContainerDexNoLabel summaryPageContainer summaryPageTransitionContainer summaryUiMode tabSprite transitioning

    Methods

    clear destroy destroyBlinkCursor getCursor getPageKey getSelectedMove getUi hideMoveEffect hideMoveSelect hideStatus populatePageContainer processInput setCursor setMouseCursorStyle setup show showMoveEffect showMoveSelect showStatus

    Constructors

    Properties

    abilityContainer: abilityContainer

    Object holding everything needed to display an ability

    abilityPrompt: Image

    The pixel button prompt indicating a passive is unlocked

    active: boolean = false
    candyCountText: Text
    candyIcon: Sprite
    candyOverlay: Sprite
    candyShadow: Sprite
    championRibbon: Image
    cursor: number = 0
    descriptionScrollTween: Tween | null
    extraMoveRowContainer: Container
    friendshipIcon: Sprite
    friendshipOverlay: Sprite
    friendshipShadow: Sprite
    friendshipText: Text
    fusionShinyIcon: Image
    genderText: Text
    ivContainer: Container
    levelText: Text
    mode: number | null
    moveAccuracyText: Text
    moveCategoryIcon: Sprite
    moveCursor: number
    moveCursorBlinkTimer: TimerEvent | null
    moveCursorObj: Sprite | null
    moveDescriptionText: Text
    moveEffectContainer: Container
    moveEffectContainerTitle: Image
    moveEffectsVisible: boolean
    movePowerText: Text
    moveRowsContainer: Container
    movesContainer: Container
    movesContainerDescriptionsTitle: Image
    movesContainerMovesTitle: Image
    moveSelect: boolean
    moveSelectFunction: ((cursor: number) => void) | null
    nameText: Text
    newMove: Move | null

    This is set to false when checking the summary of a freshly caught Pokemon as it is not part of a player's party yet but still needs to display its items

    numberText: Text
    passiveContainer: abilityContainer

    Object holding everything needed to display a passive

    permStatsContainer: Container
    playerParty: boolean
    pokeball: Sprite
    pokemon: PlayerPokemon | null
    pokemonSprite: Sprite
    selectCallback: ((cursor: number) => void) | null
    selectedMoveCursorObj: Sprite | null
    selectedMoveIndex: number
    shinyIcon: Image
    shinyOverlay: Image
    splicedIcon: Sprite
    statsContainer: Container
    statsContainerExpBarTitle: Image
    statsContainerExpTitle: Image
    statsContainerItemTitle: Image
    statsContainerStatsTitle: Image
    status: Image
    statusContainer: Container
    statusVisible: boolean
    summaryContainer: Container
    summaryContainerDexNoLabel: Image
    summaryPageContainer: Container
    summaryPageTransitionContainer: Container
    summaryUiMode: SummaryUiMode
    tabSprite: Sprite
    transitioning: boolean

    Methods

    • Parameters

      • args: [
            pokemon: PlayerPokemon,
            uiMode?: DEFAULT,
            startPage?: Page,
            selectCallback?: (cursor: number) => void,
            player?: boolean,
        ]

      Returns boolean

    • Parameters

      • args: [
            pokemon: PlayerPokemon,
            uiMode: LEARN_MOVE,
            move?: Move,
            moveSelectCallback?: (cursor: number) => void,
            player?: boolean,
        ]

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    abilityContainerabilityPromptactivecandyCountTextcandyIconcandyOverlaycandyShadowchampionRibboncursordescriptionScrollTweenextraMoveRowContainerfriendshipIconfriendshipOverlayfriendshipShadowfriendshipTextfusionShinyIcongenderTextivContainerlevelTextmodemoveAccuracyTextmoveCategoryIconmoveCursormoveCursorBlinkTimermoveCursorObjmoveDescriptionTextmoveEffectContainermoveEffectContainerTitlemoveEffectsVisiblemovePowerTextmoveRowsContainermovesContainermovesContainerDescriptionsTitlemovesContainerMovesTitlemoveSelectmoveSelectFunctionnameTextnewMovenumberTextpassiveContainerpermStatsContainerplayerPartypokeballpokemonpokemonSpriteselectCallbackselectedMoveCursorObjselectedMoveIndexshinyIconshinyOverlaysplicedIconstatsContainerstatsContainerExpBarTitlestatsContainerExpTitlestatsContainerItemTitlestatsContainerStatsTitlestatusstatusContainerstatusVisiblesummaryContainersummaryContainerDexNoLabelsummaryPageContainersummaryPageTransitionContainersummaryUiModetabSpritetransitioning
    Methods