Class LoadingModalUiHandler

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

Hierarchy (View Summary)

ModalUiHandler
- LoadingModalUiHandler

Constructors

constructor

new LoadingModalUiHandler(): LoadingModalUiHandler

Returns LoadingModalUiHandler

Inherited from ModalUiHandler.constructor

Properties

active

active: boolean = false

`Protected`buttonBgs

buttonBgs: NineSlice[] = []

`Protected`buttonContainers

buttonContainers: Container[] = []

`Protected`buttonLabels

buttonLabels: Text[] = []

`Protected`cursor

cursor: number = 0

`Protected`modalBg

modalBg: NineSlice

`Protected`modalContainer

modalContainer: Container

`Protected`titleText

titleText: Text

Methods

`Protected`addInteractionHoverEffect

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

clear

clear(): void
Returns void
Inherited from ModalUiHandler.clear
- Defined in src/ui/handlers/modal-ui-handler.ts:203

destroy

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

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

getButtonLabels

getButtonLabels(): string[]
Returns string[]
Overrides ModalUiHandler.getButtonLabels
- Defined in src/ui/handlers/loading-modal-ui-handler.ts:23

getButtonTopMargin

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

getCursor

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

getHeight

getHeight(): number
Returns number
Overrides ModalUiHandler.getHeight
- Defined in src/ui/handlers/loading-modal-ui-handler.ts:15

getMargin

getMargin(): [number, number, number, number]
Returns [number, number, number, number]
Overrides ModalUiHandler.getMargin
- Defined in src/ui/handlers/loading-modal-ui-handler.ts:19

getModalTitle

getModalTitle(): string
Returns string
Overrides ModalUiHandler.getModalTitle
- Defined in src/ui/handlers/loading-modal-ui-handler.ts:7

getUi

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

getWidth

getWidth(): number
Returns number
Overrides ModalUiHandler.getWidth
- Defined in src/ui/handlers/loading-modal-ui-handler.ts:11

hideLastButtons

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

processInput

processInput(_button: Button): boolean
Parameters
- _button: Button
Returns boolean
Inherited from ModalUiHandler.processInput
- Defined in src/ui/handlers/modal-ui-handler.ts:199

setCursor

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

`Protected`setMouseCursorStyle

setMouseCursorStyle(cursorStyle: "default" | "pointer"): 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 ModalUiHandler.setMouseCursorStyle
- Defined in src/ui/handlers/ui-handler.ts:43

setup

setup(): void
Returns void
Overrides ModalUiHandler.setup
- Defined in src/ui/handlers/loading-modal-ui-handler.ts:27

show

show(args: any[]): boolean
Parameters
- args: any[]
Returns boolean
Inherited from ModalUiHandler.show
- Defined in src/ui/handlers/modal-ui-handler.ts:87

updateContainer

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