Class StarterSelectUiHandler

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

Hierarchy (View Summary)

MessageUiHandler
- StarterSelectUiHandler

Index

Constructors

Properties

abilityCursor abilityIconElement abilityLabel active activeTooltip allowTera allSpecies assetLoadCancelled awaitingActionInput blockInput canCycleAbility canCycleForm canCycleGender canCycleNature canCycleShiny canCycleTera cursor cursorObj dexAttrCursor eggMovesLabel filterBar filterBarContainer filterBarCursor filteredStarterContainers filterInstructionRowX filterInstructionRowY filterInstructionsContainer filterMode formIconElement formLabel genderIconElement genderLabel goFilterIconElement goFilterLabel hasSwappedMoves iconAnimHandler instructionRowTextOffset instructionRowX instructionRowY instructionsContainer lastSpecies message mode moveInfoOverlay natureCursor natureIconElement natureLabel onActionInput originalStarterPreferences pendingPrompt pokemonAbilityLabelText pokemonAbilityText pokemonAdditionalMoveCountLabel pokemonCandyContainer pokemonCandyCountText pokemonCandyDarknessOverlay pokemonCandyIcon pokemonCandyOverlayIcon pokemonCaughtCountText pokemonCaughtHatchedContainer pokemonEggMoveBgs pokemonEggMoveContainers pokemonEggMoveLabels pokemonEggMovesContainer pokemonFormText pokemonGenderText pokemonGrowthRateLabelText pokemonGrowthRateText pokemonHatchedCountText pokemonHatchedIcon pokemonLuckLabelText pokemonLuckText pokemonMoveBgs pokemonMoveContainers pokemonMoveLabels pokemonMovesContainer pokemonNameText pokemonNatureLabelText pokemonNatureText pokemonNumberText pokemonPassiveDisabledIcon pokemonPassiveLabelText pokemonPassiveLockedIcon pokemonPassiveText pokemonShinyIcon pokemonSprite pokemonUncaughtText pokerusCursorObjs pokerusSpecies prompt randomCursorObj scrollCursor shinyIconElement shinyLabel shinyOverlay speciesLoaded speciesStarterDexEntry speciesStarterMoves startCursorObj starterContainers starterCursorObjs starterIcons starterIconsCursorIndex starterIconsCursorObj starterIconsCursorXOffset starterIconsCursorYOffset starterMoveset starterPreferences starters starterSelectCallback starterSelectContainer starterSelectMessageBox starterSelectMessageBoxContainer starterSelectScrollBar starterSpecies statsContainer statsMode teraCursor teraIcon teraIconElement teraLabel textCallbackTimer textTimer tutorialActive tutorialOverlay type1Icon type2Icon validStarterContainers valueLimitLabel

Methods

addToParty checkIconId clear clearStarterPreferences clearText destroy getCurrentDexProps getCursor getFriendship getSpeciesData 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 updateSelectedStarterMoveset updateStarters updateStarterValueLabel

Constructors

constructor

new StarterSelectUiHandler(): StarterSelectUiHandler
Returns StarterSelectUiHandler
Overrides MessageUiHandler.constructor
- Defined in src/ui/handlers/starter-select-ui-handler.ts:403

Properties

`Private`abilityCursor

abilityCursor: number = -1

`Private`abilityIconElement

abilityIconElement: Sprite

`Private`abilityLabel

abilityLabel: Text

active

active: boolean = false

`Private`activeTooltip

activeTooltip: undefined | "ABILITY" | "PASSIVE" | "CANDY"

`Private`allowTera

allowTera: boolean

`Private`allSpecies

allSpecies: PokemonSpecies[] = []

`Private`assetLoadCancelled

assetLoadCancelled: null | BooleanHolder

`Protected`awaitingActionInput

awaitingActionInput: boolean

`Protected`blockInput

blockInput: boolean = false

`Private`canCycleAbility

canCycleAbility: boolean

`Private`canCycleForm

canCycleForm: boolean

`Private`canCycleGender

canCycleGender: boolean

`Private`canCycleNature

canCycleNature: boolean

`Private`canCycleShiny

canCycleShiny: boolean

`Private`canCycleTera

canCycleTera: boolean

`Protected`cursor

cursor: number = 0

