Class default`Abstract`

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

Hierarchy (view full)

default
- default
  - default
  - default

Index

Constructors

constructor

new default(scene, mode?): default
Parameters
- scene: default
- mode: null | Mode = null
Returns default
Overrides default.constructor
- Defined in src/ui/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

`Protected`scene

scene: default

tutorialActive

tutorialActive: boolean = false

tutorialOverlay

tutorialOverlay: Rectangle

Methods

clear

clear(): void
Returns void
Inherited from default.clear
- Defined in src/ui/ui-handler.ts:64

getCursor

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

getTextColor

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

getUi

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

initTutorialOverlay

initTutorialOverlay(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/awaitable-ui-handler.ts:33

`Abstract`processInput

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

processTutorialInput

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

setCursor

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

`Protected`setMouseCursorStyle

setMouseCursorStyle(cursorStyle): 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:60

`Abstract`setup

setup(): void
Returns void
Inherited from default.setup
- Defined in src/ui/ui-handler.ts:24

show

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