Class default

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

Hierarchy (view full)

ModalUiHandler
- default

Constructors

constructor

new default(scene, mode?): default
Parameters
- scene: default
- mode: null | Mode = null
Returns default
Overrides ModalUiHandler.constructor
- Defined in src/ui/loading-modal-ui-handler.ts:8

Properties

active

active: boolean = false

`Protected`buttonBgs

buttonBgs: NineSlice[]

`Protected`buttonContainers

buttonContainers: Container[]

`Protected`cursor

cursor: number = 0

`Protected`modalBg

modalBg: NineSlice

`Protected`modalContainer

modalContainer: Container

`Protected`mode

mode: null | number

`Protected`scene

scene: default

`Protected`titleText

titleText: Text

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

clear

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

getButtonLabels

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

getButtonTopMargin

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

getCursor

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

getHeight

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

getMargin

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

getModalTitle

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

getTextColor

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

getUi

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

getWidth

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

processInput

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

setCursor

setCursor(cursor): boolean
Parameters
- cursor: number
Returns boolean
Inherited from ModalUiHandler.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 ModalUiHandler.setMouseCursorStyle
- Defined in src/ui/ui-handler.ts:60

setup

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

show

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

updateContainer

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