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

Properties

active

active: boolean = false

`Private` `Readonly`challengeCategories

challengeCategories: ChallengeCategory[] = ...

`Private` `Readonly`challengeLabels

challengeLabels: ChallengeLabel[] = []

`Private`challengesContainer

challengesContainer: Container

`Protected`cursor

cursor: number = 0

`Private`cursorObj

cursorObj: NineSlice | null

`Private`descriptionScrollTween

descriptionScrollTween: Tween | null

`Private`descriptionText

descriptionText: BBCodeText

`Private`descriptionTextBaseY

descriptionTextBaseY: number

`Private`descriptionTextMaskRect

descriptionTextMaskRect: Graphics | null

`Private`descriptionTextMaxHeight

descriptionTextMaxHeight: number

`Private`hasSelectedChallenge

hasSelectedChallenge: boolean

`Private`homeKey

homeKey: Key | undefined

`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`tabMenu

tabMenu: TabMenu

`Private`valuesContainer

valuesContainer: Container

Methods

clear

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

destroy

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

Returns void
Overrides UiHandler.destroy
- Defined in src/ui/handlers/challenges-select-ui-handler.ts:650

getCursor

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

`Private`getFilteredChallenges

getFilteredChallenges(): Challenge[]
Returns Challenge[]
- Defined in src/ui/handlers/challenges-select-ui-handler.ts:278

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

`Private`onHomeDown

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

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

`Private`resetChallengesToDefault

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

setCursor

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

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

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

setup

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

show

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

`Private`updateChallengeArrowsTint

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

`Private`updateDescriptionScroll

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

`Private`updateText

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

Class GameChallengesUiHandler

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns GameChallengesUiHandler

Properties

active

Private ReadonlychallengeCategories

Private ReadonlychallengeLabels

PrivatechallengesContainer

Protectedcursor

PrivatecursorObj

PrivatedescriptionScrollTween

PrivatedescriptionText

PrivatedescriptionTextBaseY

PrivatedescriptionTextMaskRect

PrivatedescriptionTextMaxHeight

PrivatehasSelectedChallenge

PrivatehomeKey

Protectedmode

PrivatemonoTypeValue

PrivateoptionsBg

PrivateoptionsWidth

PrivatescrollCursor

PrivatestartBg

PrivatestartCursor

PrivatestartText

PrivatetabMenu

PrivatevaluesContainer

Methods

clear

Returns void

destroy

Returns void

PrivateeraseCursor

Returns void

PrivategetActiveChallenge

Returns Challenge

PrivategetCategoryName

Parameters

Returns string

getCursor

Returns number

PrivategetFilteredChallenges

Returns Challenge[]

getUi

Returns UI

PrivateinitLabels

Returns void

PrivateonHomeDown

Returns void

processInput

Parameters

Returns boolean

PrivateresetChallengesToDefault

Returns void

setCursor

Parameters

Returns boolean

PrivatesetDescription

Parameters

Returns void

ProtectedsetMouseCursorStyle

Parameters

Returns void

See

PrivatesetScrollCursor

Parameters

Returns boolean

setup

Returns void

show

Parameters

Returns boolean

PrivateupdateChallengeArrowsTint

`Private` `Readonly`challengeCategories

`Private` `Readonly`challengeLabels

`Private`challengesContainer

`Protected`cursor

`Private`cursorObj

`Private`descriptionScrollTween

`Private`descriptionText

`Private`descriptionTextBaseY

`Private`descriptionTextMaskRect

`Private`descriptionTextMaxHeight

`Private`hasSelectedChallenge

`Private`homeKey

`Protected`mode

`Private`monoTypeValue

`Private`optionsBg

`Private`optionsWidth

`Private`scrollCursor

`Private`startBg

`Private`startCursor

`Private`startText

`Private`tabMenu

`Private`valuesContainer

`Private`eraseCursor

`Private`getActiveChallenge

`Private`getCategoryName

`Private`getFilteredChallenges

`Private`initLabels

`Private`onHomeDown

`Private`resetChallengesToDefault

`Private`setDescription

`Protected`setMouseCursorStyle

`Private`setScrollCursor

`Private`updateChallengeArrowsTint

`Private`updateDescriptionScroll

`Private`updateText