Class default

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

Hierarchy (View Summary)

default
- default

Constructors

constructor

new default(): default
Returns default
Overrides default.constructor
- Defined in src/ui/summary-ui-handler.ts:130

Properties

active

active: boolean = false

`Protected`cursor

cursor: number = 0

`Protected`mode

mode: null | number

Methods

clear

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

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

destroyBlinkCursor

destroyBlinkCursor(): void
Returns void
- Defined in src/ui/summary-ui-handler.ts:1258

getCursor

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

getPageKey

getPageKey(page?: number): string
Parameters
- Optionalpage: number
Returns string
- Defined in src/ui/summary-ui-handler.ts:314

getSelectedMove

getSelectedMove(): null | default
Returns null | default
- Defined in src/ui/summary-ui-handler.ts:1222

getTextColor

getTextColor(style: TextStyle, shadow?: boolean): 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

hideMoveEffect

hideMoveEffect(instant?: boolean): void
Parameters
- Optionalinstant: boolean
Returns void
- Defined in src/ui/summary-ui-handler.ts:1286

hideMoveSelect

hideMoveSelect(): void
Returns void
- Defined in src/ui/summary-ui-handler.ts:1244

hideStatus

hideStatus(instant?: boolean): void
Parameters
- Optionalinstant: boolean
Returns void
- Defined in src/ui/summary-ui-handler.ts:1209

populatePageContainer

populatePageContainer(pageContainer: Container, page?: Page): void
Parameters
- pageContainer: Container
- Optionalpage: Page
Returns void
- Defined in src/ui/summary-ui-handler.ts:786

processInput

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

setCursor

setCursor(cursor: number, overrideChanged?: boolean): boolean
Parameters
- cursor: number
- overrideChanged: boolean = false
Returns boolean
Overrides default.setCursor
- Defined in src/ui/summary-ui-handler.ts:666

`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 default.setMouseCursorStyle
- Defined in src/ui/ui-handler.ts:58

setup

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

show

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

showMoveEffect

showMoveEffect(instant?: boolean): void
Parameters
- Optionalinstant: boolean
Returns void
- Defined in src/ui/summary-ui-handler.ts:1273

showMoveSelect

showMoveSelect(): void
Returns void
- Defined in src/ui/summary-ui-handler.ts:1236

showStatus

showStatus(instant?: boolean): void
Parameters
- Optionalinstant: boolean
Returns void
- Defined in src/ui/summary-ui-handler.ts:1196