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
- mode: null | Mode = null
Returns default
Overrides default.constructor
- Defined in src/ui/menu-ui-handler.ts:63

Properties

active

active: boolean = false

`Protected`awaitingActionInput

awaitingActionInput: boolean

bgmBar

bgmBar: default

`Protected`communityConfig

communityConfig: OptionSelectConfig

`Protected`cursor

cursor: number = 0

`Protected`manageDataConfig

manageDataConfig: OptionSelectConfig

message

message: Text

`Protected`mode

mode: null | number

`Protected`onActionInput

onActionInput: null | Function

`Protected`optionSelectText

optionSelectText: Text

pendingPrompt

pendingPrompt: boolean

prompt

prompt: Sprite

`Protected`scale

scale: number = 0.1666666667

`Protected`scene

scene: default

`Protected`textCallbackTimer

textCallbackTimer: null | TimerEvent

`Protected`textTimer

textTimer: null | TimerEvent

tutorialActive

tutorialActive: boolean = false

Methods

clear

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

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:656

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:434

processTutorialInput

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

render

render(): void
Returns void
- Defined in src/ui/menu-ui-handler.ts:107

setCursor

setCursor(cursor): boolean
Parameters
- cursor: number
Returns boolean
Overrides default.setCursor
- Defined in src/ui/menu-ui-handler.ts:634

setDialogTestMode

setDialogTestMode(isDialogMode): void
Switch the message window style and size when we are replaying dialog for debug purposes In "dialog test mode", the window takes the whole width of the screen and the text is set up to wrap around the same way as the dialogue during the game
Parameters
- isDialogMode: boolean
  whether to use the dialog test
Returns void
- Defined in src/ui/menu-ui-handler.ts:619

setup

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

show

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

showDialogue

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

showPrompt

showPrompt(callback?, callbackDelay?): void
Parameters
- Optionalcallback: null | Function
- OptionalcallbackDelay: null | 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:628