Class default

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

Hierarchy (view full)

FormModalUiHandler
- default

Constructors

constructor

new default(scene, mode): default
Parameters
- scene: any
- mode: any
Returns default
Overrides FormModalUiHandler.constructor
- Defined in src/ui/test-dialogue-ui-handler.ts:13

Properties

active

active: boolean = false

`Protected`buttonBgs

buttonBgs: NineSlice[]

`Protected`buttonContainers

buttonContainers: Container[]

`Protected`buttonLabels

buttonLabels: Text[]

`Protected`cursor

cursor: number = 0

`Protected`editing

editing: boolean

`Protected`errorMessage

errorMessage: Text

`Protected`formLabels

formLabels: Text[]

`Protected`inputContainers

inputContainers: Container[]

`Protected`inputs

inputs: InputText[]

keys

keys: string[]

`Protected`modalBg

modalBg: NineSlice

`Protected`modalContainer

modalContainer: Container

`Protected`mode

mode: null | number

`Protected`scene

scene: default

`Protected`submitAction

submitAction: null | Function

`Protected`titleText

titleText: Text

`Protected`tween

tween: Tween

Methods

`Protected`addInteractionHoverEffect

addInteractionHoverEffect(gameObject): void
Adds a hover effect to a game object which changes the cursor to a pointer and tints it slighly
Parameters
- gameObject: Sprite | Image | NineSlice
  the game object to add hover events/effects to
Returns void
Inherited from FormModalUiHandler.addInteractionHoverEffect
- Defined in src/ui/modal-ui-handler.ts:171

clear

clear(): void
Returns void
Inherited from FormModalUiHandler.clear
- Defined in src/ui/form-modal-ui-handler.ts:158

getButtonLabels

getButtonLabels(config?): string[]
Parameters
- Optionalconfig: ModalConfig
Returns string[]
Overrides FormModalUiHandler.getButtonLabels
- Defined in src/ui/test-dialogue-ui-handler.ts:54

getButtonTopMargin

getButtonTopMargin(): number
Returns number
Inherited from FormModalUiHandler.getButtonTopMargin
- Defined in src/ui/modal-ui-handler.ts:38

getCursor

getCursor(): number
Returns number
Inherited from FormModalUiHandler.getCursor
- Defined in src/ui/ui-handler.ts:42

getHeight

getHeight(config?): number
Parameters
- Optionalconfig: ModalConfig
Returns number
Inherited from FormModalUiHandler.getHeight
- Defined in src/ui/form-modal-ui-handler.ts:39

getInputFieldConfigs

getInputFieldConfigs(): InputFieldConfig[]
Get configuration for all fields that should be part of the modal Gets used by updateFields to add the proper text inputs and labels to the view

Returns InputFieldConfig[]
array of InputFieldConfig
Overrides FormModalUiHandler.getInputFieldConfigs
- Defined in src/ui/test-dialogue-ui-handler.ts:67

getMargin

getMargin(config?): [number, number, number, number]
Parameters
- Optionalconfig: ModalConfig
Returns [number, number, number, number]
Overrides FormModalUiHandler.getMargin
- Defined in src/ui/test-dialogue-ui-handler.ts:50

getModalTitle

getModalTitle(config?): string
Parameters
- Optionalconfig: ModalConfig
Returns string
Overrides FormModalUiHandler.getModalTitle
- Defined in src/ui/test-dialogue-ui-handler.ts:42

getReadableErrorMessage

getReadableErrorMessage(error): string
Parameters
- error: string
Returns string
Overrides FormModalUiHandler.getReadableErrorMessage
- Defined in src/ui/test-dialogue-ui-handler.ts:58

getTextColor

getTextColor(style, shadow?): string
Parameters
- style: TextStyle
- shadow: boolean = false
Returns string
Inherited from FormModalUiHandler.getTextColor
- Defined in src/ui/ui-handler.ts:38

getUi

