Class GameStatsUiHandler

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

Hierarchy (View Summary)

UiHandler
- GameStatsUiHandler

Constructors

constructor

new GameStatsUiHandler(mode?: null | UiMode): GameStatsUiHandler
Parameters
- mode: null | UiMode = null
  The mode of the UI element. These should be unique.
Returns GameStatsUiHandler
Inherited from UiHandler.constructor
- Defined in src/ui/handlers/ui-handler.ts:16

Properties

active

active: boolean = false

`Private`arrowDown

arrowDown: Sprite

`Private`arrowUp

arrowUp: Sprite

`Protected`cursor

cursor: number = 0

`Private` `Optional`exitCallback

exitCallback?: AnyFn

A callback invoked when clear is called

`Private`gameData

gameData: GameData

The game data to display

`Private`gameStatsContainer

gameStatsContainer: Container

`Private`headerText

headerText: Text

Logged in username

`Protected`mode

mode: null | number

`Private`statLabels

statLabels: Text[] = []

`Private`statsContainer

statsContainer: Container

`Private`statValues

statValues: Text[] = []

`Private` `Static` `Readonly`ROWS_PER_PAGE

ROWS_PER_PAGE: 9

The number of rows enabled per page.

Accessors

`Private`colBgWidth

get colBgWidth(): number
THe width of a column's background window

Returns number
- Defined in src/ui/handlers/game-stats-ui-handler.ts:269

`Private`columnCount

get columnCount(): 1 | 2
The number of columns used by this menu in the resolved language

Returns 1 | 2
- Defined in src/ui/handlers/game-stats-ui-handler.ts:257

`Private`colWidth

get colWidth(): number
The with of each column in the stats view

Returns number
- Defined in src/ui/handlers/game-stats-ui-handler.ts:264

`Private`maxCursorPos

get maxCursorPos(): number
The maximum cursor position

Returns number
- Defined in src/ui/handlers/game-stats-ui-handler.ts:468

`Private`singleCol

get singleCol(): boolean
Whether the UI is single column mode

Returns boolean
- Defined in src/ui/handlers/game-stats-ui-handler.ts:250

`Private`statsPerPage

get statsPerPage(): number
The number of stats on screen at one time (varies with column count)

Returns number
- Defined in src/ui/handlers/game-stats-ui-handler.ts:314

Methods

`Private`calcEntryY

calcEntryY(index: number): number
Calculate the y position of the stat label/text based on its index.
Parameters
- index: number
  The index of the stat label
Returns number
The y position for the stat label
- Defined in src/ui/handlers/game-stats-ui-handler.ts:293

`Private`calcLabelX

calcLabelX(index: number): number
Calculate the x position of the stat label based on its index.
Parameters
- index: number
  The index of the stat label
Returns number
The x position for the stat label

Remarks
Should be used for stat labels (e.g. stat name, not its value). For stat value, use calcTextX.
- Defined in src/ui/handlers/game-stats-ui-handler.ts:281

`Private`calcTextX

calcTextX(index: number): number
Calculate the x position of the stat value based on its index.
Parameters
- index: number
  The index of the stat value
Returns number
The calculated x position
- Defined in src/ui/handlers/game-stats-ui-handler.ts:306

clear

clear(): void
Returns void
Overrides UiHandler.clear
- Defined in src/ui/handlers/game-stats-ui-handler.ts:527

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

getCursor

getCursor(): number
Returns number
Inherited from UiHandler.getCursor
- Defined in src/ui/handlers/ui-handler.ts:34

getUi

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

`Private`getUsername

getUsername(): string
Returns the username of logged in user. If the username is hidden, the trainer name based on gender will be displayed.

Returns string
The username of logged in user
- Defined in src/ui/handlers/game-stats-ui-handler.ts:322

processInput

processInput(button: Button): boolean
Parameters
- button: Button
Returns boolean
Overrides UiHandler.processInput
- Defined in src/ui/handlers/game-stats-ui-handler.ts:472

setCursor

setCursor(newCursor: number): boolean
Set the cursor to the specified position, if able and update the stats display.
Parameters
- newCursor: number
  The position to set the cursor to.
Returns boolean
Whether the cursor successfully moved to a new position

Remarks
If newCursor is not between 0 and maxCursorPos, or if it is the same as newCursor then no updates happen and false is returned.

Otherwise, updates the up/down arrow visibility and calls updateStats
Overrides UiHandler.setCursor
- Defined in src/ui/handlers/game-stats-ui-handler.ts:512

`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

setup

setup(): void
Returns void
Overrides UiHandler.setup
- Defined in src/ui/handlers/game-stats-ui-handler.ts:337

show

show(
    __namedParameters:
        | []
        | [username: string, data: GameData, callback?: AnyFn],
): boolean
Parameters
- __namedParameters: [] | [username: string, data: GameData, callback?: AnyFn]
Returns boolean
Overrides UiHandler.show
- Defined in src/ui/handlers/game-stats-ui-handler.ts:405

`Private`updateStats

updateStats(): void
Update the stat labels and values to reflect the current cursor position.

Returns void
Remarks
Invokes each stat's DisplayStat.sourceFunc | sourceFunc to obtain its value. Stat labels are shown as ??? if the stat is marked as hidden and its value is zero.
- Defined in src/ui/handlers/game-stats-ui-handler.ts:448

Class GameStatsUiHandler

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns GameStatsUiHandler

Properties

active

PrivatearrowDown

PrivatearrowUp

Protectedcursor

Private OptionalexitCallback

PrivategameData

PrivategameStatsContainer

PrivateheaderText

Protectedmode

PrivatestatLabels

PrivatestatsContainer

PrivatestatValues

Private Static ReadonlyROWS_PER_PAGE

Accessors

PrivatecolBgWidth

Returns number

PrivatecolumnCount

Returns 1 | 2

PrivatecolWidth

Returns number

PrivatemaxCursorPos

Returns number

PrivatesingleCol

Returns boolean

PrivatestatsPerPage

Returns number

Methods

PrivatecalcEntryY

Parameters

Returns number

PrivatecalcLabelX

Parameters

Returns number

Remarks

PrivatecalcTextX

Parameters

Returns number

clear

Returns void

destroy

Returns void

getCursor

Returns number

getUi

Returns UI

PrivategetUsername

Returns string

processInput

Parameters

Returns boolean

setCursor

Parameters

Returns boolean

Remarks

ProtectedsetMouseCursorStyle

Parameters

Returns void

See

setup

Returns void

show

Parameters

Returns boolean

PrivateupdateStats

Returns void

Remarks

Settings

On This Page

`Private`arrowDown

`Private`arrowUp

`Protected`cursor

`Private` `Optional`exitCallback

`Private`gameData

`Private`gameStatsContainer

`Private`headerText

`Protected`mode

`Private`statLabels

`Private`statsContainer

`Private`statValues

`Private` `Static` `Readonly`ROWS_PER_PAGE

`Private`colBgWidth

`Private`columnCount

`Private`colWidth

`Private`maxCursorPos

`Private`singleCol

`Private`statsPerPage

`Private`calcEntryY

`Private`calcLabelX

`Private`calcTextX

`Private`getUsername

`Protected`setMouseCursorStyle

`Private`updateStats