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 cursor cursorObj message mode onActionInput pendingPrompt prompt starterSpecies textCallbackTimer textTimer tutorialActive tutorialOverlay

Methods

addToParty checkIconId clear clearStarterPreferences clearText destroy getCurrentDexProps getCursor getFriendship getTextColor getUi getValueLimit hideInstructions initPromptSprite initStarterPrefs initTutorialOverlay isInParty isPartyValid isPassiveAvailable isSameSpeciesEggAvailable isTextAnimationInProgress isUpgradeAnimationEnabled isUpgradeIconEnabled isValueReductionAvailable moveStarterIconsCursor onCandyUpgradeDisplayChanged popStarter processInput processTutorialInput resetCaughtDropdown resetFilters setCursor setFilterMode setMouseCursorStyle setSpecies setSpeciesDetails setTypeIcons setup setUpgradeAnimation setUpgradeIcon show showDialogue showPrompt showStats showText switchMoveHandler toggleStatsMode tryExit tryStart tryUpdateValue updateButtonIcon updateCandyUpgradeDisplay updateFilterButtonIcon updateInstructions updatePartyIcon updateScroll updateStarters updateStarterValueLabel

Constructors

constructor

new default(): default
Returns default
Overrides default.constructor
- Defined in src/ui/starter-select-ui-handler.ts:378

Properties

active

active: boolean = false

`Protected`awaitingActionInput

awaitingActionInput: boolean

`Protected`blockInput

blockInput: boolean = false

`Protected`cursor

cursor: number = 0

cursorObj

cursorObj: Image

message

message: Text

`Protected`mode

mode: null | number

`Protected`onActionInput

onActionInput: null | Function

pendingPrompt

pendingPrompt: boolean

prompt

prompt: Sprite

starterSpecies

starterSpecies: default[] = []

`Protected`textCallbackTimer

textCallbackTimer: null | TimerEvent

`Protected`textTimer

textTimer: null | TimerEvent

tutorialActive

tutorialActive: boolean = false

tutorialOverlay

tutorialOverlay: Rectangle

Methods

addToParty

addToParty(
    species: default,
    dexAttr: bigint,
    abilityIndex: number,
    nature: Nature,
    moveset: StarterMoveset,
    teraType: PokemonType,
    randomSelection?: boolean,
): void
Parameters
- species: default
- dexAttr: bigint
- abilityIndex: number
- nature: Nature
- moveset: StarterMoveset
- teraType: PokemonType
- randomSelection: boolean = false
Returns void
- Defined in src/ui/starter-select-ui-handler.ts:2705

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/starter-select-ui-handler.ts:4544

clear

clear(): void
Returns void
Overrides default.clear
- Defined in src/ui/starter-select-ui-handler.ts:4523

clearStarterPreferences

clearStarterPreferences(): void
Clears this UI's starter preferences.

Designed to be used for unit tests that utilize this UI.

Returns void
- Defined in src/ui/starter-select-ui-handler.ts:4566

clearText

clearText(): void
Returns void
Overrides default.clearText
- Defined in src/ui/starter-select-ui-handler.ts:4501

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/starter-select-ui-handler.ts:3258

getCurrentDexProps

getCurrentDexProps(speciesId: number): bigint
Creates a temporary dex attr props that will be used to check whether a pokemon is valid for a challenge and 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/starter-select-ui-handler.ts:4407

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/starter-select-ui-handler.ts:3419

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

getValueLimit

getValueLimit(): number
Returns number
- Defined in src/ui/starter-select-ui-handler.ts:2952

hideInstructions

hideInstructions(): void
Returns void
- Defined in src/ui/starter-select-ui-handler.ts:4506

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(species: default): 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/starter-select-ui-handler.ts:1234

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

isInParty

isInParty(species: default): [boolean, number]
Parameters
- species: default
Returns [boolean, number]
- Defined in src/ui/starter-select-ui-handler.ts:2692

isPartyValid

isPartyValid(): boolean
Returns boolean
- Defined in src/ui/starter-select-ui-handler.ts:4386

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/starter-select-ui-handler.ts:1393

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/starter-select-ui-handler.ts:1424

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/starter-select-ui-handler.ts:1384

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/starter-select-ui-handler.ts:1377

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/starter-select-ui-handler.ts:1408

moveStarterIconsCursor

moveStarterIconsCursor(index: number): void
Parameters
- index: number
Returns void
- Defined in src/ui/starter-select-ui-handler.ts:3407

onCandyUpgradeDisplayChanged

onCandyUpgradeDisplayChanged(event: Event): void
Processes an CandyUpgradeNotificationChangedEvent sent when the corresponding setting changes
Parameters
- event: Event
  Event sent by the callback
Returns void
- Defined in src/ui/starter-select-ui-handler.ts:1539

popStarter

popStarter(index: number): void
Parameters
- index: number
Returns void
- Defined in src/ui/starter-select-ui-handler.ts:4107

processInput

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

processTutorialInput

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

resetCaughtDropdown

resetCaughtDropdown(): void
Set default value for the caught dropdown, which only shows caught mons

Returns void
- Defined in src/ui/starter-select-ui-handler.ts:1331

resetFilters

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

Returns void
- Defined in src/ui/starter-select-ui-handler.ts:1323

setCursor

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

setFilterMode

