Class default`Abstract`

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

Hierarchy (view full)

default
- default

Constructors

constructor

new default(scene, mode): default
Parameters
- scene: default
- mode: Mode
Returns default
Overrides default.constructor
- Defined in src/ui/message-ui-handler.ts:14

Properties

active

active: boolean = false

`Protected` awaitingActionInput

awaitingActionInput: boolean

`Protected` cursor

cursor: number = 0

message

message: Text

`Protected` mode

mode: number

`Protected` onActionInput

onActionInput: Function

pendingPrompt

pendingPrompt: boolean

prompt

prompt: Sprite

`Protected` scene

scene: default

`Protected` textCallbackTimer

textCallbackTimer: TimerEvent

`Protected` textTimer

textTimer: TimerEvent

tutorialActive

tutorialActive: boolean = false

Methods

clear

clear(): void
Returns void
Overrides default.clear
- Defined in src/ui/message-ui-handler.ts:194

clearText

clearText(): void
Returns void
- Defined in src/ui/message-ui-handler.ts:189

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

`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
Inherited from default.processTutorialInput
- Defined in src/ui/awaitable-ui-handler.ts:15

setCursor

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

`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

showDialogue

showDialogue(text, name, delay?, callback?, callbackDelay?, prompt?, promptDelay?): void
Parameters
- text: string
- name: string
- Optional delay: number
- Optional callback: Function
- Optional callbackDelay: number
- Optional prompt: boolean
- Optional promptDelay: number
Returns void
- Defined in src/ui/message-ui-handler.ts:24

showPrompt

showPrompt(callback, callbackDelay): void
Parameters
- callback: Function
- callbackDelay: number
Returns void
- Defined in src/ui/message-ui-handler.ts:154

showText

showText(text, delay?, callback?, callbackDelay?, prompt?, promptDelay?): void
Parameters
- text: string
- Optional delay: number
- Optional callback: Function
- Optional callbackDelay: number
- Optional prompt: boolean
- Optional promptDelay: number
Returns void
- Defined in src/ui/message-ui-handler.ts:20

`Private` showTextInternal

showTextInternal(text, delay, callback, callbackDelay, prompt, promptDelay): void
Parameters
- text: string
- delay: number
- callback: Function
- callbackDelay: number
- prompt: boolean
- promptDelay: number
Returns void
- Defined in src/ui/message-ui-handler.ts:28