cursorObj

cursorObj: Image

`Private`dexAttrCursor

dexAttrCursor: bigint = 0n

`Private`eggMovesLabel

eggMovesLabel: Text

`Private`filterBar

filterBar: FilterBar

`Private`filterBarContainer

filterBarContainer: Container

`Private`filterBarCursor

filterBarCursor: number = 0

`Private`filteredStarterContainers

filteredStarterContainers: StarterContainer[] = []

`Private`filterInstructionRowX

filterInstructionRowX: number = 0

`Private`filterInstructionRowY

filterInstructionRowY: number = 0

`Private`filterInstructionsContainer

filterInstructionsContainer: Container

`Private`filterMode

filterMode: boolean

`Private`formIconElement

formIconElement: Sprite

`Private`formLabel

formLabel: Text

`Private`genderIconElement

genderIconElement: Sprite

`Private`genderLabel

genderLabel: Text

`Private`goFilterIconElement

goFilterIconElement: Sprite

`Private`goFilterLabel

goFilterLabel: Text

`Private`hasSwappedMoves

hasSwappedMoves: boolean = false

Used to check whether any moves were swapped using the reorder menu, to decide whether a save should be performed or not.

`Private`iconAnimHandler

iconAnimHandler: PokemonIconAnimHelper

`Private`instructionRowTextOffset

instructionRowTextOffset: number = 9

`Private`instructionRowX

instructionRowX: number = 0

`Private`instructionRowY

instructionRowY: number = 0

`Private`instructionsContainer

instructionsContainer: Container

`Private`lastSpecies

lastSpecies: PokemonSpecies

message

message: Text

`Protected`mode

mode: null | number

`Private`moveInfoOverlay

moveInfoOverlay: MoveInfoOverlay

`Private`natureCursor

natureCursor: number = -1

`Private`natureIconElement

natureIconElement: Sprite

`Private`natureLabel

natureLabel: Text

`Protected`onActionInput

onActionInput: null | Function

`Private`originalStarterPreferences

originalStarterPreferences: StarterPreferences

pendingPrompt

pendingPrompt: boolean

`Private`pokemonAbilityLabelText

pokemonAbilityLabelText: Text

`Private`pokemonAbilityText

pokemonAbilityText: Text

`Private`pokemonAdditionalMoveCountLabel

pokemonAdditionalMoveCountLabel: Text

`Private`pokemonCandyContainer

pokemonCandyContainer: Container

`Private`pokemonCandyCountText

pokemonCandyCountText: Text

`Private`pokemonCandyDarknessOverlay

pokemonCandyDarknessOverlay: Sprite

`Private`pokemonCandyIcon

pokemonCandyIcon: Sprite

`Private`pokemonCandyOverlayIcon

pokemonCandyOverlayIcon: Sprite

`Private`pokemonCaughtCountText

pokemonCaughtCountText: Text

`Private`pokemonCaughtHatchedContainer

pokemonCaughtHatchedContainer: Container

`Private`pokemonEggMoveBgs

pokemonEggMoveBgs: NineSlice[]

`Private`pokemonEggMoveContainers

pokemonEggMoveContainers: Container[]

`Private`pokemonEggMoveLabels

pokemonEggMoveLabels: Text[]

`Private`pokemonEggMovesContainer

pokemonEggMovesContainer: Container

`Private`pokemonFormText

pokemonFormText: Text

`Private`pokemonGenderText

pokemonGenderText: Text

`Private`pokemonGrowthRateLabelText

pokemonGrowthRateLabelText: Text

`Private`pokemonGrowthRateText

pokemonGrowthRateText: Text

`Private`pokemonHatchedCountText

pokemonHatchedCountText: Text

`Private`pokemonHatchedIcon

pokemonHatchedIcon: Sprite

`Private`pokemonLuckLabelText

pokemonLuckLabelText: Text

`Private`pokemonLuckText

pokemonLuckText: Text

`Private`pokemonMoveBgs

pokemonMoveBgs: NineSlice[]

`Private`pokemonMoveContainers

pokemonMoveContainers: Container[]

`Private`pokemonMoveLabels

pokemonMoveLabels: Text[]

`Private`pokemonMovesContainer

pokemonMovesContainer: Container

