Class default

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

Hierarchy (view full)

default
- default

Index

Constructors

Properties

active awaitingActionInput bgmBar 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:250

Properties

active

active: boolean = false

`Protected`awaitingActionInput

awaitingActionInput: boolean

bgmBar

bgmBar: default

`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: Text

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, species, female, formIndex, shiny, variant): 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:2438

clear

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

clearText

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

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): 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:2327

getCursor

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

getFriendship

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

getStarterSpecies

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

getStarterSpeciesId

getStarterSpeciesId(speciesId): 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:877

getTextColor

getTextColor(style, shadow?): 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

getValueLimit

getValueLimit(): number
Returns number
- Defined in src/ui/pokedex-page-ui-handler.ts:1868

hideInstructions

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

initPromptSprite

initPromptSprite(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:784

initTutorialOverlay

initTutorialOverlay(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?): bigint
Parameters
- OptionalotherSpecies: default
Returns bigint
- Defined in src/ui/pokedex-page-ui-handler.ts:744

isFormCaught

isFormCaught(otherSpecies?, otherFormIndex?): 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:763

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

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

isTextAnimationInProgress

isTextAnimationInProgress(): boolean
Returns boolean
Inherited from default.isTextAnimationInProgress
- Defined in src/ui/message-ui-handler.ts:226

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

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

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

processInput

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

processTutorialInput

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

sanitizeBiomes

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

setCursor

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

`Protected`setMouseCursorStyle

setMouseCursorStyle(cursorStyle): 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:1956

setSpeciesDetails

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

setTypeIcons

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

setup

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

show

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

showDialogue

showDialogue(text, name?, delay?, callback?, callbackDelay?, prompt?, promptDelay?): void
Parameters
- text: string
- Optionalname: 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:41

showPrompt

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

showStats

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

showText

showText(text, delay?, callback?, callbackDelay?, prompt?, promptDelay?, moveToTop?): 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:837

starterSetup

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

toggleStatsMode

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

updateButtonIcon

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

updateInstructions

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

Class default

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Returns default

Properties

active

ProtectedawaitingActionInput

bgmBar

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; }

currentFriendship: number

friendshipCap: number

getStarterSpecies

Parameters

Returns default

getStarterSpeciesId

Parameters

Returns number

getTextColor

Parameters

Returns string

getUi

Returns default

getValueLimit

Returns number

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

`Protected`awaitingActionInput

`Protected`blockInput

`Protected`blockInputOverlay

`Protected`cursor

`Protected`mode

`Protected`onActionInput

`Protected`optionSelectText

`Protected`scale

`Protected`textCallbackTimer

`Protected`textTimer

Returns {
currentFriendship: number;
friendshipCap: number;
}

`Protected`setMouseCursorStyle