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/save-slot-select-ui-handler.ts:40

Properties

active

active: boolean = false

`Protected` awaitingActionInput

awaitingActionInput: boolean

`Protected` cursor

cursor: number = 0

`Private` cursorObj

cursorObj: NineSlice

message

message: Text

`Protected` mode

mode: number

`Protected` onActionInput

onActionInput: Function

pendingPrompt

pendingPrompt: boolean

prompt

prompt: Sprite

`Private` saveSlotSelectCallback

saveSlotSelectCallback: SaveSlotSelectCallback

`Private` saveSlotSelectContainer

saveSlotSelectContainer: Container

`Private` saveSlotSelectMessageBox

saveSlotSelectMessageBox: NineSlice

`Private` saveSlotSelectMessageBoxContainer

saveSlotSelectMessageBoxContainer: Container

`Protected` scene

scene: default

`Private` scrollCursor

scrollCursor: number = 0

`Private` sessionSlots

sessionSlots: SessionSlot[]

`Private` sessionSlotsContainer

sessionSlotsContainer: Container

`Private` sessionSlotsContainerInitialY

sessionSlotsContainerInitialY: number

`Protected` textCallbackTimer

textCallbackTimer: TimerEvent

`Protected` textTimer

textTimer: TimerEvent

tutorialActive

tutorialActive: boolean = false

`Private` uiMode

uiMode: SaveSlotUiMode

Methods

clear

clear(): void
Returns void
Overrides default.clear
- Defined in src/ui/save-slot-select-ui-handler.ts:223

clearSessionSlots

clearSessionSlots(): void
Returns void
- Defined in src/ui/save-slot-select-ui-handler.ts:238

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/save-slot-select-ui-handler.ts:231

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

populateSessionSlots

populateSessionSlots(): void
Returns void
- Defined in src/ui/save-slot-select-ui-handler.ts:169

processInput

processInput(button): boolean
Parameters
- button: Button
Returns boolean
Overrides default.processInput
- Defined in src/ui/save-slot-select-ui-handler.ts:93

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/save-slot-select-ui-handler.ts:193

setScrollCursor

setScrollCursor(scrollCursor): boolean
Parameters
- scrollCursor: number
Returns boolean
- Defined in src/ui/save-slot-select-ui-handler.ts:206

setup

setup(): void
Returns void
Overrides default.setup
- Defined in src/ui/save-slot-select-ui-handler.ts:44

show

show(args): boolean
Parameters
- args: any[]
Returns boolean
Overrides default.show
- Defined in src/ui/save-slot-select-ui-handler.ts:75

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
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
- Optional delay: number
- Optional callback: Function
- Optional callbackDelay: number
- Optional prompt: boolean
- Optional promptDelay: number
Returns void
Overrides default.showText
- Defined in src/ui/save-slot-select-ui-handler.ts:179

Class default

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns default

Properties

active

Protected awaitingActionInput

Protected cursor

Private cursorObj

message

Protected mode

Protected onActionInput

pendingPrompt

prompt

Private saveSlotSelectCallback

Private saveSlotSelectContainer

Private saveSlotSelectMessageBox

Private saveSlotSelectMessageBoxContainer

Protected scene

Private scrollCursor

Private sessionSlots

Private sessionSlotsContainer

Private sessionSlotsContainerInitialY

Protected textCallbackTimer

Protected textTimer

tutorialActive

Private uiMode

Methods

clear

Returns void

clearSessionSlots

Returns void

clearText

Returns void

eraseCursor

Returns void

getCursor

Returns number

getTextColor

Parameters

Returns string

getUi

Returns default

populateSessionSlots

Returns void

processInput

Parameters

Returns boolean

processTutorialInput

Parameters

Returns boolean

setCursor

Parameters

Returns boolean

setScrollCursor

Parameters

Returns boolean

setup

Returns void

show

Parameters

Returns boolean

showDialogue

Parameters

Returns void

showPrompt

Parameters

Returns void

showText

Parameters

Returns void

Settings

Member Visibility

Theme

`Protected` awaitingActionInput

`Protected` cursor

`Private` cursorObj

`Protected` mode

`Protected` onActionInput

`Private` saveSlotSelectCallback

`Private` saveSlotSelectContainer

`Private` saveSlotSelectMessageBox

`Private` saveSlotSelectMessageBoxContainer

`Protected` scene

`Private` scrollCursor

`Private` sessionSlots

`Private` sessionSlotsContainer

`Private` sessionSlotsContainerInitialY

`Protected` textCallbackTimer

`Protected` textTimer

`Private` uiMode