Class MessageUiHandler`Abstract`

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

Hierarchy (View Summary)

AwaitableUiHandler
- MessageUiHandler

Constructors

constructor

new MessageUiHandler(mode?: UiMode | null): MessageUiHandler
Parameters
- mode: UiMode | null = null
Returns MessageUiHandler
Overrides AwaitableUiHandler.constructor
- Defined in src/ui/handlers/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 | null

`Protected`onActionInput

onActionInput: AnyFn | null

pendingPrompt

pendingPrompt: boolean

prompt

prompt: Sprite

`Protected`textCallbackTimer

textCallbackTimer: TimerEvent | null

`Protected`textTimer

textTimer: TimerEvent | null

tutorialActive

tutorialActive: boolean = false

tutorialOverlay

tutorialOverlay: Rectangle

Methods

clear

clear(): void
Returns void
Overrides AwaitableUiHandler.clear
- Defined in src/ui/handlers/message-ui-handler.ts:272

clearText

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

destroy

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

Returns void
Inherited from AwaitableUiHandler.destroy
- Defined in src/ui/handlers/ui-handler.ts:63

getCursor

getCursor(): number
Returns number
Inherited from AwaitableUiHandler.getCursor
- Defined in src/ui/handlers/ui-handler.ts:34

getUi

getUi(): UI
Returns UI
Inherited from AwaitableUiHandler.getUi
- Defined in src/ui/handlers/ui-handler.ts:30

initPromptSprite

initPromptSprite(container: Container): void
Add the sprite to be displayed at the end of messages with prompts
Parameters
- container: Container
  the container to add the sprite to
Returns void
- Defined in src/ui/handlers/message-ui-handler.ts:24

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
Inherited from AwaitableUiHandler.initTutorialOverlay
- Defined in src/ui/handlers/awaitable-ui-handler.ts:36

isTextAnimationInProgress

isTextAnimationInProgress(): boolean
Returns boolean
- Defined in src/ui/handlers/message-ui-handler.ts:259

`Abstract`processInput

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

processTutorialInput

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

setCursor

setCursor(cursor: number): boolean
Parameters
- cursor: number
Returns boolean
Inherited from AwaitableUiHandler.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 AwaitableUiHandler.setMouseCursorStyle
- Defined in src/ui/handlers/ui-handler.ts:52

`Abstract`setup

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

show

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

showDialogue

showDialogue(
    text: string,
    _name?: string,
    delay?: number | null,
    callback?: (() => void) | null,
    callbackDelay?: number | null,
    prompt?: boolean | null,
    promptDelay?: number | null,
): void
Parameters
- text: string
- Optional_name: string
- Optionaldelay: number | null
- Optionalcallback: (() => void) | null
- OptionalcallbackDelay: number | null
- Optionalprompt: boolean | null
- OptionalpromptDelay: number | null
Returns void
- Defined in src/ui/handlers/message-ui-handler.ts:48

showPrompt

showPrompt(callback?: (() => void) | null, callbackDelay?: number | null): void
Parameters
- Optionalcallback: (() => void) | null
- OptionalcallbackDelay: number | null
Returns void
- Defined in src/ui/handlers/message-ui-handler.ts:222

showText

showText(
    text: string,
    delay?: number | null,
    callback?: (() => void) | null,
    callbackDelay?: number | null,
    prompt?: boolean | null,
    promptDelay?: number | null,
): void
Parameters
- text: string
- Optionaldelay: number | null
- Optionalcallback: (() => void) | null
- OptionalcallbackDelay: number | null
- Optionalprompt: boolean | null
- OptionalpromptDelay: number | null
Returns void
- Defined in src/ui/handlers/message-ui-handler.ts:37

`Private`showTextInternal

showTextInternal(
    text: string,
    delay?: number | null,
    callback?: (() => void) | null,
    callbackDelay?: number | null,
    prompt?: boolean | null,
    promptDelay?: number | null,
): void
Parameters
- text: string
- Optionaldelay: number | null
- Optionalcallback: (() => void) | null
- OptionalcallbackDelay: number | null
- Optionalprompt: boolean | null
- OptionalpromptDelay: number | null
Returns void
- Defined in src/ui/handlers/message-ui-handler.ts:60