Class GameChallengesUiHandler

Handles all the UI for choosing optional challenges.

Hierarchy (View Summary)

UiHandler
- GameChallengesUiHandler

Constructors

constructor

new GameChallengesUiHandler(mode?: UiMode | null): GameChallengesUiHandler
Parameters
- mode: UiMode | null = null
Returns GameChallengesUiHandler
Overrides UiHandler.constructor
- Defined in src/ui/handlers/challenges-select-ui-handler.ts:49

Properties

active

active: boolean = false

`Private` `Readonly`challengeLabels

challengeLabels: ChallengeLabel[] = []

`Private`challengesContainer

challengesContainer: Container

`Protected`cursor

cursor: number = 0

`Private`cursorObj

cursorObj: NineSlice | null

`Private`descriptionText

descriptionText: BBCodeText

`Private`hasSelectedChallenge

hasSelectedChallenge: boolean

`Protected`mode

mode: number | null

`Private`monoTypeValue

monoTypeValue: Sprite

`Private`optionsBg

optionsBg: NineSlice

`Private`optionsWidth

optionsWidth: number

`Private`scrollCursor

scrollCursor: number

`Private`startBg

startBg: NineSlice

`Private`startCursor

startCursor: NineSlice

`Private`startText

startText: Text

`Private`valuesContainer

valuesContainer: Container

Methods

clear

clear(): void
Returns void
Overrides UiHandler.clear
- Defined in src/ui/handlers/challenges-select-ui-handler.ts:493

destroy

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

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

`Private`eraseCursor

eraseCursor(): void
Returns void
- Defined in src/ui/handlers/challenges-select-ui-handler.ts:499

`Private`getActiveChallenge

getActiveChallenge(): Challenge
Returns Challenge
- Defined in src/ui/handlers/challenges-select-ui-handler.ts:489

getCursor

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

getUi

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

`Private`initLabels

initLabels(): void
Returns void
- Defined in src/ui/handlers/challenges-select-ui-handler.ts:197

processInput

processInput(button: Button): boolean
Processes input from a specified button.

This method handles navigation through a UI menu, including movement through menu item and handling special actions like cancellation.
Each button press may adjust the cursor position or the menu scroll, and plays a sound effect if the action was successful.
Parameters
- button: Button
  The button pressed by the user.
Returns boolean
Whether the action associated with the button was successfully processed
Overrides UiHandler.processInput
- Defined in src/ui/handlers/challenges-select-ui-handler.ts:355

setCursor

setCursor(cursor: number): boolean
Parameters
- cursor: number
Returns boolean
Overrides UiHandler.setCursor
- Defined in src/ui/handlers/challenges-select-ui-handler.ts:459

`Private`setDescription

setDescription(text: string): void
Sets the description text, using orange for the text & shadow colors.
Parameters
- text: string
  The text to set
Returns void
- Defined in src/ui/handlers/challenges-select-ui-handler.ts:193

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

`Private`setScrollCursor

setScrollCursor(scrollCursor: number): boolean
Parameters
- scrollCursor: number
Returns boolean
- Defined in src/ui/handlers/challenges-select-ui-handler.ts:477

setup

setup(): void
Returns void
Overrides UiHandler.setup
- Defined in src/ui/handlers/challenges-select-ui-handler.ts:53

show

show(args: any[]): boolean
Parameters
- args: any[]
Returns boolean
Overrides UiHandler.show
- Defined in src/ui/handlers/challenges-select-ui-handler.ts:308

`Private`updateChallengeArrowsTint

updateChallengeArrowsTint(tinted: boolean): void
Parameters
- tinted: boolean
Returns void
- Defined in src/ui/handlers/challenges-select-ui-handler.ts:329

`Private`updateText

updateText(): void
Returns void
- Defined in src/ui/handlers/challenges-select-ui-handler.ts:242