Class PokedexPageUiHandler

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

Hierarchy (View Summary)

MessageUiHandler
- PokedexPageUiHandler

Index

Constructors

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

Constructors

constructor

new PokedexPageUiHandler(): PokedexPageUiHandler
Returns PokedexPageUiHandler
Overrides MessageUiHandler.constructor
- Defined in src/ui/handlers/pokedex-page-ui-handler.ts:296

Properties

`Private`ability1

ability1: AbilityId

`Private`ability2

ability2: undefined | AbilityId

`Private`abilityHidden

abilityHidden: undefined | AbilityId

active

active: boolean = false

`Private`activeTooltip

activeTooltip: undefined | "ABILITY" | "PASSIVE" | "CANDY"

`Private`allSpecies

allSpecies: PokemonSpecies[] = []

`Private`assetLoadCancelled

assetLoadCancelled: null | BooleanHolder

`Private`availableVariants

availableVariants: number

`Protected`awaitingActionInput

awaitingActionInput: boolean

`Private`baseStats

baseStats: number[]

`Private`baseStatsOverlay

baseStatsOverlay: BaseStatsOverlay

`Private`baseTotal

baseTotal: number

`Private`battleForms

battleForms: SpeciesFormChange[]

`Private`biomes

biomes: readonly BiomeTierTod[]

`Protected`blockInput

blockInput: boolean = false

`Protected`blockInputOverlay

blockInputOverlay: boolean = false

`Private`canCycleForm

canCycleForm: boolean

`Private`canCycleGender

canCycleGender: boolean

`Private`canCycleShiny

canCycleShiny: boolean

`Private`candyUpgradeIconElement

candyUpgradeIconElement: Sprite

`Private`candyUpgradeLabel

candyUpgradeLabel: Text

`Private`canUseCandies

canUseCandies: boolean

`Protected`cursor

cursor: number = 0

cursorObj

cursorObj: Image

`Private`eggMoves

eggMoves: MoveId[] = []

`Private`evolutions

evolutions: SpeciesFormEvolution[]

`Private`exitCallback

exitCallback: any

`Private`filteredIndices

filteredIndices: null | SpeciesId[] = null

`Private`filterInstructionsContainer

filterInstructionsContainer: Container

`Private`formIconElement

formIconElement: Sprite

`Private`formIndex

formIndex: number

`Private`formLabel

formLabel: Text

`Private`genderIconElement

genderIconElement: Sprite

`Private`genderLabel

genderLabel: Text

`Private`hasAbilities

hasAbilities: number[]

`Private`hasEggMoves

hasEggMoves: boolean[] = []

`Private`hasPassive

hasPassive: boolean

`Private`infoOverlay

infoOverlay: PokedexInfoOverlay

`Private`instructionRowTextOffset

instructionRowTextOffset: number = 9

`Private`instructionRowX

instructionRowX: number = 0

`Private`instructionRowY

instructionRowY: number = 0

`Private`instructionsContainer

instructionsContainer: Container

`Private`isFormGender

isFormGender: boolean

`Private`isRibbonTrayOpen

isRibbonTrayOpen: boolean = false

`Private`ivIconElement

ivIconElement: Sprite

`Private`ivLabel

ivLabel: Text

`Private`levelMoves

levelMoves: LevelMoves

`Private`menuBg

menuBg: NineSlice

`Private`menuContainer

menuContainer: Container

`Private`menuDescriptions

menuDescriptions: string[]

`Private`menuOptions

menuOptions: MenuOptions[]

message

message: Text

`Protected`mode

mode: null | number

`Private`moveInfoOverlay

moveInfoOverlay: MoveInfoOverlay

`Protected`onActionInput

onActionInput: null | Function

`Protected`optionSelectText

optionSelectText: BBCodeText

`Private`passive

passive: AbilityId

pendingPrompt

pendingPrompt: boolean

`Private`pokemonCandyContainer

pokemonCandyContainer: Container

`Private`pokemonCandyCountText

pokemonCandyCountText: Text

`Private`pokemonCandyDarknessOverlay

pokemonCandyDarknessOverlay: Sprite

`Private`pokemonCandyIcon

pokemonCandyIcon: Sprite

`Private`pokemonCandyOverlayIcon

pokemonCandyOverlayIcon: Sprite

`Private`pokemonCategoryText

pokemonCategoryText: Text

`Private`pokemonCaughtCountText

pokemonCaughtCountText: Text

`Private`pokemonCaughtHatchedContainer

pokemonCaughtHatchedContainer: Container

`Private`pokemonFormText

