Class PokedexUiHandler

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

Hierarchy (View Summary)

MessageUiHandler
- PokedexUiHandler

Index

Constructors

Properties

active assetLoadCancelled awaitingActionInput blockInput blockOpenPage canShowFormTray cursor cursorObj exitCallback? filterBar filterBarContainer filterBarCursor filteredIndices filteredPokemonData filterMode filterText filterTextContainer filterTextCursor filterTextMode formTrayContainer gameData goFilterIconElement1 goFilterIconElement2 goFilterLabel iconAnimHandler lastSpecies message nameBoxContainer? oldCursor onActionInput optionSelectText pendingPrompt pokemonContainers pokemonFormText pokemonNameText pokemonNumberText pokemonSprite pokerusCursorObjs pokerusSpecies prompt scale scrollCursor showDecorations showFormTrayIconElement showFormTrayLabel showingTray speciesLoaded speciesStarterDexEntry starterPreferences starterSelectContainer starterSelectMessageBox starterSelectMessageBoxContainer starterSelectScrollBar textCallbackTimer textTimer toggleDecorationsIconElement toggleDecorationsLabel trayBg trayColumns trayContainers trayCursor trayCursorObj trayForms trayNumIcons trayRows tutorialActive tutorialOverlay type1Icon type2Icon wordWrapWidth

Constructors

constructor

new PokedexUiHandler(): PokedexUiHandler

Returns PokedexUiHandler

Inherited from MessageUiHandler.constructor

Properties

active

active: boolean = false

`Private`assetLoadCancelled

assetLoadCancelled: BooleanHolder<boolean> | null

`Protected`awaitingActionInput

awaitingActionInput: boolean

`Protected`blockInput

blockInput: boolean = false

`Private`blockOpenPage

blockOpenPage: boolean = false

`Private`canShowFormTray

canShowFormTray: boolean

`Protected`cursor

cursor: number = 0

cursorObj

cursorObj: Image

`Private` `Optional`exitCallback

exitCallback?: () => void

`Private`filterBar

filterBar: FilterBar

`Private`filterBarContainer

filterBarContainer: Container

`Private`filterBarCursor

filterBarCursor: number = 0

`Private`filteredIndices

filteredIndices: SpeciesId[]

`Private`filteredPokemonData

filteredPokemonData: ContainerData[] = []

`Private`filterMode

filterMode: boolean

`Private`filterText

filterText: FilterText

`Private`filterTextContainer

filterTextContainer: Container

`Private`filterTextCursor

filterTextCursor: number = 0

`Private`filterTextMode

filterTextMode: boolean

`Private`formTrayContainer

formTrayContainer: Container

`Private`gameData

gameData: GameData

`Private`goFilterIconElement1

goFilterIconElement1: Sprite

`Private`goFilterIconElement2

goFilterIconElement2: Sprite

`Private`goFilterLabel

goFilterLabel: Text

`Private`iconAnimHandler

iconAnimHandler: PokemonIconAnimHelper

`Private`lastSpecies

lastSpecies: PokemonSpecies

message

message: Text

`Optional`nameBoxContainer

nameBoxContainer?: Container

The container for the name box

Remarks

This will be undefined unless this.initNameBox() was called

`Private`oldCursor

oldCursor: number = -1

`Protected`onActionInput

onActionInput: AnyFn<any> | null

`Protected`optionSelectText

optionSelectText: Text

pendingPrompt

pendingPrompt: boolean = false

`Private`pokemonContainers

pokemonContainers: PokedexMonContainer[] = []

`Private`pokemonFormText

pokemonFormText: Text

`Private`pokemonNameText

pokemonNameText: Text

`Private`pokemonNumberText

pokemonNumberText: Text

`Private`pokemonSprite

pokemonSprite: Sprite

`Private`pokerusCursorObjs

pokerusCursorObjs: Image[]

`Private`pokerusSpecies

pokerusSpecies: SpeciesId[] = []

prompt

prompt: Sprite

`Protected`scale

scale: number = 0.1666666667

`Private`scrollCursor

scrollCursor: number

`Private`showDecorations

showDecorations: boolean = false

`Private`showFormTrayIconElement

showFormTrayIconElement: Sprite

`Private`showFormTrayLabel

showFormTrayLabel: Text

`Private`showingTray

showingTray: boolean = false

