Class default

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

Hierarchy (view full)

Constructors

constructor

Properties

active awaitingActionInput canCancel cancelled cursor evolutionContainer message messageBg messageContainer mode onActionInput pendingPrompt prompt scene textCallbackTimer textTimer tutorialActive

Methods

clear clearText getCursor getTextColor getUi processInput processTutorialInput setCursor setup show showDialogue showPrompt showText

Constructors

constructor

Properties

active

active: boolean = false

Protected awaitingActionInput

awaitingActionInput: boolean

canCancel

canCancel: boolean

cancelled

cancelled: boolean

Protected cursor

cursor: number = 0

evolutionContainer

evolutionContainer: Container

message

message: Text

messageBg

messageBg: Image

messageContainer

messageContainer: Container

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

clearText

getCursor

getTextColor

getUi

processInput

processTutorialInput

setCursor

setup

show

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

showPrompt

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

Settings

Member Visibility

Theme

On This Page

constructoractiveawaitingActionInputcanCancelcancelledcursorevolutionContainermessagemessageBgmessageContainermodeonActionInputpendingPromptpromptscenetextCallbackTimertextTimertutorialActiveclearclearTextgetCursorgetTextColorgetUiprocessInputprocessTutorialInputsetCursorsetupshowshowDialogueshowPromptshowText