pokemonFormText: Text

`Private`pokemonGenderText

pokemonGenderText: Text

`Private`pokemonGrowthRateLabelText

pokemonGrowthRateLabelText: Text

`Private`pokemonGrowthRateText

pokemonGrowthRateText: Text

`Private`pokemonHatchedCountText

pokemonHatchedCountText: Text

`Private`pokemonHatchedIcon

pokemonHatchedIcon: Sprite

`Private`pokemonLuckLabelText

pokemonLuckLabelText: Text

`Private`pokemonLuckText

pokemonLuckText: Text

`Private`pokemonNameText

pokemonNameText: Text

`Private`pokemonNumberText

pokemonNumberText: Text

`Private`pokemonShinyIcons

pokemonShinyIcons: Sprite[]

`Private`pokemonSprite

pokemonSprite: Sprite

`Private`pokemonUncaughtText

pokemonUncaughtText: Text

`Private`preBiomes

preBiomes: readonly BiomeTierTod[]

`Private`previousSpecies

previousSpecies: PokemonSpecies[]

`Private`previousStarterAttributes

previousStarterAttributes: StarterAttributes[]

`Private`prevolutions

prevolutions: SpeciesFormEvolution[]

prompt

prompt: Sprite

`Private`ribbonContainer

ribbonContainer: RibbonTray

`Private`savedStarterAttributes

savedStarterAttributes: StarterAttributes

`Protected`scale

scale: number = 0.1666666667

`Private`shinyIconElement

shinyIconElement: Sprite

`Private`shinyLabel

shinyLabel: Text

`Private`shinyOverlay

shinyOverlay: Image

`Private`showBackSprite

showBackSprite: boolean = false

`Private`showBackSpriteIconElement

showBackSpriteIconElement: Sprite

`Private`showBackSpriteLabel

showBackSpriteLabel: Text

`Private`species

species: PokemonSpecies

`Private`speciesLoaded

speciesLoaded: Map<SpeciesId, boolean> = ...

`Private`speciesStarterDexEntry

speciesStarterDexEntry: null | DexEntry

`Private`starterAttributes

starterAttributes: StarterAttributes

`Private`starterDexNoLabel

starterDexNoLabel: Image

`Private`starterId

starterId: number

`Private`starterSelectContainer

starterSelectContainer: Container

`Private`starterSelectMessageBox

starterSelectMessageBox: NineSlice

`Private`starterSelectMessageBoxContainer

starterSelectMessageBoxContainer: Container

`Private`statsContainer

statsContainer: StatsContainer

`Private`statsMode

statsMode: boolean

`Protected`textCallbackTimer

textCallbackTimer: null | TimerEvent

`Protected`textTimer

textTimer: null | TimerEvent

`Private`tmMoves

tmMoves: MoveId[] = []

tutorialActive

tutorialActive: boolean = false

tutorialOverlay

tutorialOverlay: Rectangle

`Private`type1Icon

type1Icon: Sprite

`Private`type2Icon

type2Icon: Sprite

`Private`unlockedVariants

unlockedVariants: boolean[]

Methods

checkIconId

checkIconId(
    icon: Sprite,
    species: PokemonSpecies,
    female: boolean,
    formIndex: number,
    shiny: boolean,
    variant: number,
): void
Parameters
- icon: Sprite
- species: PokemonSpecies
- female: boolean
- formIndex: number
- shiny: boolean
- variant: number
Returns void
- Defined in src/ui/handlers/pokedex-page-ui-handler.ts:2894

clear

clear(): void
Returns void
Overrides MessageUiHandler.clear
- Defined in src/ui/handlers/pokedex-page-ui-handler.ts:2875

clearText

clearText(): void
Returns void
Overrides MessageUiHandler.clearText
- Defined in src/ui/handlers/pokedex-page-ui-handler.ts:2857

destroy

destroy(): void
To be implemented by individual handlers when necessary to free memory Called when BattleScene is reset

Returns void
Inherited from MessageUiHandler.destroy
- Defined in src/ui/handlers/ui-handler.ts:63

getCurrentDexProps

getCurrentDexProps(speciesId: number): bigint
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
- Defined in src/ui/handlers/pokedex-page-ui-handler.ts:2777

getCursor

getCursor(): number
Returns number
Inherited from MessageUiHandler.getCursor
- Defined in src/ui/handlers/ui-handler.ts:34

getFriendship

getFriendship(
_speciesId: number,
): { currentFriendship: number; friendshipCap: number }
Parameters
- _speciesId: number
Returns { currentFriendship: number; friendshipCap: number }
- Defined in src/ui/handlers/pokedex-page-ui-handler.ts:2317

