Class TitleUiHandler

Generic handler for a menu with several options to choose from with a cursor.

Given the proper OptionSelectModeConfig the handler will:

Measure the size of all elements in the menu, including the size of any icon.
Apply the required BBCode if an elements asks for a specific color.
Create the window of the appropriate size to hold all elements.
Handle scrolling through the menu items, resizing as needed.
Handle selecting the menu items, or cancelling out of the menu.

At initialization the size of the first NUM_PRE_COMPUTED_OPTIONS is measured.
Then the window's size is updated as needed when a non initialized option needs to be displayed.

Hierarchy (View Summary)

OptionSelectUiHandler
- TitleUiHandler

Index

Constructors

constructor

Accessors

currentOption windowHeight

Constructors

constructor

new TitleUiHandler(): TitleUiHandler
Returns TitleUiHandler
Overrides OptionSelectUiHandler.constructor
- Defined in src/ui/handlers/title-ui-handler.ts:39

Properties

active

active: boolean = false

`Private`appVersionText

appVersionText: Text

`Protected`awaitingActionInput

awaitingActionInput: boolean

`Protected`blockInput

blockInput: boolean

`Protected`cursor

cursor: number = 0

`Protected`cursorObj

cursorObj: Image | null

`Private`eventDisplay

eventDisplay: TimedEventDisplay

`Protected`fullyInitialized

fullyInitialized: boolean

message

message: Text

`Protected` `Readonly`mode

mode: UiMode

Used to set the name of optionSelectContainer

`Optional`nameBoxContainer

nameBoxContainer?: Container

The container for the name box

Remarks

This will be undefined unless this.initNameBox() was called

`Protected`onActionInput

onActionInput: AnyFn<any> | null

`Protected`optionSelectBg

optionSelectBg: NineSlice

`Protected`optionSelectContainer

optionSelectContainer: Container

`Protected`optionSelectIcons

optionSelectIcons: Sprite[] = []

`Protected`optionSelectText

optionSelectText: BBCodeText

pendingPrompt

pendingPrompt: boolean = false

`Private`playerCountLabel

playerCountLabel: Text

prompt

prompt: Sprite

`Protected`scale

scale: number = 0.1666666667

`Protected`scrollBar

scrollBar: ScrollBar | null

`Protected`scrollCursor

scrollCursor: number = 0

`Private`snow

snow: TileSprite

`Private`splashMessage

splashMessage: string

`Private`splashMessageText

splashMessageText: Text

`Protected`textCallbackTimer

textCallbackTimer: TimerEvent | null

`Protected`textTimer

textTimer: TimerEvent | null

`Private`titleContainer

titleContainer: Container

`Private`titleStatsTimer

titleStatsTimer: Timeout | null

tutorialActive

tutorialActive: boolean = false

tutorialOverlay

tutorialOverlay: Rectangle

`Private`usernameLabel

usernameLabel: Text

`Readonly`wordWrapWidth

wordWrapWidth: number = 1780

Accessors

`Protected`currentOption

get currentOption(): UIOptionSelectItem & T | undefined
Returns UIOptionSelectItem & T | undefined
Inherited from OptionSelectUiHandler.currentOption
- Defined in src/ui/handlers/base-option-select-ui-handler.ts:65

`Protected`windowHeight

get windowHeight(): number
Returns number
Inherited from OptionSelectUiHandler.windowHeight
- Defined in src/ui/handlers/base-option-select-ui-handler.ts:61

Methods

`Private`addSnow

addSnow(): void
Adds a snow effect on the title screen during the winter season.

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

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

`Protected`displayCurrentOptions

displayCurrentOptions(skipResizing?: boolean): void
Display the current options based on the cursor and scroll cursor.
Parameters
- skipResizing: boolean = false
  (Default false) Whether to skip the automatic resizing step
Returns void

Remarks
Can handle automatic resizing of the menu window as needed.
Inherited from OptionSelectUiHandler.displayCurrentOptions
- Defined in src/ui/handlers/base-option-select-ui-handler.ts:332

getCursor

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

