Class default

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

Hierarchy (view full)

Constructors

constructor

Properties

active awaitingActionInput communityConfig cursor cursorObj ignoredMenuOptions manageDataConfig menuBg menuContainer menuMessageBoxContainer menuOptions menuOverlay message mode onActionInput optionSelectText pendingPrompt prompt scene textCallbackTimer textTimer tutorialActive

Methods

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

Constructors

constructor

Properties

active

active: boolean = false

Protected awaitingActionInput

awaitingActionInput: boolean

Protected communityConfig

communityConfig: OptionSelectConfig

Protected cursor

cursor: number = 0

Private cursorObj

cursorObj: Image

Protected ignoredMenuOptions

ignoredMenuOptions: MenuOptions[]

Protected manageDataConfig

manageDataConfig: OptionSelectConfig

Private menuBg

menuBg: NineSlice

Private menuContainer

menuContainer: Container

Private menuMessageBoxContainer

menuMessageBoxContainer: Container

Protected menuOptions

menuOptions: MenuOptions[]

Private menuOverlay

menuOverlay: Rectangle

message

message: Text

Protected mode

mode: number

Protected onActionInput

onActionInput: Function

Protected optionSelectText

optionSelectText: Text

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

eraseCursor

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

constructoractiveawaitingActionInputcommunityConfigcursorcursorObjignoredMenuOptionsmanageDataConfigmenuBgmenuContainermenuMessageBoxContainermenuOptionsmenuOverlaymessagemodeonActionInputoptionSelectTextpendingPromptpromptscenetextCallbackTimertextTimertutorialActiveclearclearTexteraseCursorgetCursorgetTextColorgetUiprocessInputprocessTutorialInputsetCursorsetupshowshowDialogueshowPromptshowText