Class GameStatsUiHandler

A basic abstract class to act as a holder and processor for UI elements.

Hierarchy (View Summary)

UiHandler
- GameStatsUiHandler

Index

Constructors

Properties

active cursor mode

Methods

clear destroy getCursor getTextColor getUi processInput setCursor setMouseCursorStyle setup show

Constructors

constructor

new GameStatsUiHandler(mode?: null | UiMode): GameStatsUiHandler
Parameters
- mode: null | UiMode = null
  The mode of the UI element. These should be unique.
Returns GameStatsUiHandler
Inherited from UiHandler.constructor
- Defined in src/ui/ui-handler.ts:18

Properties

active

active: boolean = false

`Protected`cursor

cursor: number = 0

`Protected`mode

mode: null | number

Methods

clear

clear(): void
Returns void
Overrides UiHandler.clear
- Defined in src/ui/game-stats-ui-handler.ts:479

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/ui-handler.ts:69

getCursor

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

getTextColor

getTextColor(style: TextStyle, shadow?: boolean): string
Parameters
- style: TextStyle
- shadow: boolean = false
Returns string
Inherited from UiHandler.getTextColor
- Defined in src/ui/ui-handler.ts:36

getUi

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

processInput

processInput(button: Button): boolean
Parameters
- button: Button
Returns boolean
Overrides UiHandler.processInput
- Defined in src/ui/game-stats-ui-handler.ts:424

setCursor

setCursor(newCursor: number): boolean
Set the cursor to the specified position, if able and update the stats display.
Parameters
- newCursor: number
  The position to set the cursor to.
Returns boolean
Whether the cursor successfully moved to a new position

Remarks
If newCursor is not between 0 and maxCursorPos, or if it is the same as newCursor then no updates happen and false is returned.

Otherwise, updates the up/down arrow visibility and calls updateStats
Overrides UiHandler.setCursor
- Defined in src/ui/game-stats-ui-handler.ts:464

`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/ui-handler.ts:58

setup

setup(): void
Returns void
Overrides UiHandler.setup
- Defined in src/ui/game-stats-ui-handler.ts:301

show

show(args: any[]): boolean
Parameters
- args: any[]
Returns boolean
Overrides UiHandler.show
- Defined in src/ui/game-stats-ui-handler.ts:369