setFilterMode(filterMode: boolean): boolean
Parameters
- filterMode: boolean
Returns boolean
- Defined in src/ui/starter-select-ui-handler.ts:3389

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

setSpeciesDetails

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

setTypeIcons

setTypeIcons(type1: null | PokemonType, type2: null | PokemonType): void
Parameters
- type1: null | PokemonType
- type2: null | PokemonType
Returns void
- Defined in src/ui/starter-select-ui-handler.ts:4092

setup

setup(): void
Returns void
Overrides default.setup
- Defined in src/ui/starter-select-ui-handler.ts:382

setUpgradeAnimation

setUpgradeAnimation(icon: Sprite, species: default, startPaused?: boolean): 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/starter-select-ui-handler.ts:1437

setUpgradeIcon

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

show

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

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/starter-select-ui-handler.ts:4491

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/starter-select-ui-handler.ts:1345

switchMoveHandler

switchMoveHandler(i: number, newMove: Moves, move: Moves): void
Parameters
- i: number
- newMove: Moves
- move: Moves
Returns void
- Defined in src/ui/starter-select-ui-handler.ts:2749

toggleStatsMode

toggleStatsMode(on?: boolean): void
Parameters
- Optionalon: boolean
Returns void
- Defined in src/ui/starter-select-ui-handler.ts:4460

tryExit

tryExit(): boolean
Returns boolean
- Defined in src/ui/starter-select-ui-handler.ts:4280

tryStart

tryStart(manualTrigger?: boolean): boolean
Parameters
- manualTrigger: boolean = false
Returns boolean
- Defined in src/ui/starter-select-ui-handler.ts:4314

tryUpdateValue

tryUpdateValue(add?: number, addingToParty?: boolean): boolean
Parameters
- Optionaladd: number
- OptionaladdingToParty: boolean
Returns boolean
- Defined in src/ui/starter-select-ui-handler.ts:4190

updateButtonIcon

updateButtonIcon(
    iconSetting: SettingKeyboard,
    gamepadType: string,
    iconElement: Sprite,
    controlLabel: Text,
): void
Parameters
- iconSetting: SettingKeyboard
- gamepadType: string
- iconElement: Sprite
- controlLabel: Text
Returns void
- Defined in src/ui/starter-select-ui-handler.ts:2802

updateCandyUpgradeDisplay

updateCandyUpgradeDisplay(starterContainer: StarterContainer): void
Update the display of candy upgrade icons or animations for the given StarterContainer
Parameters
- starterContainer: StarterContainer
  the container for the Pokemon to update
Returns void
- Defined in src/ui/starter-select-ui-handler.ts:1526

updateFilterButtonIcon

updateFilterButtonIcon(
    iconSetting: SettingKeyboard,
    gamepadType: string,
    iconElement: Sprite,
    controlLabel: Text,
): void
Parameters
- iconSetting: SettingKeyboard
- gamepadType: string
- iconElement: Sprite
- controlLabel: Text
Returns void
- Defined in src/ui/starter-select-ui-handler.ts:2856

updateInstructions

updateInstructions(): void
Returns void
- Defined in src/ui/starter-select-ui-handler.ts:2884

updatePartyIcon

updatePartyIcon(species: default, index: number): void
Parameters
- species: default
- index: number
Returns void
- Defined in src/ui/starter-select-ui-handler.ts:2742

updateScroll

updateScroll(): void
Returns void
- Defined in src/ui/starter-select-ui-handler.ts:3263

updateStarters

updateStarters(): void
Returns void
- Defined in src/ui/starter-select-ui-handler.ts:2968

updateStarterValueLabel

updateStarterValueLabel(starter: StarterContainer): void
Parameters
- starter: StarterContainer
Returns void
- Defined in src/ui/starter-select-ui-handler.ts:4161

Class default

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Returns default

Properties

active

ProtectedawaitingActionInput

ProtectedblockInput

Protectedcursor

cursorObj

message

Protectedmode

ProtectedonActionInput

pendingPrompt

prompt

starterSpecies

ProtectedtextCallbackTimer

ProtectedtextTimer

tutorialActive

tutorialOverlay

Methods

addToParty

Parameters

Returns void

checkIconId

Parameters

Returns void

clear

Returns void

clearStarterPreferences

Returns void

clearText

Returns void

destroy

Returns void

getCurrentDexProps

Parameters

Returns bigint

getCursor

Returns number

getFriendship

Parameters

Returns { currentFriendship: number; friendshipCap: number }

getTextColor

Parameters

Returns string

getUi

Returns default

getValueLimit

Returns number

hideInstructions

Returns void

initPromptSprite

Parameters

Returns void

initStarterPrefs

Parameters

Returns StarterAttributes

initTutorialOverlay

Parameters

Returns void

isInParty

Parameters

Returns [boolean, number]

isPartyValid

Returns boolean

isPassiveAvailable

Parameters

Returns boolean

isSameSpeciesEggAvailable

Parameters

Returns boolean

isTextAnimationInProgress

Returns boolean

isUpgradeAnimationEnabled

`Protected`awaitingActionInput

`Protected`blockInput

`Protected`cursor

`Protected`mode

`Protected`onActionInput

`Protected`textCallbackTimer

`Protected`textTimer

`Protected`setMouseCursorStyle