Class AdminUiHandler

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

Hierarchy (View Summary)

FormModalUiHandler
- AdminUiHandler

Constructors

constructor

new AdminUiHandler(mode?: null | UiMode): AdminUiHandler
Parameters
- mode: null | UiMode = null
Returns AdminUiHandler
Overrides FormModalUiHandler.constructor
- Defined in src/ui/handlers/admin-ui-handler.ts:40

Properties

active

active: boolean = false

`Private`adminMode

adminMode: AdminMode

`Private`adminResult

adminResult: SearchAccountResponse

`Protected`buttonBgs

buttonBgs: NineSlice[]

`Protected`buttonContainers

buttonContainers: Container[]

`Private` `Readonly`buttonGap

buttonGap: 10

`Protected`buttonLabels

buttonLabels: Text[]

`Protected`cancelAction

cancelAction: undefined | (() => void)

`Private`config

config: ModalConfig

`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[] = []

`Protected`modalBg

modalBg: NineSlice

`Protected`modalContainer

modalContainer: Container

`Protected`mode

mode: null | number

`Protected`submitAction

submitAction: undefined | AnyFn

`Private`tempGameData

tempGameData: null | GameData = null

`Protected`titleText

titleText: Text

`Protected`tween

tween: undefined | Tween

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 FormModalUiHandler.addInteractionHoverEffect
- Defined in src/ui/handlers/modal-ui-handler.ts:226

`Private`adminLinkUnlink

adminLinkUnlink(
    adminSearchResult: SearchAccountResponse,
    service: AdminUiHandlerService,
    mode: AdminUiHandlerServiceMode,
): Promise<
    | { adminSearchResult?: undefined; error: boolean; errorType: any }
    | {
        adminSearchResult: SearchAccountResponse;
        error: boolean;
        errorType?: undefined;
    },
>
Parameters
- adminSearchResult: SearchAccountResponse
- service: AdminUiHandlerService
- mode: AdminUiHandlerServiceMode
Returns Promise<
    | { adminSearchResult?: undefined; error: boolean; errorType: any }
    | {
        adminSearchResult: SearchAccountResponse;
        error: boolean;
        errorType?: undefined;
    },
>
- Defined in src/ui/handlers/admin-ui-handler.ts:367

`Private`adminSearch

adminSearch(
    adminSearchResult: SearchAccountResponse,
): Promise<
    | {
        adminSearchResult: SearchAccountResponse;
        error: boolean;
        errorType?: undefined;
    }
    | {
        adminSearchResult: SearchAccountResponse;
        error: boolean;
        errorType: undefined
        | string;
    }
    | { adminSearchResult?: undefined; error: boolean; errorType: any },
>
Parameters
- adminSearchResult: SearchAccountResponse
Returns Promise<
    | {
        adminSearchResult: SearchAccountResponse;
        error: boolean;
        errorType?: undefined;
    }
    | {
        adminSearchResult: SearchAccountResponse;
        error: boolean;
        errorType: undefined
        | string;
    }
    | { adminSearchResult?: undefined; error: boolean; errorType: any },
>
- Defined in src/ui/handlers/admin-ui-handler.ts:329

`Private`areFieldsValid

areFieldsValid(
adminMode: AdminMode,
service?: string,
): { error: boolean; errorMessage?: string }
Parameters
- adminMode: AdminMode
- Optionalservice: string
Returns { error: boolean; errorMessage?: string }
- Defined in src/ui/handlers/admin-ui-handler.ts:269

clear

clear(): void
Returns void
Overrides FormModalUiHandler.clear
- Defined in src/ui/handlers/admin-ui-handler.ts:427

`Private`convertInputsToAdmin

convertInputsToAdmin(): SearchAccountResponse
Returns SearchAccountResponse
- Defined in src/ui/handlers/admin-ui-handler.ts:318

destroy

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

Returns void
Inherited from FormModalUiHandler.destroy
- Defined in src/ui/handlers/ui-handler.ts:63

getButtonLabels

getButtonLabels(): string[]
Returns string[]
Overrides FormModalUiHandler.getButtonLabels
- Defined in src/ui/handlers/admin-ui-handler.ts:56

getButtonTopMargin

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

getCursor

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

getHeight

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

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/handlers/admin-ui-handler.ts:69

getMargin

getMargin(): [number, number, number, number]
Returns [number, number, number, number]
Overrides FormModalUiHandler.getMargin
- Defined in src/ui/handlers/admin-ui-handler.ts:52

getModalTitle

getModalTitle(): string
Returns string
Overrides FormModalUiHandler.getModalTitle
- Defined in src/ui/handlers/admin-ui-handler.ts:44

getReadableErrorMessage

getReadableErrorMessage(error: string): string
Parameters
- error: string
Returns string
Inherited from FormModalUiHandler.getReadableErrorMessage
- Defined in src/ui/handlers/form-modal-ui-handler.ts:43

hideLastButtons

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

`Private`populateAdminFields

populateAdminFields(adminResult: SearchAccountResponse): void
Parameters
- adminResult: SearchAccountResponse
Returns void
- Defined in src/ui/handlers/admin-ui-handler.ts:194

`Private`populateFields

populateFields(adminMode: AdminMode, adminResult: SearchAccountResponse): void
This is used to update the fields' text when loading in a new admin ui handler. It uses the adminResult to update the input text based on the adminMode. For a linking adminMode, it sets the username and discord. For a search adminMode, it sets the username. For an admin adminMode, it sets all the info from adminResult in the appropriate text boxes, and also sets the link/unlink icons for discord/google depending on the result
Parameters
- adminMode: AdminMode
- adminResult: SearchAccountResponse
Returns void
- Defined in src/ui/handlers/admin-ui-handler.ts:254

processInput

processInput(button: Button): boolean
Parameters
- button: Button
Returns boolean
Overrides FormModalUiHandler.processInput
- Defined in src/ui/handlers/admin-ui-handler.ts:96

sanitizeInputs

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

setCursor

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

`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 FormModalUiHandler.setMouseCursorStyle
- Defined in src/ui/handlers/ui-handler.ts:52

