Class default

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

Hierarchy (view full)

default
- default

Index

Constructors

Properties

active blockInput cursor mode viewPartyIndex viewPartyXPosition

Methods

clear destroy displayEncounterOptions getCursor getTextColor getUi processInput setCursor setMouseCursorStyle setup show unblockInput

Constructors

constructor

new default(): default
Returns default
Overrides default.constructor
- Defined in src/ui/mystery-encounter-ui-handler.ts:50

Properties

active

active: boolean = false

`Protected`blockInput

blockInput: boolean = true

`Protected`cursor

cursor: number = 0

`Protected`mode

mode: null | number

`Protected`viewPartyIndex

viewPartyIndex: number = 0

`Protected`viewPartyXPosition

viewPartyXPosition: number = 0

Methods

clear

clear(): void
Returns void
Overrides default.clear
- Defined in src/ui/mystery-encounter-ui-handler.ts:568

destroy

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

Returns void
Inherited from default.destroy
- Defined in src/ui/ui-handler.ts:69

displayEncounterOptions

displayEncounterOptions(slideInDescription?): void
Parameters
- slideInDescription: boolean = true
Returns void
- Defined in src/ui/mystery-encounter-ui-handler.ts:335

getCursor

getCursor(): number
Returns number
Overrides default.getCursor
- Defined in src/ui/mystery-encounter-ui-handler.ts:304

getTextColor

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

getUi

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

processInput

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

setCursor

setCursor(cursor): boolean
Parameters
- cursor: number
Returns boolean
Overrides default.setCursor
- Defined in src/ui/mystery-encounter-ui-handler.ts:308

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

setup

setup(): void
Returns void
Overrides default.setup
- Defined in src/ui/mystery-encounter-ui-handler.ts:54

show

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

unblockInput

unblockInput(): void
When ME UI first displays, the option buttons will be disabled temporarily to prevent player accidentally clicking through hastily This method is automatically called after a short delay but can also be called manually

Returns void
- Defined in src/ui/mystery-encounter-ui-handler.ts:291