Class AlertModalUiHandler

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

Hierarchy (View Summary)

ModalUiHandler
- AlertModalUiHandler

Constructors

constructor

new AlertModalUiHandler(mode?: UiMode | null): AlertModalUiHandler
Parameters
- mode: UiMode | null = null
Returns AlertModalUiHandler
Overrides ModalUiHandler.constructor
- Defined in src/ui/handlers/alert-modal-ui-handler.ts:18

Properties

active

active: boolean = false

`Private`allowClosing

allowClosing: boolean = false

`Protected`buttonBgs

buttonBgs: NineSlice[]

`Protected`buttonContainers

buttonContainers: Container[]

`Protected`buttonLabels

buttonLabels: Text[]

`Protected`cursor

cursor: number = 0

`Private`height

height: number = 32

`Private`label

label: Text

`Protected`modalBg

modalBg: NineSlice

`Protected`modalContainer

modalContainer: Container

`Protected`mode

mode: number | null

`Private`overlay

overlay: Rectangle

`Protected`titleText

titleText: Text

`Private`width

width: number = 250

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

clear

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

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:63

getButtonLabels

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

getButtonTopMargin

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

getCursor

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

getHeight

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

getMargin

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

getModalTitle

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

getUi

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

getWidth

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

hideLastButtons

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

processInput

processInput(): boolean
Returns boolean
Overrides ModalUiHandler.processInput
- Defined in src/ui/handlers/alert-modal-ui-handler.ts:98

setCursor

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

`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:52

setup

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

show

show(args: [message: string, closeDelay?: number]): boolean
Show the alert modal with the specified message.
Parameters
- args: [message: string, closeDelay?: number]
  
  message: The message that will be displayed in the alert box.
  closeDelay: Optional delay before allowing the user to close the modal. If not provided, the alert will be unclosable.
Returns boolean
Overrides ModalUiHandler.show
- Defined in src/ui/handlers/alert-modal-ui-handler.ts:63

updateContainer

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