`Private`pokemonNameText

pokemonNameText: Text

`Private`pokemonNatureLabelText

pokemonNatureLabelText: Text

`Private`pokemonNatureText

pokemonNatureText: BBCodeText

`Private`pokemonNumberText

pokemonNumberText: Text

`Private`pokemonPassiveDisabledIcon

pokemonPassiveDisabledIcon: Sprite

`Private`pokemonPassiveLabelText

pokemonPassiveLabelText: Text

`Private`pokemonPassiveLockedIcon

pokemonPassiveLockedIcon: Sprite

`Private`pokemonPassiveText

pokemonPassiveText: Text

`Private`pokemonShinyIcon

pokemonShinyIcon: Sprite

`Private`pokemonSprite

pokemonSprite: Sprite

`Private`pokemonUncaughtText

pokemonUncaughtText: Text

`Private`pokerusCursorObjs

pokerusCursorObjs: Image[]

`Private`pokerusSpecies

pokerusSpecies: PokemonSpecies[] = []

prompt

prompt: Sprite

`Private`randomCursorObj

randomCursorObj: NineSlice

`Private`scrollCursor

scrollCursor: number

`Private`shinyIconElement

shinyIconElement: Sprite

`Private`shinyLabel

shinyLabel: Text

`Private`shinyOverlay

shinyOverlay: Image

`Private`speciesLoaded

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

`Private`speciesStarterDexEntry

speciesStarterDexEntry: null | DexEntry

`Private`speciesStarterMoves

speciesStarterMoves: MoveId[]

`Private`startCursorObj

startCursorObj: NineSlice

`Private`starterContainers

starterContainers: StarterContainer[] = []

`Private`starterCursorObjs

starterCursorObjs: Image[]

`Private`starterIcons

starterIcons: Sprite[]

`Private`starterIconsCursorIndex

starterIconsCursorIndex: number

`Private`starterIconsCursorObj

starterIconsCursorObj: Image

`Private`starterIconsCursorXOffset

starterIconsCursorXOffset: number = -3

`Private`starterIconsCursorYOffset

starterIconsCursorYOffset: number = 1

`Private`starterMoveset

starterMoveset: null | StarterMoveset

`Private`starterPreferences

starterPreferences: StarterPreferences

`Private`starters

starters: Starter[] = []

`Private`starterSelectCallback

starterSelectCallback: null | StarterSelectCallback

`Private`starterSelectContainer

starterSelectContainer: Container

`Private`starterSelectMessageBox

starterSelectMessageBox: NineSlice

Group holding the UI elements appearing in the instructionsContainer

`Private`starterSelectMessageBoxContainer

starterSelectMessageBoxContainer: Container

`Private`starterSelectScrollBar

starterSelectScrollBar: ScrollBar

starterSpecies

starterSpecies: PokemonSpecies[] = []

`Private`statsContainer

statsContainer: StatsContainer

`Private`statsMode

statsMode: boolean

`Private`teraCursor

teraCursor: PokemonType = PokemonType.UNKNOWN

`Private`teraIcon

teraIcon: Sprite

`Private`teraIconElement

teraIconElement: Sprite

`Private`teraLabel

teraLabel: Text

`Protected`textCallbackTimer

textCallbackTimer: null | TimerEvent

`Protected`textTimer

textTimer: null | TimerEvent

tutorialActive

tutorialActive: boolean = false

tutorialOverlay

tutorialOverlay: Rectangle

`Private`type1Icon

type1Icon: Sprite

`Private`type2Icon

type2Icon: Sprite

`Private`validStarterContainers

validStarterContainers: StarterContainer[] = []

`Private`valueLimitLabel

valueLimitLabel: Text

Methods

addToParty

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

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

clear

clear(): void
Returns void
Overrides MessageUiHandler.clear
- Defined in src/ui/handlers/starter-select-ui-handler.ts:4623

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

clearText

clearText(): void
Returns void
Overrides MessageUiHandler.clearText
- Defined in src/ui/handlers/starter-select-ui-handler.ts:4599

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

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

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

getSpeciesData

