Class default

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

Hierarchy (View Summary)

default
- default

Index

Constructors

Properties

active awaitingActionInput blockInput blockInputOverlay cursor cursorObj message mode onActionInput optionSelectText pendingPrompt prompt scale textCallbackTimer textTimer tutorialActive tutorialOverlay

Constructors

constructor

new default(): default
Returns default
Overrides default.constructor
- Defined in src/ui/pokedex-page-ui-handler.ts:267

Properties

active

active: boolean = false

`Protected`awaitingActionInput

awaitingActionInput: boolean

`Protected`blockInput

blockInput: boolean = false

`Protected`blockInputOverlay

blockInputOverlay: boolean = false

`Protected`cursor

cursor: number = 0

cursorObj

cursorObj: Image

message

message: Text

`Protected`mode

mode: null | number

`Protected`onActionInput

onActionInput: null | Function

`Protected`optionSelectText

optionSelectText: BBCodeText

pendingPrompt

pendingPrompt: boolean

prompt

prompt: Sprite

`Protected`scale

scale: number = 0.1666666667

`Protected`textCallbackTimer

textCallbackTimer: null | TimerEvent

`Protected`textTimer

textTimer: null | TimerEvent

tutorialActive

tutorialActive: boolean = false

tutorialOverlay

tutorialOverlay: Rectangle

Methods

checkIconId

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

clear

clear(): void
Returns void
Overrides default.clear
- Defined in src/ui/pokedex-page-ui-handler.ts:2796

clearText

clearText(): void
Returns void
Overrides default.clearText
- Defined in src/ui/pokedex-page-ui-handler.ts:2778

destroy

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

Returns void
Inherited from default.destroy
- Defined in src/ui/ui-handler.ts:69

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/pokedex-page-ui-handler.ts:2697

getCursor

getCursor(): number
Returns number
Inherited from default.getCursor
- Defined in src/ui/ui-handler.ts:40

getFriendship

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

getMenuText

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

getStarterSpecies

getStarterSpecies(species: any): default
Parameters
- species: any
Returns default
- Defined in src/ui/pokedex-page-ui-handler.ts:1097

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/pokedex-page-ui-handler.ts:1084

getTextColor

getTextColor(style: TextStyle, shadow?: boolean): string
Parameters
- style: TextStyle
- shadow: boolean = false
Returns string
Inherited from default.getTextColor
- Defined in src/ui/ui-handler.ts:36

getUi

getUi(): default
Returns default
Inherited from default.getUi
- Defined in src/ui/ui-handler.ts:32

hideInstructions

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

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 default.initPromptSprite
- Defined in src/ui/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/pokedex-page-ui-handler.ts:976

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 default.initTutorialOverlay
- Defined in src/ui/awaitable-ui-handler.ts:33

isCaught

isCaught(otherSpecies?: default): bigint
Parameters
- OptionalotherSpecies: default
Returns bigint
- Defined in src/ui/pokedex-page-ui-handler.ts:924

isFormCaught

isFormCaught(otherSpecies?: default, 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: default
  The species to check; defaults to current species
- OptionalotherFormIndex: number
  The form index of the form to check; defaults to current form
Returns boolean
StarterAttributes for the species
- Defined in src/ui/pokedex-page-ui-handler.ts:944

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/pokedex-page-ui-handler.ts:2257

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/pokedex-page-ui-handler.ts:2286

isSeen

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

isTextAnimationInProgress

isTextAnimationInProgress(): boolean
Returns boolean
Inherited from default.isTextAnimationInProgress
- Defined in src/ui/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/pokedex-page-ui-handler.ts:1075

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/pokedex-page-ui-handler.ts:1068

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/pokedex-page-ui-handler.ts:2271

processInput

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

processTutorialInput

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

sanitizeBiomes

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

setCursor

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

`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 default.setMouseCursorStyle
- Defined in src/ui/ui-handler.ts:58

setSpecies

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

setSpeciesDetails

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

setTypeIcons

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

setup

setup(): void
Returns void
Overrides default.setup
- Defined in src/ui/pokedex-page-ui-handler.ts:271

show

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

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 default.showDialogue
- Defined in src/ui/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 default.showPrompt
- Defined in src/ui/message-ui-handler.ts:222

showStats

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

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 default.showText
- Defined in src/ui/pokedex-page-ui-handler.ts:1036

starterSetup

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

toggleStatsMode

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

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/pokedex-page-ui-handler.ts:2119

updateInstructions

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

Class default

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Returns default

Properties

active

ProtectedawaitingActionInput

ProtectedblockInput

ProtectedblockInputOverlay

Protectedcursor

cursorObj

message

Protectedmode

ProtectedonActionInput

ProtectedoptionSelectText

pendingPrompt

prompt

Protectedscale

ProtectedtextCallbackTimer

ProtectedtextTimer

tutorialActive

tutorialOverlay

Methods

checkIconId

Parameters

Returns void

clear

Returns void

clearText

Returns void

destroy

Returns void

getCurrentDexProps

Parameters

Returns bigint

getCursor

Returns number

getFriendship

Parameters

Returns { currentFriendship: number; friendshipCap: number }

getMenuText

Returns string

getStarterSpecies

Parameters

Returns default

getStarterSpeciesId

Parameters

Returns number

getTextColor

Parameters

Returns string

getUi

Returns default

hideInstructions

Returns void

initPromptSprite

Parameters

Returns void

initStarterPrefs

Returns StarterAttributes

initTutorialOverlay

Parameters

Returns void

isCaught

Parameters

Returns bigint

isFormCaught

Parameters

Returns boolean

isPassiveAvailable

Returns boolean

isSameSpeciesEggAvailable

Returns boolean

isSeen

Returns boolean

`Protected`awaitingActionInput

`Protected`blockInput

`Protected`blockInputOverlay

`Protected`cursor

`Protected`mode

`Protected`onActionInput

`Protected`optionSelectText

`Protected`scale

`Protected`textCallbackTimer

`Protected`textTimer

`Protected`setMouseCursorStyle