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): default
Parameters
- scene: default
Returns default
Overrides default.constructor
- Defined in src/ui/evolution-scene-handler.ts:14

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

clear(): void
Returns void
Overrides default.clear
- Defined in src/ui/evolution-scene-handler.ts:92

clearText

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

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/evolution-scene-handler.ts:68

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/evolution-scene-handler.ts:88

setup

setup(): void
Returns void
Overrides default.setup
- Defined in src/ui/evolution-scene-handler.ts:18

show

show(_args): boolean
Parameters
- _args: any[]
Returns boolean
Overrides default.show
- Defined in src/ui/evolution-scene-handler.ts:56

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
Inherited from default.showText
- Defined in src/ui/message-ui-handler.ts:20

Class default

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns default

Properties

active

ProtectedawaitingActionInput

canCancel

cancelled

Protectedcursor

evolutionContainer

message

messageBg

messageContainer

Protectedmode

ProtectedonActionInput

pendingPrompt

prompt

Protectedscene

ProtectedtextCallbackTimer

ProtectedtextTimer

tutorialActive

Methods

clear

Returns void

clearText

Returns void

getCursor

Returns number

getTextColor

Parameters

Returns string

getUi

Returns default

processInput

Parameters

Returns boolean

processTutorialInput

Parameters

Returns boolean

setCursor

Parameters

Returns boolean

setup

Returns void

show

Parameters

Returns boolean

showDialogue

Parameters

Returns void

showPrompt

Parameters

Returns void

showText

Parameters

Returns void

Settings

On This Page

`Protected`awaitingActionInput

`Protected`cursor

`Protected`mode

`Protected`onActionInput

`Protected`scene

`Protected`textCallbackTimer

`Protected`textTimer