getSpeciesData(
speciesId: SpeciesId,
applyChallenge?: boolean,
): { dexEntry: DexEntry; starterDataEntry: StarterDataEntry }
Parameters
- speciesId: SpeciesId
- applyChallenge: boolean = true
Returns { dexEntry: DexEntry; starterDataEntry: StarterDataEntry }
- Defined in src/ui/handlers/starter-select-ui-handler.ts:3774

getUi

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

getValueLimit

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

hideInstructions

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

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,
    preferences: StarterPreferences,
    ignoreChallenge?: boolean,
): 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
- preferences: StarterPreferences
- ignoreChallenge: boolean = false
Returns StarterAttributes
StarterAttributes for the species
- Defined in src/ui/handlers/starter-select-ui-handler.ts:1206

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

isInParty

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

isPartyValid

isPartyValid(): boolean
This block checks to see if your party is valid It checks each pokemon against the challenge - noting that due to monotype challenges it needs to check the pokemon while ignoring their evolutions/form change items

Returns boolean
- Defined in src/ui/handlers/starter-select-ui-handler.ts:4478

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

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

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

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

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

moveStarterIconsCursor

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

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

popStarter

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

processInput

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

processTutorialInput

processTutorialInput(button: Button): boolean
Parameters
- button: Button
Returns boolean
Inherited from MessageUiHandler.processTutorialInput
- Defined in src/ui/handlers/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/handlers/starter-select-ui-handler.ts:1320

resetFilters

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

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

setCursor

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

setFilterMode

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

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

setSpeciesDetails

setSpeciesDetails(
    species: PokemonSpecies,
    options?: SpeciesDetails,
    save?: boolean,
): void
Parameters
- species: PokemonSpecies
- options: SpeciesDetails = {}
- save: boolean = true
Returns void
- Defined in src/ui/handlers/starter-select-ui-handler.ts:3791

setTypeIcons

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

setup

setup(): void
Returns void
Overrides MessageUiHandler.setup
- Defined in src/ui/handlers/starter-select-ui-handler.ts:407

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

setUpgradeIcon

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

show

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

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

showStats

showStats(): void
Returns void
- Defined in src/ui/handlers/starter-select-ui-handler.ts:4589

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

switchMoveHandler

switchMoveHandler(
    targetIndex: number,
    newMove: MoveId,
    previousMove: MoveId,
): void
Puts a move at the requested index in the current highlighted Pokemon's moveset. If the move was already present in the moveset, swap its position with the one at the requested index.
Parameters
- targetIndex: number
  The index to place the move
- newMove: MoveId
  The move to place in the moveset
- previousMove: MoveId
  The move that was previously in the spot
Returns void
Remarks
⚠️ this.starterMoveset must not be null when this method is called
- Defined in src/ui/handlers/starter-select-ui-handler.ts:2791

toggleStatsMode

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

tryExit

tryExit(): void
Attempt to back out of the starter selection screen into the appropriate parent modal

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

tryStart

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

tryUpdateValue

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

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

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

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

updateInstructions

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

updatePartyIcon

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

updateScroll

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

`Private`updateSelectedStarterMoveset

updateSelectedStarterMoveset(id: SpeciesId): void
Update the starter moveset for the given species if it is part of the selected starters.
Parameters
- id: SpeciesId
  The species ID to update the moveset for
Returns void
Remarks
It is safe to call with a species that is not part of the selected starters.
- Defined in src/ui/handlers/starter-select-ui-handler.ts:2830

updateStarters

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

updateStarterValueLabel

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

Class StarterSelectUiHandler

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Returns StarterSelectUiHandler

Properties

PrivateabilityCursor

PrivateabilityIconElement

PrivateabilityLabel

active

PrivateactiveTooltip

PrivateallowTera

PrivateallSpecies

PrivateassetLoadCancelled

ProtectedawaitingActionInput

ProtectedblockInput

PrivatecanCycleAbility

PrivatecanCycleForm

PrivatecanCycleGender

PrivatecanCycleNature

PrivatecanCycleShiny

PrivatecanCycleTera

Protectedcursor

cursorObj

PrivatedexAttrCursor

PrivateeggMovesLabel

PrivatefilterBar

PrivatefilterBarContainer

PrivatefilterBarCursor

PrivatefilteredStarterContainers

PrivatefilterInstructionRowX

PrivatefilterInstructionRowY

PrivatefilterInstructionsContainer

