Class default

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

Hierarchy (view full)

default
- default

Index

Constructors

Properties

abilityCursor active assetLoadCancelled awaitingActionInput blockInput canAddParty canCycleAbility canCycleForm canCycleGender canCycleNature canCycleShiny canCycleVariant candyUpgradeIcon candyUpgradeOverlayIcon classicWinIcons cursor cursorObj dexAttrCursor genCursor genCursorHighlightObj genCursorObj genMode genOptionsText genScrollCursor genSpecies hiddenAbilityIcons iconAnimHandler instructionsText lastSpecies message mode moveInfoOverlay natureCursor onActionInput pendingPrompt pokemonAbilityLabelText pokemonAbilityText pokemonAdditionalMoveCountLabel pokemonCandyCountText pokemonCandyDarknessOverlay pokemonCandyIcon pokemonCandyOverlayIcon pokemonCaughtCountText pokemonCaughtHatchedContainer pokemonEggMoveBgs pokemonEggMoveContainers pokemonEggMoveLabels pokemonEggMovesContainer pokemonFormText pokemonGenderText pokemonGrowthRateLabelText pokemonGrowthRateText pokemonHatchedCountText pokemonLuckLabelText pokemonLuckText pokemonMoveBgs pokemonMoveContainers pokemonMoveLabels pokemonMovesContainer pokemonNameText pokemonNatureLabelText pokemonNatureText pokemonNumberText pokemonPassiveLabelText pokemonPassiveText pokemonSprite pokemonUncaughtText pokerusCursorObjs pokerusCursors pokerusGens prompt scene shinyIcons shinyOverlay speciesLoaded speciesStarterDexEntry speciesStarterMoves startCursorObj starterAbilityIndexes starterAttr starterCursorObjs starterCursors starterGens starterIcons starterMoveset starterMovesets starterNatures starterSelectCallback starterSelectContainer starterSelectGenIconContainers starterSelectMessageBox starterSelectMessageBoxContainer starterValueLabels statsContainer statsMode textCallbackTimer textTimer tutorialActive type1Icon type2Icon value valueLimitLabel

Constructors

constructor

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

Properties

`Private` abilityCursor

abilityCursor: number = -1

active

active: boolean = false

`Private` assetLoadCancelled

assetLoadCancelled: BooleanHolder

`Protected` awaitingActionInput

awaitingActionInput: boolean

`Protected` blockInput

blockInput: boolean = false

`Private` canAddParty

canAddParty: boolean

`Private` canCycleAbility

canCycleAbility: boolean

`Private` canCycleForm

canCycleForm: boolean

`Private` canCycleGender

canCycleGender: boolean

`Private` canCycleNature

canCycleNature: boolean

`Private` canCycleShiny

canCycleShiny: boolean

`Private` canCycleVariant

canCycleVariant: boolean

`Private` candyUpgradeIcon

candyUpgradeIcon: Image[]

`Private` candyUpgradeOverlayIcon

candyUpgradeOverlayIcon: Image[]

`Private` classicWinIcons

classicWinIcons: Image[]

`Protected` cursor

cursor: number = 0

cursorObj

cursorObj: Image

`Private` dexAttrCursor

dexAttrCursor: bigint = ...

`Private` genCursor

genCursor: number = 0

`Private` genCursorHighlightObj

genCursorHighlightObj: Image

`Private` genCursorObj

genCursorObj: Image

`Private` genMode

genMode: boolean

`Private` genOptionsText

genOptionsText: Text

`Private` genScrollCursor

genScrollCursor: number = 0

`Private` genSpecies

genSpecies: default[][] = []

`Private` hiddenAbilityIcons

hiddenAbilityIcons: Image[]

`Private` iconAnimHandler

iconAnimHandler: default

`Private` instructionsText

instructionsText: Text

`Private` lastSpecies

lastSpecies: default

message

message: Text

`Protected` mode

mode: number

`Private` moveInfoOverlay

moveInfoOverlay: default

`Private` natureCursor

natureCursor: number = -1

`Protected` onActionInput

onActionInput: Function

pendingPrompt

pendingPrompt: boolean

`Private` pokemonAbilityLabelText

pokemonAbilityLabelText: Text

`Private` pokemonAbilityText

pokemonAbilityText: Text

`Private` pokemonAdditionalMoveCountLabel

pokemonAdditionalMoveCountLabel: Text

