Class AwaitableUiHandler`Abstract`

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

Hierarchy (View Summary)

UiHandler
- AwaitableUiHandler
  - MessageUiHandler
  - ModifierSelectUiHandler

Index

Constructors

Properties

active awaitingActionInput cursor mode onActionInput tutorialActive tutorialOverlay

Methods

clear destroy getCursor getUi initTutorialOverlay processInput processTutorialInput setCursor setMouseCursorStyle setup show

Constructors

constructor

new AwaitableUiHandler(mode?: null | UiMode): AwaitableUiHandler
Parameters
- mode: null | UiMode = null
Returns AwaitableUiHandler
Overrides UiHandler.constructor
- Defined in src/ui/handlers/awaitable-ui-handler.ts:12

Properties

active

active: boolean = false

`Protected`awaitingActionInput

awaitingActionInput: boolean

`Protected`cursor

cursor: number = 0

`Protected`mode

mode: null | number

`Protected`onActionInput

onActionInput: null | Function

tutorialActive

tutorialActive: boolean = false

tutorialOverlay

tutorialOverlay: Rectangle

Methods

clear

clear(): void
Returns void
Inherited from UiHandler.clear
- Defined in src/ui/handlers/ui-handler.ts:56

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

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

initTutorialOverlay

initTutorialOverlay(container: Container): void
Create a semi transparent overlay that will get shown during tutorials
Parameters
- container: Container
  the container to add the overlay to
Returns void
- Defined in src/ui/handlers/awaitable-ui-handler.ts:33

`Abstract`processInput

processInput(button: Button): boolean
Parameters
- button: Button
Returns boolean
Inherited from UiHandler.processInput
- Defined in src/ui/handlers/ui-handler.ts:28

processTutorialInput

processTutorialInput(button: Button): boolean
Parameters
- button: Button
Returns boolean
- Defined in src/ui/handlers/awaitable-ui-handler.ts:16

setCursor

setCursor(cursor: number): boolean
Parameters
- cursor: number
Returns boolean
Inherited from UiHandler.setCursor
- Defined in src/ui/handlers/ui-handler.ts:38

`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

`Abstract`setup

setup(): void
Returns void
Inherited from UiHandler.setup
- Defined in src/ui/handlers/ui-handler.ts:20

show

show(_args: any[]): boolean
Parameters
- _args: any[]
Returns boolean
Inherited from UiHandler.show
- Defined in src/ui/handlers/ui-handler.ts:22