Class TitleUiHandler

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

Hierarchy (View Summary)

OptionSelectUiHandler
- TitleUiHandler

Constructors

constructor

new TitleUiHandler(mode?: UiMode): TitleUiHandler
Parameters
- mode: UiMode = UiMode.TITLE
Returns TitleUiHandler
Overrides OptionSelectUiHandler.constructor
- Defined in src/ui/handlers/title-ui-handler.ts:54

Properties

active

active: boolean = false

`Private`appVersionText

appVersionText: Text

`Protected`blockInput

blockInput: boolean

`Protected`config

config: null | OptionSelectConfig

`Protected`cursor

cursor: number = 0

`Protected`defaultTextStyle

defaultTextStyle: TextStyle = TextStyle.WINDOW

`Private`eventDisplay

eventDisplay: TimedEventDisplay

`Protected`fullCursor

fullCursor: number = 0

`Protected`mode

mode: null | number

`Protected`optionSelectBg

optionSelectBg: NineSlice

`Protected`optionSelectContainer

optionSelectContainer: Container

`Protected`optionSelectIcons

optionSelectIcons: Sprite[]

`Protected`optionSelectText

optionSelectText: BBCodeText

`Protected`optionSelectTextContainer

optionSelectTextContainer: Container

`Private`playerCountLabel

playerCountLabel: Text

`Protected`scale

scale: number = 0.1666666667

`Protected`scrollCursor

scrollCursor: number = 0

`Private`splashMessage

splashMessage: string

`Private`splashMessageText

splashMessageText: Text

`Protected`textContent

textContent: string

`Private`titleContainer

titleContainer: Container

`Private`titleStatsTimer

titleStatsTimer: null | Timeout

`Protected`unskippedIndices

unskippedIndices: number[] = []

`Private`usernameLabel

usernameLabel: Text

`Private` `Static` `Readonly`BATTLES_WON_FALLBACK

BATTLES_WON_FALLBACK: number = -1

If the stats can not be retrieved, use this fallback value

Methods

clear

clear(): void
Returns void
Overrides OptionSelectUiHandler.clear
- Defined in src/ui/handlers/title-ui-handler.ts:225

destroy

destroy(): void
To be implemented by individual handlers when necessary to free memory Called when BattleScene is reset

Returns void
Inherited from OptionSelectUiHandler.destroy
- Defined in src/ui/handlers/ui-handler.ts:63

eraseCursor

eraseCursor(): void
Returns void
Inherited from OptionSelectUiHandler.eraseCursor
- Defined in src/ui/handlers/abstract-option-select-ui-handler.ts:427

genderSplash

genderSplash(): void
Used for a specific April Fools splash message.

Returns void
- Defined in src/ui/handlers/title-ui-handler.ts:155

getCursor

getCursor(): number
Returns number
Inherited from OptionSelectUiHandler.getCursor
- Defined in src/ui/handlers/ui-handler.ts:34

`Private`getLogo

getLogo(): string
Get the logo file path to load, with a 0.1% chance to use the fake logo instead.

Returns string
The path to the image.
- Defined in src/ui/handlers/title-ui-handler.ts:247

`Private`getUsername

getUsername(): string
Returns the username of logged in user. If the username is hidden, the trainer name based on gender will be displayed.

Returns string
The username of logged in user
- Defined in src/ui/handlers/title-ui-handler.ts:38

getWindowHeight

getWindowHeight(): number
Returns number
Inherited from OptionSelectUiHandler.getWindowHeight
- Defined in src/ui/handlers/abstract-option-select-ui-handler.ts:62

getWindowWidth

getWindowWidth(): number
Returns number
Inherited from OptionSelectUiHandler.getWindowWidth
- Defined in src/ui/settings/option-select-ui-handler.ts:9

processInput

processInput(button: Button): boolean
Parameters
- button: Button
Returns boolean
Inherited from OptionSelectUiHandler.processInput
- Defined in src/ui/handlers/abstract-option-select-ui-handler.ts:218

