Class FightUiHandler

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

Hierarchy (View Summary)

UiHandler
- FightUiHandler

Implements

InfoToggle

Constructors

constructor

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

Properties

`Private`accuracyLabel

accuracyLabel: Text

`Private`accuracyText

accuracyText: Text

active

active: boolean = false

`Protected`cursor

cursor: number = 0

`Protected`cursor2

cursor2: number = 0

`Private`cursorObj

cursorObj: null | Image

`Protected`fieldIndex

fieldIndex: number = 0

`Protected`fromCommand

fromCommand: Command = Command.FIGHT

`Protected`mode

mode: null | number

`Private`moveCategoryIcon

moveCategoryIcon: Sprite

`Private`moveInfoContainer

moveInfoContainer: Container

`Private`moveInfoOverlay

moveInfoOverlay: MoveInfoOverlay

`Private`movesContainer

movesContainer: Container

`Private`powerLabel

powerLabel: Text

`Private`powerText

powerText: Text

`Private`ppLabel

ppLabel: Text

`Private`ppText

ppText: Text

`Private`typeIcon

typeIcon: Sprite

`Static` `Readonly`MOVES_CONTAINER_NAME

MOVES_CONTAINER_NAME: "moves"

Methods

clear

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

clearMoves

clearMoves(): void
Returns void
- Defined in src/ui/handlers/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/handlers/ui-handler.ts:63

displayMoves

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

eraseCursor

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

getCursor

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

`Private`getEffectivenessText

getEffectivenessText(
    pokemon: Pokemon,
    opponent: Pokemon,
    pokemonMove: PokemonMove,
): undefined | string
Gets multiplier text for a pokemon's move against a specific opponent
Parameters
- pokemon: Pokemon
- opponent: Pokemon
- pokemonMove: PokemonMove
Returns undefined | string
- Defined in src/ui/handlers/fight-ui-handler.ts:325

`Private`getMoveColor

getMoveColor(pokemon: Pokemon, pokemonMove: PokemonMove): undefined | string
Returns a specific move's color based on its type effectiveness against opponents If there are multiple opponents, the highest effectiveness' color is returned
Parameters
- pokemon: Pokemon
- pokemonMove: PokemonMove
Returns undefined | string
A color or undefined if the default color should be used
- Defined in src/ui/handlers/fight-ui-handler.ts:373

getUi

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

isActive

isActive(): boolean
Returns boolean
Implementation of InfoToggle.isActive
- Defined in src/ui/handlers/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/handlers/fight-ui-handler.ts:150

setCursor

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

`Private`setInfoVis

setInfoVis(visibility: boolean): void
Set the visibility of the objects in the move info container.
Parameters
- visibility: boolean
Returns void
- Defined in src/ui/handlers/fight-ui-handler.ts:48

`Protected`setMouseCursorStyle

setMouseCursorStyle(cursorStyle: "pointer" | "default"): void
Changes the style of the mouse cursor.
Parameters
- cursorStyle: "pointer" | "default"
  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/handlers/ui-handler.ts:52

`Private`setMoveInfo

setMoveInfo(cursor: number): void
Populate the move info overlay with the information of the move at the given cursor index
Parameters
- cursor: number
  The cursor position to set the move info for
Returns void
- Defined in src/ui/handlers/fight-ui-handler.ts:255

setup

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

show

show(args: [number?, Command?]): boolean
Parameters
- args: [number?, Command?]
Returns boolean
Overrides UiHandler.show
- Defined in src/ui/handlers/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/handlers/fight-ui-handler.ts:211

`Private` `Static`ppRatioToColor

ppRatioToColor(ppRatio: number): TextStyle
Parameters
- ppRatio: number
Returns TextStyle
TextStyle according to percentage of PP remaining
- Defined in src/ui/handlers/fight-ui-handler.ts:238

Class FightUiHandler

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns FightUiHandler

Properties

PrivateaccuracyLabel

PrivateaccuracyText

active

Protectedcursor

Protectedcursor2

PrivatecursorObj

ProtectedfieldIndex

ProtectedfromCommand

Protectedmode

PrivatemoveCategoryIcon

PrivatemoveInfoContainer

PrivatemoveInfoOverlay

PrivatemovesContainer

PrivatepowerLabel

PrivatepowerText

PrivateppLabel

PrivateppText

PrivatetypeIcon

Static ReadonlyMOVES_CONTAINER_NAME

Methods

clear

Returns void

clearMoves

Returns void

destroy

Returns void

displayMoves

Returns void

eraseCursor

Returns void

getCursor

Returns number

PrivategetEffectivenessText

Parameters

Returns undefined | string

PrivategetMoveColor

Parameters

Returns undefined | string

getUi

Returns UI

isActive

Returns boolean

processInput

Parameters

Returns boolean

setCursor

Parameters

Returns boolean

PrivatesetInfoVis

Parameters

Returns void

ProtectedsetMouseCursorStyle

Parameters

Returns void

See

PrivatesetMoveInfo

Parameters

Returns void

setup

Returns void

show

Parameters

Returns boolean

toggleInfo

Parameters

Returns void

Private StaticppRatioToColor

Parameters

Returns TextStyle

`Private`accuracyLabel

`Private`accuracyText

`Protected`cursor

`Protected`cursor2

`Private`cursorObj

`Protected`fieldIndex

`Protected`fromCommand

`Protected`mode

`Private`moveCategoryIcon

`Private`moveInfoContainer

`Private`moveInfoOverlay

`Private`movesContainer

`Private`powerLabel

`Private`powerText

`Private`ppLabel

`Private`ppText

`Private`typeIcon

`Static` `Readonly`MOVES_CONTAINER_NAME

`Private`getEffectivenessText

`Private`getMoveColor

`Private`setInfoVis

`Protected`setMouseCursorStyle

`Private`setMoveInfo

`Private` `Static`ppRatioToColor