`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` 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` pokemonPassiveLabelText

pokemonPassiveLabelText: Text

`Private` pokemonPassiveText

pokemonPassiveText: Text

`Private` pokemonSprite

pokemonSprite: Sprite

`Private` pokemonUncaughtText

pokemonUncaughtText: Text

`Private` pokerusCursorObjs

pokerusCursorObjs: Image[]

`Private` pokerusCursors

pokerusCursors: number[] = []

`Private` pokerusGens

pokerusGens: number[] = []

prompt

prompt: Sprite

`Protected` scene

scene: default

`Private` shinyIcons

shinyIcons: Image[][]

`Private` shinyOverlay

shinyOverlay: Image

`Private` speciesLoaded

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

`Private` speciesStarterDexEntry

speciesStarterDexEntry: DexEntry

`Private` speciesStarterMoves

speciesStarterMoves: Moves[]

`Private` startCursorObj

startCursorObj: NineSlice

`Private` starterAbilityIndexes

starterAbilityIndexes: number[] = []

`Private` starterAttr

starterAttr: bigint[] = []

`Private` starterCursorObjs

starterCursorObjs: Image[]

starterCursors

starterCursors: number[] = []

starterGens

starterGens: number[] = []

`Private` starterIcons

starterIcons: Sprite[]

`Private` starterMoveset

starterMoveset: StarterMoveset

`Private` starterMovesets

starterMovesets: StarterMoveset[] = []

`Private` starterNatures

starterNatures: Nature[] = []

`Private` starterSelectCallback

starterSelectCallback: StarterSelectCallback

`Private` starterSelectContainer

starterSelectContainer: Container

`Private` starterSelectGenIconContainers

starterSelectGenIconContainers: Container[]

`Private` starterSelectMessageBox

starterSelectMessageBox: NineSlice

`Private` starterSelectMessageBoxContainer

starterSelectMessageBoxContainer: Container

`Private` starterValueLabels

starterValueLabels: Text[]

`Private` statsContainer

statsContainer: StatsContainer

`Private` statsMode

statsMode: boolean

`Protected` textCallbackTimer

textCallbackTimer: TimerEvent

`Protected` textTimer

textTimer: TimerEvent

tutorialActive

tutorialActive: boolean = false

`Private` type1Icon

type1Icon: Sprite

`Private` type2Icon

type2Icon: Sprite

`Private` value

value: number = 0

`Private` valueLimitLabel

valueLimitLabel: Text

Methods

checkIconId

checkIconId(icon, species, female, formIndex, shiny, variant): void
Parameters
- icon: Sprite
- species: default
- female: any
- formIndex: any
- shiny: any
- variant: any
Returns void
- Defined in src/ui/starter-select-ui-handler.ts:2294

clear

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

clearText

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

getCursor

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

getGenCursorWithScroll

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

getTextColor

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

getUi

getUi(): default
Returns default
Inherited from default.getUi
- Defined in src/ui/ui-handler.ts:34

getValueLimit

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

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

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

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

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

onCandyUpgradeDisplayChanged

onCandyUpgradeDisplayChanged(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:906

popStarter

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

processInput

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

processTutorialInput

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

setCursor

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

setGenMode

setGenMode(genMode): boolean
Parameters
- genMode: boolean
Returns boolean
- Defined in src/ui/starter-select-ui-handler.ts:1654

setSpecies

setSpecies(species): void
Parameters
- species: default
Returns void
- Defined in src/ui/starter-select-ui-handler.ts:1672

setSpeciesDetails

setSpeciesDetails(species, shiny, formIndex, female, variant, abilityIndex, natureIndex, forSeen?): void
Parameters
- species: default
- shiny: boolean
- formIndex: number
- female: boolean
- variant: Variant
- abilityIndex: number
- natureIndex: number
- forSeen: boolean = false
Returns void
- Defined in src/ui/starter-select-ui-handler.ts:1864

setTypeIcons

setTypeIcons(type1, type2): void
Parameters
- type1: Type
- type2: Type
Returns void
- Defined in src/ui/starter-select-ui-handler.ts:2089

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

setUpgradeIcon

setUpgradeIcon(index): void
Sets the visibility of a Candy Upgrade Icon given an index
Parameters
- index: number
  The UI index of the icon within this generation container
Returns void
- Defined in src/ui/starter-select-ui-handler.ts:874

setup

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

show

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

showDialogue

showDialogue(text, name, delay?, callback?, callbackDelay?, prompt?, promptDelay?): void
Parameters
- text: string
- name: string
- Optional delay: number
- Optional callback: Function
- Optional callbackDelay: number
- Optional prompt: boolean
- Optional promptDelay: number
Returns void
Inherited from default.showDialogue
- Defined in src/ui/message-ui-handler.ts:24

showPrompt

showPrompt(callback, callbackDelay): void
Parameters
- callback: Function
- callbackDelay: number
Returns void
Inherited from default.showPrompt
- Defined in src/ui/message-ui-handler.ts:154

showStats

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

showText

showText(text, delay?, callback?, callbackDelay?, prompt?, promptDelay?): void
Parameters
- text: string
- Optional delay: number
- Optional callback: Function
- Optional callbackDelay: number
- Optional prompt: boolean
- Optional promptDelay: number
Returns void
Overrides default.showText
- Defined in src/ui/starter-select-ui-handler.ts:762

switchMoveHandler

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

toggleStatsMode

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

tryStart

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

tryUpdateValue

tryUpdateValue(add?): boolean
Parameters
- Optional add: number
Returns boolean
- Defined in src/ui/starter-select-ui-handler.ts:2143

updateGenOptions

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

updateInstructions

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

updateStarterValueLabel

updateStarterValueLabel(cursor): void
Parameters
- cursor: number
Returns void
- Defined in src/ui/starter-select-ui-handler.ts:2117

Class default

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns default

Properties

Private abilityCursor

active

Private assetLoadCancelled

Protected awaitingActionInput

Protected blockInput

Private canAddParty

Private canCycleAbility

Private canCycleForm

Private canCycleGender

Private canCycleNature

Private canCycleShiny

Private canCycleVariant

Private candyUpgradeIcon

Private candyUpgradeOverlayIcon

Private classicWinIcons

Protected cursor

cursorObj

Private dexAttrCursor

Private genCursor

Private genCursorHighlightObj

Private genCursorObj

Private genMode

Private genOptionsText

Private genScrollCursor

Private genSpecies

Private hiddenAbilityIcons

Private iconAnimHandler

Private instructionsText

Private lastSpecies

message

Protected mode

Private moveInfoOverlay

Private natureCursor

Protected onActionInput

pendingPrompt

Private pokemonAbilityLabelText

Private pokemonAbilityText

Private pokemonAdditionalMoveCountLabel

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 pokemonLuckLabelText

Private pokemonLuckText

Private pokemonMoveBgs

Private pokemonMoveContainers

Private pokemonMoveLabels

Private pokemonMovesContainer

Private pokemonNameText

Private pokemonNatureLabelText

Private pokemonNatureText

Private pokemonNumberText

Private pokemonPassiveLabelText

Private pokemonPassiveText

Private pokemonSprite

Private pokemonUncaughtText

Private pokerusCursorObjs

Private pokerusCursors

`Private` abilityCursor

`Private` assetLoadCancelled

`Protected` awaitingActionInput

`Protected` blockInput

`Private` canAddParty

`Private` canCycleAbility

`Private` canCycleForm

`Private` canCycleGender

`Private` canCycleNature

`Private` canCycleShiny

`Private` canCycleVariant

`Private` candyUpgradeIcon

`Private` candyUpgradeOverlayIcon

`Private` classicWinIcons

`Protected` cursor

`Private` dexAttrCursor

`Private` genCursor

`Private` genCursorHighlightObj

`Private` genCursorObj

`Private` genMode

`Private` genOptionsText

`Private` genScrollCursor

`Private` genSpecies

`Private` hiddenAbilityIcons

`Private` iconAnimHandler

`Private` instructionsText

`Private` lastSpecies

`Protected` mode

`Private` moveInfoOverlay

`Private` natureCursor

`Protected` onActionInput

`Private` pokemonAbilityLabelText

`Private` pokemonAbilityText

`Private` pokemonAdditionalMoveCountLabel

`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` pokemonLuckLabelText

`Private` pokemonLuckText

`Private` pokemonMoveBgs

`Private` pokemonMoveContainers

`Private` pokemonMoveLabels

`Private` pokemonMovesContainer

`Private` pokemonNameText

`Private` pokemonNatureLabelText

`Private` pokemonNatureText

`Private` pokemonNumberText

`Private` pokemonPassiveLabelText

`Private` pokemonPassiveText

`Private` pokemonSprite

`Private` pokemonUncaughtText

`Private` pokerusCursorObjs

`Private` pokerusCursors

`Private` pokerusGens

`Protected` scene

`Private` shinyIcons

`Private` shinyOverlay

`Private` speciesLoaded

`Private` speciesStarterDexEntry

`Private` speciesStarterMoves

`Private` startCursorObj

`Private` starterAbilityIndexes

`Private` starterAttr

`Private` starterCursorObjs

`Private` starterIcons

`Private` starterMoveset

`Private` starterMovesets

`Private` starterNatures