Class BattleMessageUiHandler

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

Hierarchy (View Summary)

MessageUiHandler
- BattleMessageUiHandler

Constructors

constructor

new BattleMessageUiHandler(): BattleMessageUiHandler

Returns BattleMessageUiHandler

Inherited from MessageUiHandler.constructor

Properties

active

active: boolean = false

`Protected`awaitingActionInput

awaitingActionInput: boolean

bg

bg: Sprite

commandWindow

commandWindow: NineSlice

`Protected`cursor

cursor: number = 0

`Private`levelUpStatsContainer

levelUpStatsContainer: Container

`Private`levelUpStatsIncrContent

levelUpStatsIncrContent: Text

`Private`levelUpStatsValuesContent

levelUpStatsValuesContent: BBCodeText

message

message: Text

movesWindowContainer

movesWindowContainer: Container

`Optional`nameBoxContainer

nameBoxContainer?: Container

The container for the name box

Remarks

This will be undefined unless this.initNameBox() was called

`Protected`onActionInput

onActionInput: AnyFn<any> | null

pendingPrompt

pendingPrompt: boolean = false

prompt

prompt: Sprite

`Protected`textCallbackTimer

textCallbackTimer: TimerEvent | null

`Protected`textTimer

textTimer: TimerEvent | null

tutorialActive

tutorialActive: boolean = false

tutorialOverlay

tutorialOverlay: Rectangle

`Readonly`wordWrapWidth

wordWrapWidth: number = 1780

Methods

clear

clear(): void
Returns void
Overrides MessageUiHandler.clear
- Defined in src/ui/handlers/battle-message-ui-handler.ts:143

clearText

clearText(): void
Returns void
Inherited from MessageUiHandler.clearText
- Defined in src/ui/handlers/message-ui-handler.ts:344

destroy

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

Returns void
Inherited from MessageUiHandler.destroy
- Defined in src/ui/handlers/ui-handler.ts:54

getCursor

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

getIvDescriptor

getIvDescriptor(value: number, typeIv: number, pokemonId: number): string
Parameters
- value: number
- typeIv: number
- pokemonId: number
Returns string
- Defined in src/ui/handlers/battle-message-ui-handler.ts:214

getUi

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

hideNameText

hideNameText(): void
Returns void
Inherited from MessageUiHandler.hideNameText
- Defined in src/ui/handlers/message-ui-handler.ts:332

initNameBox

initNameBox(container: Container, x?: number, y?: number): void
Add the name box shown by showDialogue to the given message container.
Parameters
- container: Container
  The container holding the message text
- x: number = 0
  The x position of the name box
- y: number = -16
  The y position of the name box
Returns void

Remarks
If this method is not called, the name box will not be displayed.
Inherited from MessageUiHandler.initNameBox
- Defined in src/ui/handlers/message-ui-handler.ts:37

initPromptSprite

initPromptSprite(container: Container): void
Add the sprite to be displayed at the end of messages with prompts
Parameters
- container: Container
  the container to add the sprite to
Returns void
Inherited from MessageUiHandler.initPromptSprite
- Defined in src/ui/handlers/message-ui-handler.ts:60

initTutorialOverlay

initTutorialOverlay(container: Container): void
Create a semi transparent overlay that will get shown during tutorials
Parameters
- container: Container
  the container to add the overlay to
Returns void
Inherited from MessageUiHandler.initTutorialOverlay
- Defined in src/ui/handlers/awaitable-ui-handler.ts:33

isTextAnimationInProgress

isTextAnimationInProgress(): boolean
Returns boolean
Inherited from MessageUiHandler.isTextAnimationInProgress
- Defined in src/ui/handlers/message-ui-handler.ts:336

processInput

processInput(button: Button): boolean
Parameters
- button: Button
Returns boolean
Overrides MessageUiHandler.processInput
- Defined in src/ui/handlers/battle-message-ui-handler.ts:130

processTutorialInput

processTutorialInput(button: Button): boolean
Parameters
- button: Button
Returns boolean
Inherited from MessageUiHandler.processTutorialInput
- Defined in src/ui/handlers/awaitable-ui-handler.ts:16

promptIvs

promptIvs(pokemonId: number, ivs: number[]): Promise<void>
Parameters
- pokemonId: number
- ivs: number[]
Returns Promise<void>
- Defined in src/ui/handlers/battle-message-ui-handler.ts:195

promptLevelUpStats

