Class GameChallengesUiHandler

Handles all the UI for choosing optional challenges.

Hierarchy (View Summary)

UiHandler
- GameChallengesUiHandler

Constructors

constructor

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

Properties

active

active: boolean = false

`Private` `Readonly`arrowSpacing

arrowSpacing: number = 3

`Private`challengeLabels

challengeLabels: {
    label: Text;
    leftArrow: Image;
    rightArrow: Image;
    value: Text;
}[]

`Private`challengesContainer

challengesContainer: Container

`Protected`cursor

cursor: number = 0

`Private`cursorObj

cursorObj: null | NineSlice

`Private`descriptionText

descriptionText: BBCodeText

`Private`hasSelectedChallenge

hasSelectedChallenge: boolean

`Private` `Readonly`leftArrowGap

leftArrowGap: number = 90

`Protected`mode

mode: null | number

`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

`Private`widestTextBox

widestTextBox: number

Methods

clear

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

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

eraseCursor

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

getActiveChallenge

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

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

initLabels

initLabels(): void
initLabels init all challenge labels

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

processInput

processInput(button: 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 UiHandler.processInput
- Defined in src/ui/handlers/challenges-select-ui-handler.ts:371

setCursor

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

setDescription

setDescription(text: string): 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/handlers/challenges-select-ui-handler.ts:226

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

setScrollCursor

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

setup

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

show

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

updateChallengeArrows

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

updateText

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

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

Class GameChallengesUiHandler

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns GameChallengesUiHandler

Properties

active

Private ReadonlyarrowSpacing

PrivatechallengeLabels

PrivatechallengesContainer

Protectedcursor

PrivatecursorObj

PrivatedescriptionText

PrivatehasSelectedChallenge

Private ReadonlyleftArrowGap

Protectedmode

PrivatemonoTypeValue

PrivateoptionsBg

PrivateoptionsWidth

PrivatescrollCursor

PrivatestartBg

PrivatestartCursor

PrivatestartText

PrivatevaluesContainer

PrivatewidestTextBox

Methods

clear

Returns void

destroy

Returns void

eraseCursor

Returns void

getActiveChallenge

Returns Challenge

getCursor

Returns number

getUi

Returns UI

initLabels

Returns void

processInput

Parameters

Returns boolean

setCursor

Parameters

Returns boolean

setDescription

Parameters

Returns void

ProtectedsetMouseCursorStyle

Parameters

Returns void

See

setScrollCursor

Parameters

Returns boolean

setup

Returns void

show

Parameters

Returns boolean

updateChallengeArrows

Parameters

Returns void

updateText

Returns void

Settings

On This Page

`Private` `Readonly`arrowSpacing

`Private`challengeLabels

`Private`challengesContainer

`Protected`cursor

`Private`cursorObj

`Private`descriptionText

`Private`hasSelectedChallenge

`Private` `Readonly`leftArrowGap

`Protected`mode

`Private`monoTypeValue

`Private`optionsBg

`Private`optionsWidth

`Private`scrollCursor

`Private`startBg

`Private`startCursor

`Private`startText

`Private`valuesContainer

`Private`widestTextBox

`Protected`setMouseCursorStyle