`Private` `Readonly`speciesLoaded

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

`Private`speciesStarterDexEntry

speciesStarterDexEntry: DexEntry | null

`Private`starterPreferences

starterPreferences: AllStarterPreferences

`Private`starterSelectContainer

starterSelectContainer: Container

`Private`starterSelectMessageBox

starterSelectMessageBox: NineSlice

`Private`starterSelectMessageBoxContainer

starterSelectMessageBoxContainer: Container

`Private`starterSelectScrollBar

starterSelectScrollBar: ScrollBar

`Protected`textCallbackTimer

textCallbackTimer: TimerEvent | null

`Protected`textTimer

textTimer: TimerEvent | null

`Private`toggleDecorationsIconElement

toggleDecorationsIconElement: Sprite

`Private`toggleDecorationsLabel

toggleDecorationsLabel: Text

`Private`trayBg

trayBg: NineSlice

`Private`trayColumns

trayColumns: number

`Private`trayContainers

trayContainers: PokedexMonContainer[] = []

`Private`trayCursor

trayCursor: number = 0

`Private`trayCursorObj

trayCursorObj: Image

`Private`trayForms

trayForms: PokemonForm[]

`Private`trayNumIcons

trayNumIcons: number

`Private`trayRows

trayRows: number

tutorialActive

tutorialActive: boolean = false

tutorialOverlay

tutorialOverlay: Rectangle

`Private`type1Icon

type1Icon: Sprite

`Private`type2Icon

type2Icon: Sprite

`Readonly`wordWrapWidth

wordWrapWidth: number = 1780

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-ui-handler.ts:2402

clear

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

clearText

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

closeFormTray

closeFormTray(): boolean
Returns boolean
- Defined in src/ui/handlers/pokedex-ui-handler.ts:2024

destroy

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

Returns void
Overrides MessageUiHandler.destroy
- Defined in src/ui/handlers/pokedex-ui-handler.ts:2374

`Private`getCurrentDexProps

getCurrentDexProps(speciesId: SpeciesId): DexAttrProps
Creates a temporary dex attr props that will be used to display the correct shiny, variant, and form based on this.starterPreferences
Parameters
- speciesId: SpeciesId
  The id of the species to get props for
Returns DexAttrProps
the dex props
- Defined in src/ui/handlers/pokedex-ui-handler.ts:2350

getCursor

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

getFriendship

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

getSanitizedProps

getSanitizedProps(props: DexAttrProps): DexAttrProps
Parameters
- props: DexAttrProps
Returns DexAttrProps
- Defined in src/ui/handlers/pokedex-ui-handler.ts:1332

getUi

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

hasFormLevelMove

hasFormLevelMove(form: PokemonForm, selectedMove: string): boolean
Parameters
- form: PokemonForm
- selectedMove: string
Returns boolean
- Defined in src/ui/handlers/pokedex-ui-handler.ts:1343

hideNameText

hideNameText(): void
Returns void
Inherited from MessageUiHandler.hideNameText
- Defined in src/ui/handlers/message-ui-handler.ts:332

initNameBox

initNameBox(container: Container, x?: number, y?: number): void
Add the name box shown by showDialogue to the given message container.
Parameters
- container: Container
  The container holding the message text
- x: number = 0
  The x position of the name box
- y: number = -16
  The y position of the name box
Returns void

Remarks
If this method is not called, the name box will not be displayed.
Inherited from MessageUiHandler.initNameBox
- Defined in src/ui/handlers/message-ui-handler.ts:37

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:60

initStarterPrefs

initStarterPrefs(species: PokemonSpecies): StarterPreferences
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
Parameters
- species: PokemonSpecies
  The species to get Starter Preferences for
Returns StarterPreferences
StarterPreferences for the species
- Defined in src/ui/handlers/pokedex-ui-handler.ts:717

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:32

isEncountered

isEncountered(
    _species: PokemonSpecies,
    dexEntry: DexEntry,
    _seenFilter?: boolean,
): boolean
Parameters
- _species: PokemonSpecies
- dexEntry: DexEntry
- Optional_seenFilter: boolean
Returns boolean
- Defined in src/ui/handlers/pokedex-ui-handler.ts:851

isSeen

