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 defaultMessageBoxWidth defaultWordWrapWidth dialogueMessageBox exitCallback? filterBar filterBarContainer filterBarCursor filteredIndices filteredPokemonData filterMode filterText filterTextContainer filterTextCursor filterTextMode filterTextOptions formTrayContainer gameData goFilterIconElement1 goFilterIconElement2 goFilterLabel iconAnimHandler lastSpecies manageDataConfig menuBg menuMessageBox menuMessageBoxContainer message mode 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 textPadding textTimer toggleDecorationsIconElement toggleDecorationsLabel trayBg trayColumns trayContainers trayCursor trayCursorObj trayForms trayNumIcons trayRows tutorialActive tutorialOverlay type1Icon type2Icon

Constructors

constructor

new PokedexUiHandler(): PokedexUiHandler
Returns PokedexUiHandler
Overrides MessageUiHandler.constructor
- Defined in src/ui/handlers/pokedex-ui-handler.ts:245

Properties

active

active: boolean = false

`Private`assetLoadCancelled

assetLoadCancelled: null | BooleanHolder

`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` `Readonly`defaultMessageBoxWidth

defaultMessageBoxWidth: 220

`Private` `Readonly`defaultWordWrapWidth

defaultWordWrapWidth: 1224

`Private`dialogueMessageBox

dialogueMessageBox: NineSlice

`Private` `Optional`exitCallback

exitCallback?: AnyFn

`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`filterTextOptions

filterTextOptions: FilterTextOptions[]

`Private`formTrayContainer

formTrayContainer: Container

`Private`gameData

gameData: GameData

`Private`goFilterIconElement1

goFilterIconElement1: Sprite

`Private`goFilterIconElement2

goFilterIconElement2: Sprite

`Private`goFilterLabel

goFilterLabel: Text

`Private`menuBg

menuBg: NineSlice

`Private`menuMessageBox

menuMessageBox: NineSlice

`Private`menuMessageBoxContainer

menuMessageBoxContainer: Container

message

message: Text

`Protected`mode

mode: null | number

`Private`oldCursor

oldCursor: number = -1

`Protected`onActionInput

onActionInput: null | Function

`Protected`optionSelectText

optionSelectText: Text

pendingPrompt

pendingPrompt: boolean

`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: PokemonSpecies[] = []

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`speciesLoaded

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

`Private`speciesStarterDexEntry

speciesStarterDexEntry: null | DexEntry

`Private`starterPreferences

starterPreferences: StarterPreferences

`Private`starterSelectContainer

starterSelectContainer: Container

`Private`starterSelectMessageBox

starterSelectMessageBox: NineSlice

`Private`starterSelectMessageBoxContainer

starterSelectMessageBoxContainer: Container

`Private`starterSelectScrollBar

starterSelectScrollBar: ScrollBar

`Protected`textCallbackTimer

textCallbackTimer: null | TimerEvent

`Private` `Readonly`textPadding

textPadding: 8

`Protected`textTimer

textTimer: null | TimerEvent

`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

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

clear

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

clearText

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

closeFormTray

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

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

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 the StarterPreferences
Parameters
- speciesId: number
  the id of the species to get props for
Returns bigint
the dex props
- Defined in src/ui/handlers/pokedex-ui-handler.ts:2374

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

getSanitizedProps

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

getStarterSpeciesId

getStarterSpeciesId(speciesId: any): number
Parameters
- speciesId: any
Returns number
- Defined in src/ui/handlers/pokedex-ui-handler.ts:851

getUi

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

hasFormLevelMove

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

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

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

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

isPassiveAvailable

isPassiveAvailable(speciesId: number): boolean
Determines if a passive upgrade is available for the given species ID
Parameters
- speciesId: number
  The ID of the species to check the passive of
Returns boolean
true if the user has enough candies and a passive has not been unlocked already
- Defined in src/ui/handlers/pokedex-ui-handler.ts:863

isSameSpeciesEggAvailable

isSameSpeciesEggAvailable(speciesId: number): boolean
Determines if an same species egg can be bought for the given species ID
Parameters
- speciesId: number
  The ID of the species to check the value reduction of
Returns boolean
true if the user has enough candies
- Defined in src/ui/handlers/pokedex-ui-handler.ts:895

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

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

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

isValueReductionAvailable

isValueReductionAvailable(speciesId: number): boolean
Determines if a value reduction upgrade is available for the given species ID
Parameters
- speciesId: number
  The ID of the species to check the value reduction of
Returns boolean
true if the user has enough candies and all value reductions have not been unlocked already
- Defined in src/ui/handlers/pokedex-ui-handler.ts:878

openFormTray

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

processInput

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

processTutorialInput

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

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

setCursor

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

setFilterMode

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

setFilterTextMode

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

`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(species: null | PokemonSpecies): void
Parameters
- species: null | PokemonSpecies
Returns void
- Defined in src/ui/handlers/pokedex-ui-handler.ts:2124

