Class default

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
- Optionalmode: Mode
Returns default
Overrides default.constructor
- Defined in src/ui/menu-ui-handler.ts:52

Properties

active

active: boolean = false

`Protected`awaitingActionInput

awaitingActionInput: boolean

bgmBar

bgmBar: default

`Protected`communityConfig

communityConfig: OptionSelectConfig

`Protected`cursor

cursor: number = 0

`Protected`ignoredMenuOptions

ignoredMenuOptions: MenuOptions[]

`Protected`manageDataConfig

manageDataConfig: OptionSelectConfig

`Protected`menuOptions

menuOptions: MenuOptions[]

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

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

clearText

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

eraseCursor

eraseCursor(): void
Returns void
- Defined in src/ui/menu-ui-handler.ts:502

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

processInput

processInput(button): boolean
Parameters
- button: Button
Returns boolean
Overrides default.processInput
- Defined in src/ui/menu-ui-handler.ts:300

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
Overrides default.setCursor
- Defined in src/ui/menu-ui-handler.ts:481

setup

setup(): void
Returns void
Overrides default.setup
- Defined in src/ui/menu-ui-handler.ts:61

show

show(args): boolean
Parameters
- args: any[]
Returns boolean
Overrides default.show
- Defined in src/ui/menu-ui-handler.ts:279

showDialogue

showDialogue(text, name, delay?, callback?, callbackDelay?, prompt?, promptDelay?): void
Parameters
- text: string
- name: string
- Optionaldelay: number
- Optionalcallback: Function
- OptionalcallbackDelay: number
- Optionalprompt: boolean
- OptionalpromptDelay: number
Returns void
Inherited from default.showDialogue
- Defined in src/ui/message-ui-handler.ts:24

showPrompt

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

showText

showText(text, delay?, callback?, callbackDelay?, prompt?, promptDelay?): void
Parameters
- text: string
- Optionaldelay: number
- Optionalcallback: Function
- OptionalcallbackDelay: number
- Optionalprompt: boolean
- OptionalpromptDelay: number
Returns void
Overrides default.showText
- Defined in src/ui/menu-ui-handler.ts:475