isSeen(
    species: PokemonSpecies,
    dexEntry: DexEntry,
    seenFilter?: boolean,
): boolean
Parameters
- species: PokemonSpecies
- dexEntry: DexEntry
- OptionalseenFilter: boolean
Returns boolean
- Defined in src/ui/handlers/pokedex-ui-handler.ts:840

isTextAnimationInProgress

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

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-ui-handler.ts:869

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-ui-handler.ts:859

openFormTray

openFormTray(species: PokemonSpecies): boolean
Parameters
- species: PokemonSpecies
Returns boolean
- Defined in src/ui/handlers/pokedex-ui-handler.ts:1962

processInput

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

processTutorialInput

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

resetFilters

resetFilters(): void
Set the selections for all filters to their default starting value

Returns void
- Defined in src/ui/handlers/pokedex-ui-handler.ts:807

setCursor

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

setFilterMode

setFilterMode(filterMode: boolean): boolean
Parameters
- filterMode: boolean
Returns boolean
- Defined in src/ui/handlers/pokedex-ui-handler.ts:1926

setFilterTextMode

setFilterTextMode(filterTextMode: boolean): boolean
Parameters
- filterTextMode: boolean
Returns boolean
- Defined in src/ui/handlers/pokedex-ui-handler.ts:1944

`Protected`setMouseCursorStyle

setMouseCursorStyle(cursorStyle: "default" | "pointer"): void
Changes the style of the mouse cursor.
Parameters
- cursorStyle: "default" | "pointer"
  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:43

setSpecies

setSpecies(species: PokemonSpecies | null): void
Parameters
- species: PokemonSpecies | null
Returns void
- Defined in src/ui/handlers/pokedex-ui-handler.ts:2094

setSpeciesDetails

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

setTrayCursor

setTrayCursor(cursor: number): boolean
Parameters
- cursor: number
Returns boolean
- Defined in src/ui/handlers/pokedex-ui-handler.ts:2037

setTypeIcons

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

setup

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

setUpgradeAnimation

setUpgradeAnimation(
    icon: Sprite,
    species: PokemonSpecies,
    startPaused?: boolean,
): void
Sets a bounce animation if enabled and the Pokemon has an upgrade
Parameters
- icon: Sprite
  Phaser.GameObjects.GameObject to animate
- species: PokemonSpecies
  PokemonSpecies of the icon used to check for upgrades
- startPaused: boolean = false
  Should this animation be paused after it is added?
Returns void
- Defined in src/ui/handlers/pokedex-ui-handler.ts:882

setUpgradeIcon

setUpgradeIcon(starter: PokedexMonContainer): void
Sets the visibility of a Candy Upgrade Icon
Parameters
- starter: PokedexMonContainer
Returns void
- Defined in src/ui/handlers/pokedex-ui-handler.ts:935

show

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

showDialogue

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

showNameText

showNameText(name: string, iconFrame?: string): void
Show a name above the text.
Parameters
- name: string
  The name to show
- OptionaliconFrame: string
  The frame of the icon to display next to the name
Returns void

Remarks
the icon must be from the items atlas
Inherited from MessageUiHandler.showNameText
- Defined in src/ui/handlers/message-ui-handler.ts:311

showPrompt

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

showText

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

startIconAnimation

startIconAnimation(cursor: number): void
Parameters
- cursor: number
Returns void
- Defined in src/ui/handlers/pokedex-ui-handler.ts:2069

stopIconAnimation

stopIconAnimation(cursor: number): void
Parameters
- cursor: number
Returns void
- Defined in src/ui/handlers/pokedex-ui-handler.ts:2082

tryExit

tryExit(): boolean
Returns boolean
- Defined in src/ui/handlers/pokedex-ui-handler.ts:2318

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-ui-handler.ts:1288

updateCandyUpgradeDisplay

updateCandyUpgradeDisplay(pokemonContainer: PokedexMonContainer): void
Update the display of candy upgrade icons or animations for the given PokedexMonContainer
Parameters
- pokemonContainer: PokedexMonContainer
  the container for the Pokemon to update
Returns void
- Defined in src/ui/handlers/pokedex-ui-handler.ts:968

updateFilterButtonIcon