setup

setup(): void
Returns void
Inherited from FormModalUiHandler.setup
- Defined in src/ui/handlers/form-modal-ui-handler.ts:51

show

show(args: any[]): boolean
Parameters
- args: any[]
Returns boolean
Overrides FormModalUiHandler.show
- Defined in src/ui/handlers/admin-ui-handler.ts:105

showMessage

showMessage(
    message: string,
    adminResult: SearchAccountResponse,
    isError: boolean,
): void
Parameters
- message: string
- adminResult: SearchAccountResponse
- isError: boolean
Returns void
- Defined in src/ui/handlers/admin-ui-handler.ts:179

unhide

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

`Private`updateAdminPanelInfo

updateAdminPanelInfo(
adminSearchResult: SearchAccountResponse,
mode?: AdminMode,
): void
Parameters
- adminSearchResult: SearchAccountResponse
- Optionalmode: AdminMode
Returns void
- Defined in src/ui/handlers/admin-ui-handler.ts:384

updateContainer

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

`Protected`updateFields

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

`Private` `Static`ERR_REQUIRED_FIELD

ERR_REQUIRED_FIELD(field: string): string
Parameters
- field: string
Returns string
"[field] is required"
- Defined in src/ui/handlers/admin-ui-handler.ts:29

`Private` `Static`SUCCESS_SERVICE_MODE

SUCCESS_SERVICE_MODE(service: string, mode: string): string
Parameters
- service: string
- mode: string
Returns string
"Username and [service] successfully [mode]ed"
- Defined in src/ui/handlers/admin-ui-handler.ts:36

Class AdminUiHandler

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns AdminUiHandler

Properties

active

PrivateadminMode

PrivateadminResult

ProtectedbuttonBgs

ProtectedbuttonContainers

Private ReadonlybuttonGap

ProtectedbuttonLabels

ProtectedcancelAction

Privateconfig

Protectedcursor

Protectedediting

ProtectederrorMessage

ProtectedformLabels

ProtectedinputContainers

Protectedinputs

ProtectedmodalBg

ProtectedmodalContainer

Protectedmode

ProtectedsubmitAction

PrivatetempGameData

ProtectedtitleText

Protectedtween

Methods

ProtectedaddInteractionHoverEffect

Parameters

Returns void

PrivateadminLinkUnlink

Parameters

Returns Promise< | { adminSearchResult?: undefined; error: boolean; errorType: any } | { adminSearchResult: SearchAccountResponse; error: boolean; errorType?: undefined; },>

PrivateadminSearch

Parameters

Returns Promise< | { adminSearchResult: SearchAccountResponse; error: boolean; errorType?: undefined; } | { adminSearchResult: SearchAccountResponse; error: boolean; errorType: undefined | string; } | { adminSearchResult?: undefined; error: boolean; errorType: any },>

PrivateareFieldsValid

Parameters

Returns { error: boolean; errorMessage?: string }

clear

Returns void

PrivateconvertInputsToAdmin

Returns SearchAccountResponse

destroy

Returns void

getButtonLabels

Returns string[]

getButtonTopMargin

Returns number

getCursor

Returns number

getHeight

Parameters

Returns number

getInputFieldConfigs

Returns InputFieldConfig[]

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

PrivatepopulateAdminFields

`Private`adminMode

`Private`adminResult

`Protected`buttonBgs

`Protected`buttonContainers

`Private` `Readonly`buttonGap

`Protected`buttonLabels

`Protected`cancelAction

`Private`config

`Protected`cursor

`Protected`editing

`Protected`errorMessage

`Protected`formLabels

`Protected`inputContainers

`Protected`inputs

`Protected`modalBg

`Protected`modalContainer

`Protected`mode

`Protected`submitAction

`Private`tempGameData

`Protected`titleText

`Protected`tween

`Protected`addInteractionHoverEffect

`Private`adminLinkUnlink

Returns Promise<
| { adminSearchResult?: undefined; error: boolean; errorType: any }
| {
adminSearchResult: SearchAccountResponse;
error: boolean;
errorType?: undefined;
},
>

`Private`adminSearch

Returns Promise<
| {
adminSearchResult: SearchAccountResponse;
error: boolean;
errorType?: undefined;
}
| {
adminSearchResult: SearchAccountResponse;
error: boolean;
errorType: undefined
| string;
}
| { adminSearchResult?: undefined; error: boolean; errorType: any },
>

`Private`areFieldsValid

`Private`convertInputsToAdmin

`Private`populateAdminFields

`Private`populateFields

`Protected`setMouseCursorStyle

`Private`updateAdminPanelInfo

`Protected`updateFields

`Private` `Static`ERR_REQUIRED_FIELD

`Private` `Static`SUCCESS_SERVICE_MODE