getMenuText

getMenuText(): string
Returns string
- Defined in src/ui/handlers/pokedex-page-ui-handler.ts:766

getStarterSpecies

getStarterSpecies(species: any): PokemonSpecies
Parameters
- species: any
Returns PokemonSpecies
- Defined in src/ui/handlers/pokedex-page-ui-handler.ts:1145

getStarterSpeciesId

getStarterSpeciesId(speciesId: any): 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
- Defined in src/ui/handlers/pokedex-page-ui-handler.ts:1132

getUi

getUi(): UI
Returns UI
Inherited from MessageUiHandler.getUi
- Defined in src/ui/handlers/ui-handler.ts:30

hideInstructions

hideInstructions(): void
Returns void
- Defined in src/ui/handlers/pokedex-page-ui-handler.ts:2862

initPromptSprite

initPromptSprite(container: Container): void
Add the sprite to be displayed at the end of messages with prompts
Parameters
- container: Container
  the container to add the sprite to
Returns void
Inherited from MessageUiHandler.initPromptSprite
- Defined in src/ui/handlers/message-ui-handler.ts:24

initStarterPrefs

initStarterPrefs(): StarterAttributes
Get the starter attributes for the given PokemonSpecies, after sanitizing them. If somehow a preference is set for a form, variant, gender, ability or nature that wasn't actually unlocked or is invalid it will be cleared here

Returns StarterAttributes
StarterAttributes for the species
- Defined in src/ui/handlers/pokedex-page-ui-handler.ts:1026

initTutorialOverlay

initTutorialOverlay(container: Container): void
Create a semi transparent overlay that will get shown during tutorials
Parameters
- container: Container
  the container to add the overlay to
Returns void
Inherited from MessageUiHandler.initTutorialOverlay
- Defined in src/ui/handlers/awaitable-ui-handler.ts:33

isCaught

isCaught(otherSpecies?: PokemonSpecies): bigint
Return the caughtAttr of a given species, sanitized.
Parameters
- OptionalotherSpecies: PokemonSpecies
  The species to check; defaults to current species
Returns bigint
caught DexAttr for the species
- Defined in src/ui/handlers/pokedex-page-ui-handler.ts:973

isFormCaught

isFormCaught(otherSpecies?: PokemonSpecies, otherFormIndex?: number): boolean
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
- Defined in src/ui/handlers/pokedex-page-ui-handler.ts:993

isPassiveAvailable

isPassiveAvailable(): boolean
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
- Defined in src/ui/handlers/pokedex-page-ui-handler.ts:2332

isSameSpeciesEggAvailable

isSameSpeciesEggAvailable(): boolean
Determines if an same species egg can be bought for the current species

Returns boolean
true if the user has enough candies
- Defined in src/ui/handlers/pokedex-page-ui-handler.ts:2361

isSeen

isSeen(): boolean
Returns boolean
- Defined in src/ui/handlers/pokedex-page-ui-handler.ts:1010

isTextAnimationInProgress

isTextAnimationInProgress(): boolean
Returns boolean
Inherited from MessageUiHandler.isTextAnimationInProgress
- Defined in src/ui/handlers/message-ui-handler.ts:259

isUpgradeAnimationEnabled

isUpgradeAnimationEnabled(): boolean
Determines if 'Animation' based upgrade notifications should be shown

Returns boolean
true if upgrade notifications are enabled and set to display an 'Animation'
- Defined in src/ui/handlers/pokedex-page-ui-handler.ts:1123

isUpgradeIconEnabled

isUpgradeIconEnabled(): boolean
Determines if 'Icon' based upgrade notifications should be shown

Returns boolean
true if upgrade notifications are enabled and set to display an 'Icon'
- Defined in src/ui/handlers/pokedex-page-ui-handler.ts:1116

isValueReductionAvailable

isValueReductionAvailable(): boolean
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
- Defined in src/ui/handlers/pokedex-page-ui-handler.ts:2346

processInput

processInput(button: Button): boolean
Parameters
- button: Button
Returns boolean
Overrides MessageUiHandler.processInput
- Defined in src/ui/handlers/pokedex-page-ui-handler.ts:1152

processTutorialInput

processTutorialInput(button: Button): boolean
Parameters
- button: Button
Returns boolean
Inherited from MessageUiHandler.processTutorialInput
- Defined in src/ui/handlers/awaitable-ui-handler.ts:16

sanitizeBiomes