promptLevelUpStats(
    partyMemberIndex: number,
    prevStats: number[],
    showTotals: boolean,
): Promise<void>
Parameters
- partyMemberIndex: number
- prevStats: number[]
- showTotals: boolean
Returns Promise<void>
- Defined in src/ui/handlers/battle-message-ui-handler.ts:171

setCursor

setCursor(cursor: number): boolean
Parameters
- cursor: number
Returns boolean
Inherited from MessageUiHandler.setCursor
- Defined in src/ui/handlers/ui-handler.ts:29

`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 MessageUiHandler.setMouseCursorStyle
- Defined in src/ui/handlers/ui-handler.ts:43

setup

setup(): void
Returns void
Overrides MessageUiHandler.setup
- Defined in src/ui/handlers/battle-message-ui-handler.ts:21

show

show(args: any[]): boolean
Parameters
- args: any[]
Returns boolean
Overrides MessageUiHandler.show
- Defined in src/ui/handlers/battle-message-ui-handler.ts:120

showDialogue

showDialogue(
    text: string,
    name?: string,
    delay?: number | null,
    callback?: () => void,
    callbackDelay?: number,
    prompt?: boolean,
    promptDelay?: number,
): void
Parameters
- text: string
- Optionalname: string
- Optionaldelay: number | null
- Optionalcallback: () => void
- OptionalcallbackDelay: number
- Optionalprompt: boolean
- OptionalpromptDelay: number
Returns void
Overrides MessageUiHandler.showDialogue
- Defined in src/ui/handlers/battle-message-ui-handler.ts:159

showNameText

showNameText(name: string, iconFrame?: string): void
Show a name above the text.
Parameters
- name: string
  The name to show
- OptionaliconFrame: string
  The frame of the icon to display next to the name
Returns void

Remarks
the icon must be from the items atlas
Inherited from MessageUiHandler.showNameText
- Defined in src/ui/handlers/message-ui-handler.ts:311

showPrompt

showPrompt(callback?: (() => void) | null, callbackDelay?: number | null): void
Parameters
- Optionalcallback: (() => void) | null
- OptionalcallbackDelay: number | null
Returns void
Inherited from MessageUiHandler.showPrompt
- Defined in src/ui/handlers/message-ui-handler.ts:267

showText

showText(
    text: string,
    delay?: number | null,
    callback?: (() => void) | null,
    callbackDelay?: number | null,
    prompt?: boolean | null,
    promptDelay?: number | null,
): void
Parameters
- text: string
- Optionaldelay: number | null
- Optionalcallback: (() => void) | null
- OptionalcallbackDelay: number | null
- Optionalprompt: boolean | null
- OptionalpromptDelay: number | null
Returns void
Overrides MessageUiHandler.showText
- Defined in src/ui/handlers/battle-message-ui-handler.ts:147

Class BattleMessageUiHandler

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Returns BattleMessageUiHandler

Properties

active

ProtectedawaitingActionInput

bg

commandWindow

Protectedcursor

PrivatelevelUpStatsContainer

PrivatelevelUpStatsIncrContent

PrivatelevelUpStatsValuesContent

message

movesWindowContainer

OptionalnameBoxContainer

Remarks

ProtectedonActionInput

pendingPrompt

prompt

ProtectedtextCallbackTimer

ProtectedtextTimer

tutorialActive

tutorialOverlay

ReadonlywordWrapWidth

Methods

clear

Returns void

clearText

Returns void

destroy

Returns void

getCursor

Returns number

getIvDescriptor

Parameters

Returns string

getUi

Returns UI

hideNameText

Returns void

initNameBox

Parameters

Returns void

Remarks

initPromptSprite

Parameters

Returns void

initTutorialOverlay

Parameters

Returns void

isTextAnimationInProgress

Returns boolean

processInput

Parameters

Returns boolean

processTutorialInput

Parameters

Returns boolean

promptIvs

Parameters

Returns Promise<void>

promptLevelUpStats

Parameters

Returns Promise<void>

setCursor

Parameters

Returns boolean

ProtectedsetMouseCursorStyle

Parameters

Returns void

See

setup

Returns void

show

`Protected`awaitingActionInput

`Protected`cursor

`Private`levelUpStatsContainer

`Private`levelUpStatsIncrContent

`Private`levelUpStatsValuesContent

`Optional`nameBoxContainer

`Protected`onActionInput

`Protected`textCallbackTimer

`Protected`textTimer

`Readonly`wordWrapWidth

`Protected`setMouseCursorStyle