Class ModalUiHandler`Abstract`

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

Hierarchy (view full)

default
- ModalUiHandler

Constructors

constructor

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

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`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
- Defined in src/ui/modal-ui-handler.ts:171

clear

clear(): void
Returns void
Overrides default.clear
- Defined in src/ui/modal-ui-handler.ts:160

`Abstract`getButtonLabels

getButtonLabels(config?): string[]
Parameters
- Optionalconfig: ModalConfig
Returns string[]
- Defined in src/ui/modal-ui-handler.ts:36

getButtonTopMargin

getButtonTopMargin(): number
Returns number
- Defined in src/ui/modal-ui-handler.ts:38

getCursor

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

`Abstract`getHeight

getHeight(config?): number
Parameters
- Optionalconfig: ModalConfig
Returns number
- Defined in src/ui/modal-ui-handler.ts:32

`Abstract`getMargin

getMargin(config?): [number, number, number, number]
Parameters
- Optionalconfig: ModalConfig
Returns [number, number, number, number]
- Defined in src/ui/modal-ui-handler.ts:34

`Abstract`getModalTitle

getModalTitle(config?): string
Parameters
- Optionalconfig: ModalConfig
Returns string
- Defined in src/ui/modal-ui-handler.ts:28

getTextColor

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

getUi

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

`Abstract`getWidth

getWidth(config?): number
Parameters
- Optionalconfig: ModalConfig
Returns number
- Defined in src/ui/modal-ui-handler.ts:30

processInput

processInput(button): boolean
Parameters
- button: Button
Returns boolean
Overrides default.processInput
- Defined in src/ui/modal-ui-handler.ts:156

setCursor

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

setup

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

show

show(args): boolean
Parameters
- args: any[]
Returns boolean
Overrides default.show
- Defined in src/ui/modal-ui-handler.ts:92

updateContainer

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