sanitizeBiomes(
biomes: readonly BiomeTierTod[],
speciesId: number,
): readonly BiomeTierTod[]
Parameters
- biomes: readonly BiomeTierTod[]
- speciesId: number
Returns readonly BiomeTierTod[]
- Defined in src/ui/handlers/pokedex-page-ui-handler.ts:908

setCursor

setCursor(cursor: number): boolean
Parameters
- cursor: number
Returns boolean
Overrides MessageUiHandler.setCursor
- Defined in src/ui/handlers/pokedex-page-ui-handler.ts:2294

`Protected`setMouseCursorStyle

setMouseCursorStyle(cursorStyle: "pointer" | "default"): void
Changes the style of the mouse cursor.
Parameters
- cursorStyle: "pointer" | "default"
  cursor style to apply
Returns void
See
https://developer.mozilla.org/en-US/docs/Web/CSS/cursor
Inherited from MessageUiHandler.setMouseCursorStyle
- Defined in src/ui/handlers/ui-handler.ts:52

setSpecies

setSpecies(): void
Returns void
- Defined in src/ui/handlers/pokedex-page-ui-handler.ts:2368

setSpeciesDetails

setSpeciesDetails(
    species: PokemonSpecies,
    options?: SpeciesDetails,
    forceUpdate?: boolean,
): void
Parameters
- species: PokemonSpecies
- options: SpeciesDetails = {}
- OptionalforceUpdate: boolean
Returns void
- Defined in src/ui/handlers/pokedex-page-ui-handler.ts:2462

setTypeIcons

setTypeIcons(type1: null | PokemonType, type2: null | PokemonType): void
Parameters
- type1: null | PokemonType
- type2: null | PokemonType
Returns void
- Defined in src/ui/handlers/pokedex-page-ui-handler.ts:2756

setup

setup(): void
Returns void
Overrides MessageUiHandler.setup
- Defined in src/ui/handlers/pokedex-page-ui-handler.ts:300

show

show(args: any[]): boolean
Parameters
- args: any[]
Returns boolean
Overrides MessageUiHandler.show
- Defined in src/ui/handlers/pokedex-page-ui-handler.ts:717

showDialogue

showDialogue(
    text: string,
    _name?: string,
    delay?: null | number,
    callback?: null | Function,
    callbackDelay?: null | number,
    prompt?: null | boolean,
    promptDelay?: null | number,
): void
Parameters
- text: string
- Optional_name: string
- Optionaldelay: null | number
- Optionalcallback: null | Function
- OptionalcallbackDelay: null | number
- Optionalprompt: null | boolean
- OptionalpromptDelay: null | number
Returns void
Inherited from MessageUiHandler.showDialogue
- Defined in src/ui/handlers/message-ui-handler.ts:48

showPrompt

showPrompt(callback?: null | Function, callbackDelay?: null | number): void
Parameters
- Optionalcallback: null | Function
- OptionalcallbackDelay: null | number
Returns void
Inherited from MessageUiHandler.showPrompt
- Defined in src/ui/handlers/message-ui-handler.ts:222

showStats

showStats(): void
Returns void
- Defined in src/ui/handlers/pokedex-page-ui-handler.ts:2846

showText

showText(
    text: string,
    delay?: number,
    callback?: Function,
    callbackDelay?: number,
    prompt?: boolean,
    promptDelay?: number,
    moveToTop?: boolean,
): void
Parameters
- text: string
- Optionaldelay: number
- Optionalcallback: Function
- OptionalcallbackDelay: number
- Optionalprompt: boolean
- OptionalpromptDelay: number
- OptionalmoveToTop: boolean
Returns void
Overrides MessageUiHandler.showText
- Defined in src/ui/handlers/pokedex-page-ui-handler.ts:1084

starterSetup

starterSetup(): void
Returns void
- Defined in src/ui/handlers/pokedex-page-ui-handler.ts:787

toggleStatsMode

toggleStatsMode(on?: boolean): void
Parameters
- Optionalon: boolean
Returns void
- Defined in src/ui/handlers/pokedex-page-ui-handler.ts:2829

updateButtonIcon

updateButtonIcon(
    iconSetting: any,
    gamepadType: any,
    iconElement: any,
    controlLabel: any,
): void
Parameters
- iconSetting: any
- gamepadType: any
- iconElement: any
- controlLabel: any
Returns void
- Defined in src/ui/handlers/pokedex-page-ui-handler.ts:2192

updateInstructions

updateInstructions(): void
Returns void
- Defined in src/ui/handlers/pokedex-page-ui-handler.ts:2234

Class PokedexPageUiHandler

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Returns PokedexPageUiHandler