`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:254

`Private`getSplashMessageI18nParams

getSplashMessageI18nParams(): TOptionsBase & $Dictionary & Record<
string,
unknown,
>
Returns TOptionsBase & $Dictionary & Record<string, unknown>
- Defined in src/ui/handlers/title-ui-handler.ts:147

getUi

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

`Private`getUsername

getUsername(): string
Returns string
The username of the logged in user, or the trainer name (based on currently selected gender) if the "Hide Username" setting is enabled
- Defined in src/ui/handlers/title-ui-handler.ts:47

hideNameText

hideNameText(): void
Returns void
Inherited from OptionSelectUiHandler.hideNameText
- Defined in src/ui/handlers/message-ui-handler.ts:332

`Protected`initCursor

initCursor(): void
Initializes the cursor when opening the menu. MUST only be called after this.initOptions()!

Returns void
Inherited from OptionSelectUiHandler.initCursor
- Defined in src/ui/handlers/base-option-select-ui-handler.ts:476

`Protected`initializeOption

initializeOption(
    option: UIOptionSelectItem & OptionSelectItem,
    singleSpaceWidth: number,
    tempSprite: Sprite,
): void
Readies the given UIOptionSelectItem for display.
Parameters
- option: UIOptionSelectItem & OptionSelectItem
  The UIOptionSelectItem to consider
- singleSpaceWidth: number
  The width of a single space, used to offset the label if there is a icon to show
- tempSprite: Sprite
  A Sprite object that can be used to measure the needed space of the item's icon, if any
Returns void

Remarks
For options with icon(s), adds the appropriate number of space before the label to give the sprite the space it needs

For options with color, adds the appropriate BBCode to the label
Inherited from OptionSelectUiHandler.initializeOption
- Defined in src/ui/handlers/base-option-select-ui-handler.ts:289

initNameBox

initNameBox(container: Container, x?: number, y?: number): void
Add the name box shown by showDialogue to the given message container.
Parameters
- container: Container
  The container holding the message text
- x: number = 0
  The x position of the name box
- y: number = -16
  The y position of the name box
Returns void

Remarks
If this method is not called, the name box will not be displayed.
Inherited from OptionSelectUiHandler.initNameBox
- Defined in src/ui/handlers/message-ui-handler.ts:37

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 OptionSelectUiHandler.initPromptSprite
- Defined in src/ui/handlers/message-ui-handler.ts:60

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 OptionSelectUiHandler.initTutorialOverlay
- Defined in src/ui/handlers/awaitable-ui-handler.ts:33

isTextAnimationInProgress

isTextAnimationInProgress(): boolean
Returns boolean
Inherited from OptionSelectUiHandler.isTextAnimationInProgress
- Defined in src/ui/handlers/message-ui-handler.ts:336

processInput

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

processTutorialInput

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

setCursor

setCursor(cursor: number): boolean
Parameters
- cursor: number
Returns boolean
Inherited from OptionSelectUiHandler.setCursor
- Defined in src/ui/handlers/base-option-select-ui-handler.ts:499

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

`Protected`setScrollCursor

setScrollCursor(scrollCursor: number): boolean
Parameters
- scrollCursor: number
Returns boolean
Inherited from OptionSelectUiHandler.setScrollCursor
- Defined in src/ui/handlers/base-option-select-ui-handler.ts:522

setup

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

show

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

showDialogue

showDialogue(
    text: string,
    name?: string,
    delay?: number | null,
    callback?: (() => void) | null,
    callbackDelay?: number | null,
    prompt?: boolean | null,
    promptDelay?: number | null,
): void
Parameters
- text: string
- Optionalname: string
- Optionaldelay: number | null
- Optionalcallback: (() => void) | null
- OptionalcallbackDelay: number | null
- Optionalprompt: boolean | null
- OptionalpromptDelay: number | null
Returns void
Inherited from OptionSelectUiHandler.showDialogue
- Defined in src/ui/handlers/message-ui-handler.ts:85

showNameText

showNameText(name: string, iconFrame?: string): void
Show a name above the text.
Parameters
- name: string
  The name to show
- OptionaliconFrame: string
  The frame of the icon to display next to the name
Returns void

Remarks
the icon must be from the items atlas
Inherited from OptionSelectUiHandler.showNameText
- Defined in src/ui/handlers/message-ui-handler.ts:311

showPrompt

showPrompt(callback?: (() => void) | null, callbackDelay?: number | null): void
Parameters
- Optionalcallback: (() => void) | null
- OptionalcallbackDelay: number | null
Returns void
Inherited from OptionSelectUiHandler.showPrompt
- Defined in src/ui/handlers/message-ui-handler.ts:267

showText

showText(
    text: string,
    delay?: number | null,
    callback?: (() => void) | null,
    callbackDelay?: number | null,
    prompt?: boolean | null,
    promptDelay?: number | null,
): void
Parameters
- text: string
- Optionaldelay: number | null
- Optionalcallback: (() => void) | null
- OptionalcallbackDelay: number | null
- Optionalprompt: boolean | null
- OptionalpromptDelay: number | null
Returns void
Inherited from OptionSelectUiHandler.showText
- Defined in src/ui/handlers/message-ui-handler.ts:73

`Protected`unblockInput

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

`Protected`updateSizeForOptions

updateSizeForOptions(options: (UIOptionSelectItem & OptionSelectItem)[]): void
Automatically set the menu's size for the given options.
Parameters
- options: (UIOptionSelectItem & OptionSelectItem)[]
  Array of UIOptionSelectItems to consider
Returns void

Remarks
Preserves the current size if they are all smaller, otherwise expands as needed.
Inherited from OptionSelectUiHandler.updateSizeForOptions
- Defined in src/ui/handlers/base-option-select-ui-handler.ts:176

`Private`updateTitleStats

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

`Private`updateUsername

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

Class TitleUiHandler

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns TitleUiHandler

Properties

active

PrivateappVersionText

ProtectedawaitingActionInput

ProtectedblockInput

Protectedcursor

ProtectedcursorObj

PrivateeventDisplay

ProtectedfullyInitialized

message

Protected Readonlymode

OptionalnameBoxContainer

Remarks

ProtectedonActionInput

ProtectedoptionSelectBg

ProtectedoptionSelectContainer

ProtectedoptionSelectIcons

ProtectedoptionSelectText

pendingPrompt

PrivateplayerCountLabel

prompt

Protectedscale

ProtectedscrollBar

ProtectedscrollCursor

Privatesnow

PrivatesplashMessage

PrivatesplashMessageText

ProtectedtextCallbackTimer

ProtectedtextTimer

PrivatetitleContainer

PrivatetitleStatsTimer

tutorialActive

tutorialOverlay

PrivateusernameLabel

ReadonlywordWrapWidth

Accessors

ProtectedcurrentOption

Returns UIOptionSelectItem & T | undefined

ProtectedwindowHeight

Returns number

Methods

PrivateaddSnow

Returns void

clear

Returns void

ProtectedclearCursor

Returns void

ProtectedclearIconSprites

Returns void

ProtectedclearScrollBar

Returns void

clearText

Returns void

destroy

Returns void

ProtecteddisplayCurrentOptions

Parameters

Returns void

Remarks

getCursor

Returns number

PrivategetLogo

Returns string

PrivategetSplashMessageI18nParams

Returns TOptionsBase & $Dictionary & Record<string, unknown>

getUi

Returns UI

PrivategetUsername

Returns string

hideNameText

`Private`appVersionText

`Protected`awaitingActionInput

`Protected`blockInput

`Protected`cursor

`Protected`cursorObj

`Private`eventDisplay

`Protected`fullyInitialized

`Protected` `Readonly`mode

`Optional`nameBoxContainer

`Protected`onActionInput

`Protected`optionSelectBg

`Protected`optionSelectContainer

`Protected`optionSelectIcons

`Protected`optionSelectText

`Private`playerCountLabel

`Protected`scale

`Protected`scrollBar

`Protected`scrollCursor

`Private`snow

`Private`splashMessage

`Private`splashMessageText

`Protected`textCallbackTimer

`Protected`textTimer

`Private`titleContainer

`Private`titleStatsTimer

`Private`usernameLabel

`Readonly`wordWrapWidth

`Protected`currentOption

`Protected`windowHeight

`Private`addSnow

`Protected`clearCursor

`Protected`clearIconSprites

`Protected`clearScrollBar

`Protected`displayCurrentOptions

`Private`getLogo

`Private`getSplashMessageI18nParams

`Private`getUsername

`Protected`initCursor

`Protected`initializeOption

`Protected`setMouseCursorStyle

`Protected`setScrollCursor

`Protected`unblockInput

`Protected`updateSizeForOptions

`Private`updateTitleStats

`Private`updateUsername