randomPokemon

randomPokemon(): void
Used solely to display a random Pokémon name in a splash message.

Returns void
- Defined in src/ui/handlers/title-ui-handler.ts:140

setCursor

setCursor(fullCursor: number): boolean
Parameters
- fullCursor: number
Returns boolean
Inherited from OptionSelectUiHandler.setCursor
- Defined in src/ui/handlers/abstract-option-select-ui-handler.ts:353

`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 OptionSelectUiHandler.setMouseCursorStyle
- Defined in src/ui/handlers/ui-handler.ts:52

setup

setup(): void
Returns void
Overrides OptionSelectUiHandler.setup
- Defined in src/ui/handlers/title-ui-handler.ts:58

`Protected`setupOptions

setupOptions(): void
Returns void
Inherited from OptionSelectUiHandler.setupOptions
- Defined in src/ui/handlers/abstract-option-select-ui-handler.ts:89

show

show(args: any[]): boolean
Parameters
- args: any[]
Returns boolean
Overrides OptionSelectUiHandler.show
- Defined in src/ui/handlers/title-ui-handler.ts:164

unblockInput

unblockInput(): void
Returns void
Inherited from OptionSelectUiHandler.unblockInput
- Defined in src/ui/handlers/abstract-option-select-ui-handler.ts:293

updateTitleStats

updateTitleStats(): void
Returns void
- Defined in src/ui/handlers/title-ui-handler.ts:119

updateUsername

updateUsername(): void
Returns void
- Defined in src/ui/handlers/title-ui-handler.ts:50

Class TitleUiHandler

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns TitleUiHandler

Properties

active

PrivateappVersionText

ProtectedblockInput

Protectedconfig

Protectedcursor

ProtecteddefaultTextStyle

PrivateeventDisplay

ProtectedfullCursor

Protectedmode

ProtectedoptionSelectBg

ProtectedoptionSelectContainer

ProtectedoptionSelectIcons

ProtectedoptionSelectText

ProtectedoptionSelectTextContainer

PrivateplayerCountLabel

Protectedscale

ProtectedscrollCursor

PrivatesplashMessage

PrivatesplashMessageText

ProtectedtextContent

PrivatetitleContainer

PrivatetitleStatsTimer

ProtectedunskippedIndices

PrivateusernameLabel

Private Static ReadonlyBATTLES_WON_FALLBACK

Methods

clear

Returns void

destroy

Returns void

eraseCursor

Returns void

genderSplash

Returns void

getCursor

Returns number

PrivategetLogo

Returns string

getOptionsWithScroll

Returns OptionSelectItem[]

getUi

Returns UI

getUnskippedIndices

Parameters

Returns number[]

PrivategetUsername

Returns string

getWindowHeight

Returns number

getWindowWidth

Returns number

processInput

Parameters

Returns boolean

randomPokemon

Returns void

setCursor

Parameters

Returns boolean

ProtectedsetMouseCursorStyle

Parameters

Returns void

See

setup

Returns void

ProtectedsetupOptions

Returns void

show

Parameters

`Private`appVersionText

`Protected`blockInput

`Protected`config

`Protected`cursor

`Protected`defaultTextStyle

`Private`eventDisplay

`Protected`fullCursor

`Protected`mode

`Protected`optionSelectBg

`Protected`optionSelectContainer

`Protected`optionSelectIcons

`Protected`optionSelectText

`Protected`optionSelectTextContainer

`Private`playerCountLabel

`Protected`scale

`Protected`scrollCursor

`Private`splashMessage

`Private`splashMessageText

`Protected`textContent

`Private`titleContainer

`Private`titleStatsTimer

`Protected`unskippedIndices

`Private`usernameLabel

`Private` `Static` `Readonly`BATTLES_WON_FALLBACK

`Private`getLogo

`Private`getUsername

`Protected`setMouseCursorStyle

`Protected`setupOptions