Properties

Privateability1

Privateability2

PrivateabilityHidden

active

PrivateactiveTooltip

PrivateallSpecies

PrivateassetLoadCancelled

PrivateavailableVariants

ProtectedawaitingActionInput

PrivatebaseStats

PrivatebaseStatsOverlay

PrivatebaseTotal

PrivatebattleForms

Privatebiomes

ProtectedblockInput

ProtectedblockInputOverlay

PrivatecanCycleForm

PrivatecanCycleGender

PrivatecanCycleShiny

PrivatecandyUpgradeIconElement

PrivatecandyUpgradeLabel

PrivatecanUseCandies

Protectedcursor

cursorObj

PrivateeggMoves

Privateevolutions

PrivateexitCallback

PrivatefilteredIndices

PrivatefilterInstructionsContainer

PrivateformIconElement

PrivateformIndex

PrivateformLabel

PrivategenderIconElement

PrivategenderLabel

PrivatehasAbilities

PrivatehasEggMoves

PrivatehasPassive

PrivateinfoOverlay

PrivateinstructionRowTextOffset

PrivateinstructionRowX

PrivateinstructionRowY

PrivateinstructionsContainer

PrivateisFormGender

PrivateisRibbonTrayOpen

PrivateivIconElement

PrivateivLabel

PrivatelevelMoves

PrivatemenuBg

PrivatemenuContainer

PrivatemenuDescriptions

PrivatemenuOptions

message

Protectedmode

PrivatemoveInfoOverlay

ProtectedonActionInput

ProtectedoptionSelectText

Privatepassive

pendingPrompt

PrivatepokemonCandyContainer

PrivatepokemonCandyCountText

PrivatepokemonCandyDarknessOverlay

PrivatepokemonCandyIcon

PrivatepokemonCandyOverlayIcon

PrivatepokemonCategoryText

PrivatepokemonCaughtCountText

PrivatepokemonCaughtHatchedContainer

PrivatepokemonFormText

PrivatepokemonGenderText

PrivatepokemonGrowthRateLabelText

PrivatepokemonGrowthRateText

`Private`ability1

`Private`ability2

`Private`abilityHidden

`Private`activeTooltip

`Private`allSpecies

`Private`assetLoadCancelled

`Private`availableVariants

`Protected`awaitingActionInput

`Private`baseStats

`Private`baseStatsOverlay

`Private`baseTotal

`Private`battleForms

`Private`biomes

`Protected`blockInput

`Protected`blockInputOverlay

`Private`canCycleForm

`Private`canCycleGender

`Private`canCycleShiny

`Private`candyUpgradeIconElement

`Private`candyUpgradeLabel

`Private`canUseCandies

`Protected`cursor

`Private`eggMoves

`Private`evolutions

`Private`exitCallback

`Private`filteredIndices

`Private`filterInstructionsContainer

`Private`formIconElement

`Private`formIndex

`Private`formLabel

`Private`genderIconElement

`Private`genderLabel

`Private`hasAbilities

`Private`hasEggMoves

`Private`hasPassive

`Private`infoOverlay

`Private`instructionRowTextOffset

`Private`instructionRowX

`Private`instructionRowY

`Private`instructionsContainer

`Private`isFormGender

`Private`isRibbonTrayOpen

`Private`ivIconElement

`Private`ivLabel

`Private`levelMoves

`Private`menuBg

`Private`menuContainer

`Private`menuDescriptions

`Private`menuOptions

`Protected`mode

`Private`moveInfoOverlay

`Protected`onActionInput

`Protected`optionSelectText

`Private`passive

`Private`pokemonCandyContainer

`Private`pokemonCandyCountText

`Private`pokemonCandyDarknessOverlay

`Private`pokemonCandyIcon

`Private`pokemonCandyOverlayIcon

`Private`pokemonCategoryText

`Private`pokemonCaughtCountText

`Private`pokemonCaughtHatchedContainer

`Private`pokemonFormText

`Private`pokemonGenderText

`Private`pokemonGrowthRateLabelText

`Private`pokemonGrowthRateText

`Private`pokemonHatchedCountText

`Private`pokemonHatchedIcon

`Private`pokemonLuckLabelText

`Private`pokemonLuckText

`Private`pokemonNameText

`Private`pokemonNumberText

`Private`pokemonShinyIcons

`Private`pokemonSprite

`Private`pokemonUncaughtText

`Private`preBiomes

`Private`previousSpecies

`Private`previousStarterAttributes

`Private`prevolutions

`Private`ribbonContainer