Class LoginOrRegisterUiHandler

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

Hierarchy (View Summary)

LoginRegisterInfoContainerUiHandler
- LoginOrRegisterUiHandler

Constructors

constructor

new LoginOrRegisterUiHandler(mode?: UiMode | null): LoginOrRegisterUiHandler
Parameters
- mode: UiMode | null = null
Returns LoginOrRegisterUiHandler
Inherited from LoginRegisterInfoContainerUiHandler.constructor
- Defined in src/ui/handlers/modal-ui-handler.ts:21

Properties

active

active: boolean = false

`Protected`buttonBgs

buttonBgs: NineSlice[]

`Protected`buttonContainers

buttonContainers: Container[]

`Protected`buttonLabels

buttonLabels: Text[]

`Protected`cancelAction

cancelAction: (() => void) | undefined

`Protected`cursor

cursor: number = 0

`Protected`editing

editing: boolean = false

`Protected`errorMessage

errorMessage: Text

`Protected`formLabels

formLabels: Text[] = []

`Protected`inputContainers

inputContainers: Container[] = []

`Protected`inputs

inputs: InputText[] = []

`Private`logo

logo: Image

`Protected`modalBg

modalBg: NineSlice

`Protected`modalContainer

modalContainer: Container

`Protected`mode

mode: number | null

`Protected`submitAction

submitAction: (() => void) | undefined

`Protected`titleText

titleText: Text

`Protected`tween

tween: Tween | undefined

Methods

`Protected`addInteractionHoverEffect

addInteractionHoverEffect(gameObject: Sprite | Image | NineSlice): 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 LoginRegisterInfoContainerUiHandler.addInteractionHoverEffect
- Defined in src/ui/handlers/modal-ui-handler.ts:226

`Protected`buildInteractableImage

buildInteractableImage(
    texture: string,
    name: string,
    opts?: BuildInteractableImageOpts,
): Image
Parameters
- texture: string
- name: string
- opts: BuildInteractableImageOpts = {}
Returns Image
Inherited from LoginRegisterInfoContainerUiHandler.buildInteractableImage
- Defined in src/ui/handlers/login-register-info-container-ui-handler.ts:221

clear

clear(): void
Returns void
Overrides LoginRegisterInfoContainerUiHandler.clear
- Defined in src/ui/handlers/login-or-register-ui-handler.ts:58

destroy

destroy(): void
To be implemented by individual handlers when necessary to free memory Called when BattleScene is reset

Returns void
Overrides LoginRegisterInfoContainerUiHandler.destroy
- Defined in src/ui/handlers/login-or-register-ui-handler.ts:66

getInputFieldConfigs

getInputFieldConfigs(): InputFieldConfig[]
Get configuration for all fields that should be part of the modal

Returns InputFieldConfig[]
array of InputFieldConfig

Remarks
Gets used by updateFields to add the proper text inputs and labels to the view
Overrides LoginRegisterInfoContainerUiHandler.getInputFieldConfigs
- Defined in src/ui/handlers/login-or-register-ui-handler.ts:32

getMargin

getMargin(): [number, number, number, number]
Returns [number, number, number, number]
Overrides LoginRegisterInfoContainerUiHandler.getMargin
- Defined in src/ui/handlers/login-or-register-ui-handler.ts:24

getModalTitle

getModalTitle(): string
Returns string
Overrides LoginRegisterInfoContainerUiHandler.getModalTitle
- Defined in src/ui/handlers/login-or-register-ui-handler.ts:11

getReadableErrorMessage

getReadableErrorMessage(error: string): string
Parameters
- error: string
Returns string
Inherited from LoginRegisterInfoContainerUiHandler.getReadableErrorMessage
- Defined in src/ui/handlers/login-register-info-container-ui-handler.ts:41

getUi

getUi(): UI
Returns UI
Inherited from LoginRegisterInfoContainerUiHandler.getUi
- Defined in src/ui/handlers/ui-handler.ts:30

getWidth

getWidth(): number
Returns number
Overrides LoginRegisterInfoContainerUiHandler.getWidth
- Defined in src/ui/handlers/login-or-register-ui-handler.ts:15

