Class UiHandler`Abstract`

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

Hierarchy (View Summary)

UiHandler

Index

Constructors

Properties

active cursor mode

Methods

clear destroy getCursor getTextColor getUi processInput setCursor setMouseCursorStyle setup show

Constructors

constructor

new UiHandler(mode?: null | UiMode): UiHandler
Parameters
- mode: null | UiMode = null
  The mode of the UI element. These should be unique.
Returns UiHandler
- 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
- Defined in src/ui/ui-handler.ts:62

destroy

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

Returns void
- Defined in src/ui/ui-handler.ts:69

getCursor

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

getTextColor

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

getUi

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

`Abstract`processInput

processInput(button: Button): boolean
Parameters
- button: Button
Returns boolean
- Defined in src/ui/ui-handler.ts:30

setCursor

setCursor(cursor: number): boolean
Parameters
- cursor: number
Returns boolean
- Defined in src/ui/ui-handler.ts:44

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

`Abstract`setup

setup(): void
Returns void
- Defined in src/ui/ui-handler.ts:22

show

show(_args: any[]): boolean
Parameters
- _args: any[]
Returns boolean
- Defined in src/ui/ui-handler.ts:24