PrivatefilterMode

PrivateformIconElement

PrivateformLabel

PrivategenderIconElement

PrivategenderLabel

PrivategoFilterIconElement

PrivategoFilterLabel

PrivatehasSwappedMoves

PrivateiconAnimHandler

PrivateinstructionRowTextOffset

PrivateinstructionRowX

PrivateinstructionRowY

PrivateinstructionsContainer

PrivatelastSpecies

message

Protectedmode

PrivatemoveInfoOverlay

PrivatenatureCursor

PrivatenatureIconElement

PrivatenatureLabel

ProtectedonActionInput

PrivateoriginalStarterPreferences

pendingPrompt

PrivatepokemonAbilityLabelText

PrivatepokemonAbilityText

PrivatepokemonAdditionalMoveCountLabel

PrivatepokemonCandyContainer

PrivatepokemonCandyCountText

PrivatepokemonCandyDarknessOverlay

PrivatepokemonCandyIcon

PrivatepokemonCandyOverlayIcon

PrivatepokemonCaughtCountText

PrivatepokemonCaughtHatchedContainer

PrivatepokemonEggMoveBgs

PrivatepokemonEggMoveContainers

PrivatepokemonEggMoveLabels

PrivatepokemonEggMovesContainer

PrivatepokemonFormText

PrivatepokemonGenderText

PrivatepokemonGrowthRateLabelText

PrivatepokemonGrowthRateText

PrivatepokemonHatchedCountText

PrivatepokemonHatchedIcon

`Private`abilityCursor

`Private`abilityIconElement

`Private`abilityLabel

`Private`activeTooltip

`Private`allowTera

`Private`allSpecies

`Private`assetLoadCancelled

`Protected`awaitingActionInput

`Protected`blockInput

`Private`canCycleAbility

`Private`canCycleForm

`Private`canCycleGender

`Private`canCycleNature

`Private`canCycleShiny

`Private`canCycleTera

`Protected`cursor

`Private`dexAttrCursor

`Private`eggMovesLabel

`Private`filterBar

`Private`filterBarContainer

`Private`filterBarCursor

`Private`filteredStarterContainers

`Private`filterInstructionRowX

`Private`filterInstructionRowY

`Private`filterInstructionsContainer

`Private`filterMode

`Private`formIconElement

`Private`formLabel

`Private`genderIconElement

`Private`genderLabel

`Private`goFilterIconElement

`Private`goFilterLabel

`Private`hasSwappedMoves

`Private`iconAnimHandler

`Private`instructionRowTextOffset

`Private`instructionRowX

`Private`instructionRowY

`Private`instructionsContainer

`Private`lastSpecies

`Protected`mode

`Private`moveInfoOverlay

`Private`natureCursor

`Private`natureIconElement

`Private`natureLabel

`Protected`onActionInput

`Private`originalStarterPreferences

`Private`pokemonAbilityLabelText

`Private`pokemonAbilityText

`Private`pokemonAdditionalMoveCountLabel

`Private`pokemonCandyContainer

`Private`pokemonCandyCountText

`Private`pokemonCandyDarknessOverlay

`Private`pokemonCandyIcon

`Private`pokemonCandyOverlayIcon

`Private`pokemonCaughtCountText

`Private`pokemonCaughtHatchedContainer

`Private`pokemonEggMoveBgs

`Private`pokemonEggMoveContainers

`Private`pokemonEggMoveLabels

`Private`pokemonEggMovesContainer

`Private`pokemonFormText

`Private`pokemonGenderText

`Private`pokemonGrowthRateLabelText

`Private`pokemonGrowthRateText

`Private`pokemonHatchedCountText

`Private`pokemonHatchedIcon

`Private`pokemonLuckLabelText

`Private`pokemonLuckText

`Private`pokemonMoveBgs

`Private`pokemonMoveContainers

`Private`pokemonMoveLabels

`Private`pokemonMovesContainer

`Private`pokemonNameText

`Private`pokemonNatureLabelText

`Private`pokemonNatureText

`Private`pokemonNumberText

`Private`pokemonPassiveDisabledIcon

`Private`pokemonPassiveLabelText

`Private`pokemonPassiveLockedIcon

`Private`pokemonPassiveText