Class default

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

Hierarchy (View Summary)

default
- default

Index

Constructors

Properties

active cursor mode

Methods

clear destroy getCursor getTextColor getUi processInput setCursor setMouseCursorStyle setup show updateArrows updateStats

Constructors

constructor

new default(mode?: null | UiMode): default
Parameters
- mode: null | UiMode = null
Returns default
Overrides default.constructor
- Defined in src/ui/game-stats-ui-handler.ts:226

Properties

active

active: boolean = false

`Protected`cursor

cursor: number = 0

`Protected`mode

mode: null | number

Methods

clear

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

destroy

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

Returns void
Inherited from default.destroy
- Defined in src/ui/ui-handler.ts:69

getCursor

getCursor(): number
Returns number
Inherited from default.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 default.getTextColor
- Defined in src/ui/ui-handler.ts:36

getUi

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

processInput

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

setCursor

setCursor(cursor: number): boolean
Parameters
- cursor: number
Returns boolean
Overrides default.setCursor
- Defined in src/ui/game-stats-ui-handler.ts:398

`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 default.setMouseCursorStyle
- Defined in src/ui/ui-handler.ts:58

setup

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

show

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

updateArrows

updateArrows(): void
Show arrows at the top / bottom of the page if it's possible to scroll in that direction

Returns void
- Defined in src/ui/game-stats-ui-handler.ts:360

updateStats

updateStats(): void
Returns void
- Defined in src/ui/game-stats-ui-handler.ts:337