PokéRogue
    Preparing search index...

    Class PokedexPageUiHandler

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

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    ability1 ability2 abilityHidden active activeTooltip allSpecies assetLoadCancelled availableVariants awaitingActionInput baseStats baseStatsOverlay baseTotal battleForms biomes blockInput blockInputOverlay canCycleForm canCycleGender canCycleShiny candyUpgradeIconElement candyUpgradeLabel canUseCandies cursor cursorObj eggMoves evolutions exitCallback filteredIndices filterInstructionsContainer formIconElement formIndex formLabel genderIconElement genderLabel hasAbilities hasEggMoves hasPassive infoOverlay instructionRowTextOffset instructionRowX instructionRowY instructionsContainer isFormGender isRibbonTrayOpen ivIconElement ivLabel levelMoves menuBg menuContainer menuDescriptions menuOptions message mode moveInfoOverlay onActionInput optionSelectText passive pendingPrompt pokemonCandyContainer pokemonCandyCountText pokemonCandyDarknessOverlay pokemonCandyIcon pokemonCandyOverlayIcon pokemonCategoryText pokemonCaughtCountText pokemonCaughtHatchedContainer pokemonFormText pokemonGenderText pokemonGrowthRateLabelText pokemonGrowthRateText pokemonHatchedCountText pokemonHatchedIcon pokemonLuckLabelText pokemonLuckText pokemonNameText pokemonNumberText pokemonShinyIcons pokemonSprite pokemonUncaughtText preBiomes previousSpecies previousStarterAttributes prevolutions prompt ribbonContainer savedStarterAttributes scale shinyIconElement shinyLabel shinyOverlay showBackSprite showBackSpriteIconElement showBackSpriteLabel species speciesLoaded speciesStarterDexEntry starterAttributes starterDexNoLabel starterId starterSelectContainer starterSelectMessageBox starterSelectMessageBoxContainer statsContainer statsMode textCallbackTimer textTimer tmMoves tutorialActive tutorialOverlay type1Icon type2Icon unlockedVariants

    Methods

    checkIconId clear clearText destroy getCurrentDexProps getCursor getFriendship getMenuText getStarterSpecies getStarterSpeciesId getUi hideInstructions initPromptSprite initStarterPrefs initTutorialOverlay isCaught isFormCaught isPassiveAvailable isSameSpeciesEggAvailable isSeen isTextAnimationInProgress isUpgradeAnimationEnabled isUpgradeIconEnabled isValueReductionAvailable processInput processTutorialInput sanitizeBiomes setCursor setMouseCursorStyle setSpecies setSpeciesDetails setTypeIcons setup show showDialogue showPrompt showStats showText starterSetup toggleStatsMode updateButtonIcon updateInstructions

    Constructors

    Properties

    ability1: AbilityId
    ability2: undefined | AbilityId
    abilityHidden: undefined | AbilityId
    active: boolean = false
    activeTooltip: undefined | "ABILITY" | "PASSIVE" | "CANDY"
    allSpecies: PokemonSpecies[] = []
    assetLoadCancelled: null | BooleanHolder
    availableVariants: number
    awaitingActionInput: boolean
    baseStats: number[]
    baseStatsOverlay: BaseStatsOverlay
    baseTotal: number
    battleForms: SpeciesFormChange[]
    biomes: readonly BiomeTierTod[]
    blockInput: boolean = false
    blockInputOverlay: boolean = false
    canCycleForm: boolean
    canCycleGender: boolean
    canCycleShiny: boolean
    candyUpgradeIconElement: Sprite
    candyUpgradeLabel: Text
    canUseCandies: boolean
    cursor: number = 0
    cursorObj: Image
    eggMoves: MoveId[] = []
    evolutions: SpeciesFormEvolution[]
    exitCallback: any
    filteredIndices: null | SpeciesId[] = null
    filterInstructionsContainer: Container
    formIconElement: Sprite
    formIndex: number
    formLabel: Text
    genderIconElement: Sprite
    genderLabel: Text
    hasAbilities: number[]
    hasEggMoves: boolean[] = []
    hasPassive: boolean
    infoOverlay: PokedexInfoOverlay
    instructionRowTextOffset: number = 9
    instructionRowX: number = 0
    instructionRowY: number = 0
    instructionsContainer: Container
    isFormGender: boolean
    isRibbonTrayOpen: boolean = false
    ivIconElement: Sprite
    ivLabel: Text
    levelMoves: LevelMoves
    menuBg: NineSlice
    menuContainer: Container
    menuDescriptions: string[]
    menuOptions: MenuOptions[]
    message: Text
    mode: null | number
    moveInfoOverlay: MoveInfoOverlay
    onActionInput: null | Function
    optionSelectText: BBCodeText
    passive: AbilityId
    pendingPrompt: boolean
    pokemonCandyContainer: Container
    pokemonCandyCountText: Text
    pokemonCandyDarknessOverlay: Sprite
    pokemonCandyIcon: Sprite
    pokemonCandyOverlayIcon: Sprite
    pokemonCategoryText: Text
    pokemonCaughtCountText: Text
    pokemonCaughtHatchedContainer: Container
    pokemonFormText: Text
    pokemonGenderText: Text
    pokemonGrowthRateLabelText: Text
    pokemonGrowthRateText: Text
    pokemonHatchedCountText: Text
    pokemonHatchedIcon: Sprite
    pokemonLuckLabelText: Text
    pokemonLuckText: Text
    pokemonNameText: Text
    pokemonNumberText: Text
    pokemonShinyIcons: Sprite[]
    pokemonSprite: Sprite
    pokemonUncaughtText: Text
    preBiomes: readonly BiomeTierTod[]
    previousSpecies: PokemonSpecies[]
    previousStarterAttributes: StarterAttributes[]
    prevolutions: SpeciesFormEvolution[]
    prompt: Sprite
    ribbonContainer: RibbonTray
    savedStarterAttributes: StarterAttributes
    scale: number = 0.1666666667
    shinyIconElement: Sprite
    shinyLabel: Text
    shinyOverlay: Image
    showBackSprite: boolean = false
    showBackSpriteIconElement: Sprite
    showBackSpriteLabel: Text
    species: PokemonSpecies
    speciesLoaded: Map<SpeciesId, boolean> = ...
    speciesStarterDexEntry: null | DexEntry
    starterAttributes: StarterAttributes
    starterDexNoLabel: Image
    starterId: number
    starterSelectContainer: Container
    starterSelectMessageBox: NineSlice
    starterSelectMessageBoxContainer: Container
    statsContainer: StatsContainer
    statsMode: boolean
    textCallbackTimer: null | TimerEvent
    textTimer: null | TimerEvent
    tmMoves: MoveId[] = []
    tutorialActive: boolean = false
    tutorialOverlay: Rectangle
    type1Icon: Sprite
    type2Icon: Sprite
    unlockedVariants: boolean[]

    Methods

    • Creates a temporary dex attr props that will be used to display the correct shiny, variant, and form based on this.starterAttributes

      Parameters

      • speciesId: number

        the id of the species to get props for

      Returns bigint

      the dex props

    • Parameters

      • _speciesId: number

      Returns { currentFriendship: number; friendshipCap: number }

    • If the pokemon is an evolution, find speciesId of its starter.

      Parameters

      • speciesId: any

        the id of the species to check

      Returns number

      the id of the corresponding starter

    • Check whether a given form is caught for a given species. All forms that can be reached through a form change during battle are considered caught and show up in the dex as such.

      Parameters

      • OptionalotherSpecies: PokemonSpecies

        The species to check; defaults to current species

      • OptionalotherFormIndex: number

        The form index of the form to check; defaults to current form

      Returns boolean

      true if the form is caught

    • Determines if a passive upgrade is available for the current species

      Returns boolean

      true if the user has enough candies and a passive has not been unlocked already

    • Determines if 'Animation' based upgrade notifications should be shown

      Returns boolean

      true if upgrade notifications are enabled and set to display an 'Animation'

    • Determines if 'Icon' based upgrade notifications should be shown

      Returns boolean

      true if upgrade notifications are enabled and set to display an 'Icon'

    • Determines if a value reduction upgrade is available for the current species

      Returns boolean

      true if the user has enough candies and all value reductions have not been unlocked already

    • Parameters

      • text: string
      • Optional_name: string
      • Optionaldelay: null | number
      • Optionalcallback: null | Function
      • OptionalcallbackDelay: null | number
      • Optionalprompt: null | boolean
      • OptionalpromptDelay: null | number

      Returns void

    • Parameters

      • text: string
      • Optionaldelay: number
      • Optionalcallback: Function
      • OptionalcallbackDelay: number
      • Optionalprompt: boolean
      • OptionalpromptDelay: number
      • OptionalmoveToTop: boolean

      Returns void

    • Parameters

      • iconSetting: any
      • gamepadType: any
      • iconElement: any
      • controlLabel: any

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    ability1ability2abilityHiddenactiveactiveTooltipallSpeciesassetLoadCancelledavailableVariantsawaitingActionInputbaseStatsbaseStatsOverlaybaseTotalbattleFormsbiomesblockInputblockInputOverlaycanCycleFormcanCycleGendercanCycleShinycandyUpgradeIconElementcandyUpgradeLabelcanUseCandiescursorcursorObjeggMovesevolutionsexitCallbackfilteredIndicesfilterInstructionsContainerformIconElementformIndexformLabelgenderIconElementgenderLabelhasAbilitieshasEggMoveshasPassiveinfoOverlayinstructionRowTextOffsetinstructionRowXinstructionRowYinstructionsContainerisFormGenderisRibbonTrayOpenivIconElementivLabellevelMovesmenuBgmenuContainermenuDescriptionsmenuOptionsmessagemodemoveInfoOverlayonActionInputoptionSelectTextpassivependingPromptpokemonCandyContainerpokemonCandyCountTextpokemonCandyDarknessOverlaypokemonCandyIconpokemonCandyOverlayIconpokemonCategoryTextpokemonCaughtCountTextpokemonCaughtHatchedContainerpokemonFormTextpokemonGenderTextpokemonGrowthRateLabelTextpokemonGrowthRateTextpokemonHatchedCountTextpokemonHatchedIconpokemonLuckLabelTextpokemonLuckTextpokemonNameTextpokemonNumberTextpokemonShinyIconspokemonSpritepokemonUncaughtTextpreBiomespreviousSpeciespreviousStarterAttributesprevolutionspromptribbonContainersavedStarterAttributesscaleshinyIconElementshinyLabelshinyOverlayshowBackSpriteshowBackSpriteIconElementshowBackSpriteLabelspeciesspeciesLoadedspeciesStarterDexEntrystarterAttributesstarterDexNoLabelstarterIdstarterSelectContainerstarterSelectMessageBoxstarterSelectMessageBoxContainerstatsContainerstatsModetextCallbackTimertextTimertmMovestutorialActivetutorialOverlaytype1Icontype2IconunlockedVariants
    Methods