setSpeciesDetails

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

setTrayCursor

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

setTypeIcons

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

setup

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

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

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

show

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

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

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

startIconAnimation

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

stopIconAnimation

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

tryExit

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

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

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

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

updateScroll

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

updateStarters

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

updateStarterValueLabel

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

Class PokedexUiHandler

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Returns PokedexUiHandler

Properties

active

PrivateassetLoadCancelled

ProtectedawaitingActionInput

ProtectedblockInput

PrivateblockOpenPage

PrivatecanShowFormTray

Protectedcursor

cursorObj

Private ReadonlydefaultMessageBoxWidth

Private ReadonlydefaultWordWrapWidth

PrivatedialogueMessageBox

Private OptionalexitCallback

PrivatefilterBar

PrivatefilterBarContainer

PrivatefilterBarCursor

PrivatefilteredIndices

PrivatefilteredPokemonData

PrivatefilterMode

PrivatefilterText

PrivatefilterTextContainer

PrivatefilterTextCursor

PrivatefilterTextMode

PrivatefilterTextOptions

PrivateformTrayContainer

PrivategameData

PrivategoFilterIconElement1

PrivategoFilterIconElement2

PrivategoFilterLabel

PrivateiconAnimHandler

PrivatelastSpecies

ProtectedmanageDataConfig

PrivatemenuBg

PrivatemenuMessageBox

PrivatemenuMessageBoxContainer

message

Protectedmode

PrivateoldCursor

ProtectedonActionInput

ProtectedoptionSelectText

pendingPrompt

PrivatepokemonContainers

PrivatepokemonFormText

PrivatepokemonNameText

PrivatepokemonNumberText

PrivatepokemonSprite

PrivatepokerusCursorObjs

PrivatepokerusSpecies

prompt

Protectedscale

PrivatescrollCursor

PrivateshowDecorations

PrivateshowFormTrayIconElement

PrivateshowFormTrayLabel

PrivateshowingTray

PrivatespeciesLoaded

PrivatespeciesStarterDexEntry

PrivatestarterPreferences

PrivatestarterSelectContainer

PrivatestarterSelectMessageBox

PrivatestarterSelectMessageBoxContainer

PrivatestarterSelectScrollBar

ProtectedtextCallbackTimer

Private ReadonlytextPadding

ProtectedtextTimer

PrivatetoggleDecorationsIconElement

PrivatetoggleDecorationsLabel

PrivatetrayBg

PrivatetrayColumns

PrivatetrayContainers

PrivatetrayCursor

`Private`assetLoadCancelled

`Protected`awaitingActionInput

`Protected`blockInput

`Private`blockOpenPage

`Private`canShowFormTray

`Protected`cursor

`Private` `Readonly`defaultMessageBoxWidth

`Private` `Readonly`defaultWordWrapWidth

`Private`dialogueMessageBox

`Private` `Optional`exitCallback

`Private`filterBar

`Private`filterBarContainer

`Private`filterBarCursor

`Private`filteredIndices

`Private`filteredPokemonData

`Private`filterMode

`Private`filterText

`Private`filterTextContainer

`Private`filterTextCursor

`Private`filterTextMode

`Private`filterTextOptions

`Private`formTrayContainer

`Private`gameData

`Private`goFilterIconElement1

`Private`goFilterIconElement2

`Private`goFilterLabel

`Private`iconAnimHandler

`Private`lastSpecies

`Protected`manageDataConfig

`Private`menuBg

`Private`menuMessageBox

`Private`menuMessageBoxContainer

`Protected`mode

`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`speciesLoaded

`Private`speciesStarterDexEntry

`Private`starterPreferences

`Private`starterSelectContainer

`Private`starterSelectMessageBox

`Private`starterSelectMessageBoxContainer

`Private`starterSelectScrollBar

`Protected`textCallbackTimer

`Private` `Readonly`textPadding

`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