getUi(): default
Returns default
Inherited from FormModalUiHandler.getUi
- Defined in src/ui/ui-handler.ts:34

getWidth

getWidth(config?): number
Parameters
- Optionalconfig: ModalConfig
Returns number
Overrides FormModalUiHandler.getWidth
- Defined in src/ui/test-dialogue-ui-handler.ts:46

processInput

processInput(button): boolean
Parameters
- button: Button
Returns boolean
Inherited from FormModalUiHandler.processInput
- Defined in src/ui/form-modal-ui-handler.ts:136

sanitizeInputs

sanitizeInputs(): void
Returns void
Inherited from FormModalUiHandler.sanitizeInputs
- Defined in src/ui/form-modal-ui-handler.ts:145

setCursor

setCursor(cursor): boolean
Parameters
- cursor: number
Returns boolean
Inherited from FormModalUiHandler.setCursor
- Defined in src/ui/ui-handler.ts:46

`Protected`setMouseCursorStyle

setMouseCursorStyle(cursorStyle): void
Changes the style of the mouse cursor.
Parameters
- cursorStyle: "default" | "pointer"
  cursor style to apply
Returns void
See
https://developer.mozilla.org/en-US/docs/Web/CSS/cursor
Inherited from FormModalUiHandler.setMouseCursorStyle
- Defined in src/ui/ui-handler.ts:60

setup

setup(): void
Returns void
Overrides FormModalUiHandler.setup
- Defined in src/ui/test-dialogue-ui-handler.ts:17

show

show(args): boolean
Parameters
- args: any[]
Returns boolean
Overrides FormModalUiHandler.show
- Defined in src/ui/test-dialogue-ui-handler.ts:71

updateContainer

updateContainer(config?): void
Parameters
- Optionalconfig: ModalConfig
Returns void
Inherited from FormModalUiHandler.updateContainer
- Defined in src/ui/form-modal-ui-handler.ts:151

`Protected`updateFields

updateFields(fieldsConfig, hasTitle): void
Parameters
- fieldsConfig: InputFieldConfig[]
- hasTitle: boolean
Returns void
Inherited from FormModalUiHandler.updateFields
- Defined in src/ui/form-modal-ui-handler.ts:69

Class default

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns default

Properties

active

ProtectedbuttonBgs

ProtectedbuttonContainers

ProtectedbuttonLabels

Protectedcursor

Protectedediting

ProtectederrorMessage

ProtectedformLabels

ProtectedinputContainers

Protectedinputs

keys

ProtectedmodalBg

ProtectedmodalContainer

Protectedmode

Protectedscene

ProtectedsubmitAction

ProtectedtitleText

Protectedtween

Methods

ProtectedaddInteractionHoverEffect

Parameters

Returns void

clear

Returns void

getButtonLabels

Parameters

Returns string[]

getButtonTopMargin

Returns number

getCursor

Returns number

getHeight

Parameters

Returns number

getInputFieldConfigs

Returns InputFieldConfig[]

getMargin

Parameters

Returns [number, number, number, number]

getModalTitle

Parameters

Returns string

getReadableErrorMessage

Parameters

Returns string

getTextColor

Parameters

Returns string

getUi

Returns default

getWidth

Parameters

Returns number

processInput

Parameters

Returns boolean

sanitizeInputs

Returns void

setCursor

Parameters

Returns boolean

ProtectedsetMouseCursorStyle

Parameters

Returns void

See

setup

Returns void

show

Parameters

`Protected`buttonBgs

`Protected`buttonContainers

`Protected`buttonLabels

`Protected`cursor

`Protected`editing

`Protected`errorMessage

`Protected`formLabels

`Protected`inputContainers

`Protected`inputs

`Protected`modalBg

`Protected`modalContainer

`Protected`mode

`Protected`scene

`Protected`submitAction

`Protected`titleText

`Protected`tween

`Protected`addInteractionHoverEffect

`Protected`setMouseCursorStyle

`Protected`updateFields