Class StarterSelectUiHandler

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

Hierarchy (View Summary)

MessageUiHandler
- StarterSelectUiHandler

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 StarterSelectUiHandler(): StarterSelectUiHandler
Returns StarterSelectUiHandler
Overrides MessageUiHandler.constructor
- Defined in src/ui/starter-select-ui-handler.ts:405

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: PokemonSpecies[] = []

`Protected`textCallbackTimer

textCallbackTimer: null | TimerEvent

`Protected`textTimer

textTimer: null | TimerEvent

tutorialActive

tutorialActive: boolean = false

tutorialOverlay

tutorialOverlay: Rectangle

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

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

clear

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

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

clearText

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

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

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

getCursor

getCursor(): number
Returns number
Inherited from MessageUiHandler.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:3378

getTextColor

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

getUi

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

getValueLimit

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

hideInstructions

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

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/message-ui-handler.ts:24

initStarterPrefs

initStarterPrefs(species: PokemonSpecies): 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
Returns StarterAttributes
StarterAttributes for the species
- Defined in src/ui/starter-select-ui-handler.ts:1181

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/awaitable-ui-handler.ts:33

isInParty

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

isPartyValid

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

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

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

isTextAnimationInProgress

isTextAnimationInProgress(): boolean
Returns boolean
Inherited from MessageUiHandler.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:1331

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

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

moveStarterIconsCursor

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

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

popStarter

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

processInput

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

processTutorialInput

processTutorialInput(button: Button): boolean
Parameters
- button: Button
Returns boolean
Inherited from MessageUiHandler.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:1278

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

setCursor

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

setFilterMode

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

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

setSpecies

setSpecies(species: null | PokemonSpecies): void
Parameters
- species: null | PokemonSpecies
Returns void
- Defined in src/ui/starter-select-ui-handler.ts:3389

setSpeciesDetails

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

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

setup

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

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

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

show

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

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/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/message-ui-handler.ts:222

showStats

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

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

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
⚠️ starterMoveset | this.starterMoveset must not be null when this method is called
- Defined in src/ui/starter-select-ui-handler.ts:2700

toggleStatsMode

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

tryExit

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

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

tryStart

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

tryUpdateValue

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

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

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

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

updateInstructions

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

updatePartyIcon

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

updateScroll

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

updateStarters

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

updateStarterValueLabel

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

Class StarterSelectUiHandler

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Returns StarterSelectUiHandler

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 UI

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