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 blockInput cursor cursorObj manageDataConfig 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-ui-handler.ts:219

Properties

active

active: boolean = false

`Protected`awaitingActionInput

awaitingActionInput: boolean

`Protected`blockInput

blockInput: boolean = false

`Protected`cursor

cursor: number = 0

cursorObj

cursorObj: Image

`Protected`manageDataConfig

manageDataConfig: OptionSelectConfig

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

clear

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

clearText

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

closeFormTray

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

destroy

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

Returns void
Overrides default.destroy
- Defined in src/ui/pokedex-ui-handler.ts:2112

getCurrentDexProps

getCurrentDexProps(speciesId): 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/pokedex-ui-handler.ts:2065

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

getSanitizedProps

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

getStarterSpeciesId

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

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

hasFormLevelMove

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

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

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

isPassiveAvailable

isPassiveAvailable(speciesId): 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/pokedex-ui-handler.ts:733

isSameSpeciesEggAvailable

isSameSpeciesEggAvailable(speciesId): 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/pokedex-ui-handler.ts:759

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

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

isValueReductionAvailable

isValueReductionAvailable(speciesId): 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/pokedex-ui-handler.ts:746

openFormTray

openFormTray(species): boolean
Parameters
- species: default
Returns boolean
- Defined in src/ui/pokedex-ui-handler.ts:1702

processInput

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

processTutorialInput

processTutorialInput(button): boolean
Parameters
- button: Button
Returns boolean
Inherited from default.processTutorialInput
- Defined in src/ui/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/pokedex-ui-handler.ts:680

setCursor

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

setFilterMode

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

setFilterTextMode

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

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

setSpeciesDetails

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

setTrayCursor

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

setTypeIcons

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

setUpgradeAnimation

setUpgradeAnimation(icon, species, startPaused?): void
Sets a bounce animation if enabled and the Pokemon has an upgrade
Parameters
- icon: Sprite
  Phaser.GameObjects.GameObject to animate
- species: default
  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/pokedex-ui-handler.ts:772

setUpgradeIcon

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

setup

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

show

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

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

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

tryExit

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

updateButtonIcon

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

updateCandyUpgradeDisplay

updateCandyUpgradeDisplay(pokemonContainer): 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/pokedex-ui-handler.ts:855

updateFilterButtonIcon

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

updateScroll

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

updateStarterValueLabel

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

updateStarters

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

Class default

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Returns default

Properties

active

ProtectedawaitingActionInput

ProtectedblockInput

Protectedcursor

cursorObj

ProtectedmanageDataConfig

message

Protectedmode

ProtectedonActionInput

ProtectedoptionSelectText

pendingPrompt

prompt

Protectedscale

ProtectedtextCallbackTimer

ProtectedtextTimer

tutorialActive

tutorialOverlay

Methods

checkIconId

Parameters

Returns void

clear

Returns void

clearText

Returns void

closeFormTray

Returns boolean

destroy

Returns void

getCurrentDexProps

Parameters

Returns bigint

getCursor

Returns number

getFriendship

Parameters

Returns { currentFriendship: number; friendshipCap: number; }

currentFriendship: number

friendshipCap: number

getSanitizedProps

Parameters

Returns DexAttrProps

getStarterSpeciesId

Parameters

Returns number

getTextColor

Parameters

Returns string

getUi

Returns default

hasFormLevelMove

Parameters

Returns boolean

initPromptSprite

Parameters

Returns void

initStarterPrefs

Parameters

Returns StarterAttributes

initTutorialOverlay

Parameters

Returns void

isPassiveAvailable

Parameters

Returns boolean

isSameSpeciesEggAvailable

Parameters

Returns boolean

isTextAnimationInProgress

Returns boolean

`Protected`awaitingActionInput

`Protected`blockInput

`Protected`cursor

`Protected`manageDataConfig

`Protected`mode

`Protected`onActionInput

`Protected`optionSelectText

`Protected`scale

`Protected`textCallbackTimer

`Protected`textTimer

Returns {
currentFriendship: number;
friendshipCap: number;
}

`Protected`setMouseCursorStyle