Class default

Handles all the UI for choosing optional challenges.

Hierarchy (view full)

default
- default

Index

Constructors

Properties

active cursor mode scene

Methods

clear eraseCursor getActiveChallenge getCursor getTextColor getUi initLabels processInput setCursor setDescription setScrollCursor setup show updateText

Constructors

constructor

new default(scene, mode?): default
Parameters
- scene: default
- mode: null | Mode = null
Returns default
Overrides default.constructor
- Defined in src/ui/challenges-select-ui-handler.ts:37

Properties

active

active: boolean = false

`Protected`cursor

cursor: number = 0

`Protected`mode

mode: null | number

`Protected`scene

scene: default

Methods

clear

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

eraseCursor

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

getActiveChallenge

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

getCursor

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

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

initLabels

initLabels(): void
initLabels init all challenge labels

Returns void
- Defined in src/ui/challenges-select-ui-handler.ts:181

processInput

processInput(button): boolean
Processes input from a specified button. This method handles navigation through a UI menu, including movement through menu items 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
true if the action associated with the button was successfully processed, false otherwise.
Overrides default.processInput
- Defined in src/ui/challenges-select-ui-handler.ts:247

setCursor

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

setDescription

setDescription(text): void
Adds the default text color to the description text
Parameters
- text: string
  text to set to the BBCode description
Returns void
- Defined in src/ui/challenges-select-ui-handler.ts:173

setScrollCursor

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

setup

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

show

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

updateText

updateText(): void
update the text the cursor is on

Returns void
- Defined in src/ui/challenges-select-ui-handler.ts:194