updateFilterButtonIcon(
    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-ui-handler.ts:1316

updateScroll

updateScroll(): void
Returns void
- Defined in src/ui/handlers/pokedex-ui-handler.ts:1764

updateStarters

updateStarters(): void
Returns void
- Defined in src/ui/handlers/pokedex-ui-handler.ts:1348

updateStarterValueLabel

updateStarterValueLabel(starter: PokedexMonContainer): void
Parameters
- starter: PokedexMonContainer
Returns void
- Defined in src/ui/handlers/pokedex-ui-handler.ts:2289

Class PokedexUiHandler

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Returns PokedexUiHandler

Properties

active

PrivateassetLoadCancelled

ProtectedawaitingActionInput

ProtectedblockInput

PrivateblockOpenPage

PrivatecanShowFormTray

Protectedcursor

cursorObj

Private OptionalexitCallback

PrivatefilterBar

PrivatefilterBarContainer

PrivatefilterBarCursor

PrivatefilteredIndices

PrivatefilteredPokemonData

PrivatefilterMode

PrivatefilterText

PrivatefilterTextContainer

PrivatefilterTextCursor

PrivatefilterTextMode

PrivateformTrayContainer

PrivategameData

PrivategoFilterIconElement1

PrivategoFilterIconElement2

PrivategoFilterLabel

PrivateiconAnimHandler

PrivatelastSpecies

message

OptionalnameBoxContainer

Remarks

PrivateoldCursor

ProtectedonActionInput

ProtectedoptionSelectText

pendingPrompt

PrivatepokemonContainers

PrivatepokemonFormText

PrivatepokemonNameText

PrivatepokemonNumberText

PrivatepokemonSprite

PrivatepokerusCursorObjs

PrivatepokerusSpecies

prompt

Protectedscale

PrivatescrollCursor

PrivateshowDecorations

PrivateshowFormTrayIconElement

PrivateshowFormTrayLabel

PrivateshowingTray

Private ReadonlyspeciesLoaded

PrivatespeciesStarterDexEntry

PrivatestarterPreferences

PrivatestarterSelectContainer

PrivatestarterSelectMessageBox

PrivatestarterSelectMessageBoxContainer

PrivatestarterSelectScrollBar

ProtectedtextCallbackTimer

ProtectedtextTimer

PrivatetoggleDecorationsIconElement

PrivatetoggleDecorationsLabel

PrivatetrayBg

PrivatetrayColumns

PrivatetrayContainers

PrivatetrayCursor

PrivatetrayCursorObj

PrivatetrayForms

PrivatetrayNumIcons

PrivatetrayRows

tutorialActive

tutorialOverlay

Privatetype1Icon

Privatetype2Icon

`Private`assetLoadCancelled

`Protected`awaitingActionInput

`Protected`blockInput

`Private`blockOpenPage

`Private`canShowFormTray

`Protected`cursor

`Private` `Optional`exitCallback

`Private`filterBar

`Private`filterBarContainer

`Private`filterBarCursor

`Private`filteredIndices

`Private`filteredPokemonData

`Private`filterMode

`Private`filterText

`Private`filterTextContainer

`Private`filterTextCursor

`Private`filterTextMode

`Private`formTrayContainer

`Private`gameData

`Private`goFilterIconElement1

`Private`goFilterIconElement2

`Private`goFilterLabel

`Private`iconAnimHandler

`Private`lastSpecies

`Optional`nameBoxContainer

`Private`oldCursor

`Protected`onActionInput

`Protected`optionSelectText

`Private`pokemonContainers

`Private`pokemonFormText

`Private`pokemonNameText

`Private`pokemonNumberText

`Private`pokemonSprite

`Private`pokerusCursorObjs

`Private`pokerusSpecies

`Protected`scale

`Private`scrollCursor

`Private`showDecorations

`Private`showFormTrayIconElement

`Private`showFormTrayLabel

`Private`showingTray

`Private` `Readonly`speciesLoaded

`Private`speciesStarterDexEntry

`Private`starterPreferences

`Private`starterSelectContainer

`Private`starterSelectMessageBox

`Private`starterSelectMessageBoxContainer

`Private`starterSelectScrollBar

`Protected`textCallbackTimer

`Protected`textTimer

`Private`toggleDecorationsIconElement

`Private`toggleDecorationsLabel

`Private`trayBg

`Private`trayColumns

`Private`trayContainers

`Private`trayCursor

`Private`trayCursorObj

`Private`trayForms

`Private`trayNumIcons

`Private`trayRows

`Private`type1Icon

`Private`type2Icon

`Readonly`wordWrapWidth

`Private`getCurrentDexProps