hide

hide(): void
Returns void
Inherited from LoginRegisterInfoContainerUiHandler.hide
- Defined in src/ui/handlers/form-modal-ui-handler.ts:192

hideLastButtons

hideLastButtons(hideCount?: number): void
Parameters
- hideCount: number = 0
Returns void
Inherited from LoginRegisterInfoContainerUiHandler.hideLastButtons
- Defined in src/ui/handlers/modal-ui-handler.ts:185

processInput

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

sanitizeInputs

sanitizeInputs(): void
Returns void
Inherited from LoginRegisterInfoContainerUiHandler.sanitizeInputs
- Defined in src/ui/handlers/form-modal-ui-handler.ts:178

setCursor

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

setInteractive

setInteractive(active: boolean): void
Enable or disable interactivity on all interactive objects.
Parameters
- active: boolean
  Whether to enable or disable interactivity
Returns void
Inherited from LoginRegisterInfoContainerUiHandler.setInteractive
- Defined in src/ui/handlers/login-register-info-container-ui-handler.ts:242

`Protected`setMouseCursorStyle

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

setup

setup(): void
Returns void
Overrides LoginRegisterInfoContainerUiHandler.setup
- Defined in src/ui/handlers/login-or-register-ui-handler.ts:36

show

show(args: [ModalConfig, ...any[]]): boolean
Parameters
- args: [ModalConfig, ...any[]]
Returns boolean
Overrides LoginRegisterInfoContainerUiHandler.show
- Defined in src/ui/handlers/login-or-register-ui-handler.ts:47

`Protected`showInfoContainer

showInfoContainer(config: ModalConfig): void
Parameters
- config: ModalConfig
Returns void
Inherited from LoginRegisterInfoContainerUiHandler.showInfoContainer
- Defined in src/ui/handlers/login-register-info-container-ui-handler.ts:96

unhide

unhide(): void
Returns void
Inherited from LoginRegisterInfoContainerUiHandler.unhide
- Defined in src/ui/handlers/form-modal-ui-handler.ts:199

updateContainer

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

`Protected`updateFields

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

Class LoginOrRegisterUiHandler

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns LoginOrRegisterUiHandler

Properties

active

ProtectedbuttonBgs

ProtectedbuttonContainers

ProtectedbuttonLabels

ProtectedcancelAction

Protectedcursor

Protectedediting

ProtectederrorMessage

ProtectedformLabels

ProtectedinputContainers

Protectedinputs

Privatelogo

ProtectedmodalBg

ProtectedmodalContainer

Protectedmode

ProtectedsubmitAction

ProtectedtitleText

Protectedtween

Methods

ProtectedaddInteractionHoverEffect

Parameters

Returns void

ProtectedbuildInteractableImage

Parameters

Returns Image

clear

Returns void

destroy

Returns void

getButtonLabels

Returns string[]

getButtonTopMargin

Returns number

getCursor

Returns number

getHeight

Returns number

getInputFieldConfigs

Returns InputFieldConfig[]

Remarks

getMargin

Returns [number, number, number, number]

getModalTitle

Returns string

getReadableErrorMessage

Parameters

Returns string

getUi

Returns UI

getWidth

Returns number

hide

Returns void

hideLastButtons

Parameters

Returns void

processInput

Parameters

Returns boolean

sanitizeInputs

Returns void

setCursor

Parameters

Returns boolean

setInteractive

Parameters

Returns void

ProtectedsetMouseCursorStyle

Parameters

`Protected`buttonBgs

`Protected`buttonContainers

`Protected`buttonLabels

`Protected`cancelAction

`Protected`cursor

`Protected`editing

`Protected`errorMessage

`Protected`formLabels

`Protected`inputContainers

`Protected`inputs

`Private`logo

`Protected`modalBg

`Protected`modalContainer

`Protected`mode

`Protected`submitAction

`Protected`titleText

`Protected`tween

`Protected`addInteractionHoverEffect

`Protected`buildInteractableImage

`Protected`setMouseCursorStyle

`Protected`showInfoContainer

`Protected`updateFields