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

Constructors

constructor

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

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

`Protected`onActionInput

onActionInput: Function

pendingPrompt

pendingPrompt: boolean

prompt

prompt: Sprite

`Protected`scene

scene: default

starterSpecies

starterSpecies: default[] = []

`Protected`textCallbackTimer

textCallbackTimer: TimerEvent

`Protected`textTimer

textTimer: TimerEvent

tutorialActive

tutorialActive: boolean = false

Methods

addToParty

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

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

clear

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

clearText

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

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

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

hideInstructions

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

isInParty

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

isPartyValid

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

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

isSameSpeciesEggAvailable

isSameSpeciesEggAvailable(speciesId): boolean
Determines if an same species egg can be baught 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:893

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

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

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

moveStarterIconsCursor

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

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

popStarter

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

processInput

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

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

setFilterMode

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

setSpecies

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

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

setTypeIcons

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

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

setUpgradeIcon

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

setup

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

show

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

showDialogue

showDialogue(text, name, delay?, callback?, callbackDelay?, prompt?, promptDelay?): void
Parameters
- text: string
- name: string
- Optionaldelay: number
- Optionalcallback: Function
- OptionalcallbackDelay: number
- Optionalprompt: boolean
- OptionalpromptDelay: 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:2927

showText

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

switchMoveHandler

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

toggleStatsMode

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

tryStart

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

tryUpdateValue

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

updateButtonIcon

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

updateGenOptions

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

updateInstructions

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

updateScroll

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

updateStarterValueLabel

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

updateStarters

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