Class FightUiHandler

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

Hierarchy (View Summary)

UiHandler
- FightUiHandler

Implements

InfoToggle

Index

Constructors

Properties

active cursor cursor2 fieldIndex fromCommand mode MOVES_CONTAINER_NAME

Methods

clear clearMoves destroy displayMoves eraseCursor getCursor getTextColor getUi isActive processInput setCursor setMouseCursorStyle setup show toggleInfo

Constructors

constructor

new FightUiHandler(): FightUiHandler
Returns FightUiHandler
Overrides UiHandler.constructor
- Defined in src/ui/fight-ui-handler.ts:41

Properties

active

active: boolean = false

`Protected`cursor

cursor: number = 0

`Protected`cursor2

cursor2: number = 0

`Protected`fieldIndex

fieldIndex: number = 0

`Protected`fromCommand

fromCommand: Command = Command.FIGHT

`Protected`mode

mode: null | number

`Static` `Readonly`MOVES_CONTAINER_NAME

MOVES_CONTAINER_NAME: "moves"

Methods

clear

clear(): void
Returns void
Overrides UiHandler.clear
- Defined in src/ui/fight-ui-handler.ts:405

clearMoves

clearMoves(): void
Returns void
- Defined in src/ui/fight-ui-handler.ts:416

destroy

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

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

displayMoves

displayMoves(): void
Returns void
- Defined in src/ui/fight-ui-handler.ts:344

eraseCursor

eraseCursor(): void
Returns void
- Defined in src/ui/fight-ui-handler.ts:425

getCursor

getCursor(): number
Returns number
Overrides UiHandler.getCursor
- Defined in src/ui/fight-ui-handler.ts:233

getTextColor

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

getUi

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

isActive

isActive(): boolean
Returns boolean
Implementation of InfoToggle.isActive
- Defined in src/ui/fight-ui-handler.ts:229

processInput

processInput(button: Button): boolean
Process the player inputting the selected Button.
Parameters
- button: Button
  The Button being pressed
Returns boolean
Whether the input was successful (ie did anything).
Overrides UiHandler.processInput
- Defined in src/ui/fight-ui-handler.ts:150

setCursor

setCursor(cursor: number): boolean
Parameters
- cursor: number
Returns boolean
Overrides UiHandler.setCursor
- Defined in src/ui/fight-ui-handler.ts:295

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

setup

setup(): void
Returns void
Overrides UiHandler.setup
- Defined in src/ui/fight-ui-handler.ts:52

show

show(args: [number?, Command?]): boolean
Parameters
- args: [number?, Command?]
Returns boolean
Overrides UiHandler.show
- Defined in src/ui/fight-ui-handler.ts:123

toggleInfo

toggleInfo(visible: boolean): void
Adjust the visibility of move names and the cursor icon when the info overlay is toggled
Parameters
- visible: boolean
  The visibility of the info overlay; the move names and cursor's visibility will be set to the opposite
Returns void
Implementation of InfoToggle.toggleInfo
- Defined in src/ui/fight-ui-handler.ts:211