Class default

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

Hierarchy (view full)

default
- default

Constructors

constructor

new default(scene): default
Parameters
- scene: default
Returns default
Overrides default.constructor
- Defined in src/ui/battle-message-ui-handler.ts:25

Properties

active

active: boolean = false

`Protected`awaitingActionInput

awaitingActionInput: boolean

bg

bg: Sprite

commandWindow

commandWindow: NineSlice

`Protected`cursor

cursor: number = 0

message

message: Text

`Protected`mode

mode: null | number

movesWindowContainer

movesWindowContainer: Container

nameBoxContainer

nameBoxContainer: Container

`Protected`onActionInput

onActionInput: null | Function

pendingPrompt

pendingPrompt: boolean

prompt

prompt: Sprite

`Protected`scene

scene: default

`Protected`textCallbackTimer

textCallbackTimer: null | TimerEvent

`Protected`textTimer

textTimer: null | TimerEvent

tutorialActive

tutorialActive: boolean = false

tutorialOverlay

tutorialOverlay: Rectangle

`Readonly`wordWrapWidth

wordWrapWidth: number = 1780

Methods

clear

clear(): void
Returns void
Overrides default.clear
- Defined in src/ui/battle-message-ui-handler.ts:152

clearText

clearText(): void
Returns void
Inherited from default.clearText
- Defined in src/ui/message-ui-handler.ts:234

getCursor

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

getIvDescriptor

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

getTextColor

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

getTopIvs

getTopIvs(ivs, shownIvsCount): Stat[]
Parameters
- ivs: number[]
- shownIvsCount: number
Returns Stat[]
- Defined in src/ui/battle-message-ui-handler.ts:213

getUi

getUi(): default
Returns default
Inherited from default.getUi
- Defined in src/ui/ui-handler.ts:34

hideNameText

hideNameText(): void
Returns void
- Defined in src/ui/battle-message-ui-handler.ts:274

initPromptSprite

initPromptSprite(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 default.initPromptSprite
- Defined in src/ui/message-ui-handler.ts:24

initTutorialOverlay

initTutorialOverlay(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 default.initTutorialOverlay
- Defined in src/ui/awaitable-ui-handler.ts:33

isTextAnimationInProgress

isTextAnimationInProgress(): boolean
Returns boolean
Inherited from default.isTextAnimationInProgress
- Defined in src/ui/message-ui-handler.ts:226

processInput

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

processTutorialInput

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

promptIvs

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

promptLevelUpStats

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

setCursor

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

`Protected`setMouseCursorStyle

setMouseCursorStyle(cursorStyle): 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:60

setup

setup(): void
Returns void
Overrides default.setup
- Defined in src/ui/battle-message-ui-handler.ts:29

show

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

showDialogue

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

showNameText

showNameText(name): void
Parameters
- name: string
Returns void
- Defined in src/ui/battle-message-ui-handler.ts:268

showPrompt

showPrompt(callback?, callbackDelay?): void
Parameters
- Optionalcallback: null | Function
- OptionalcallbackDelay: null | number
Returns void
Inherited from default.showPrompt
- Defined in src/ui/message-ui-handler.ts:191

showText

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

Class default

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns default

Properties

active

ProtectedawaitingActionInput

bg

commandWindow

Protectedcursor

message

Protectedmode

movesWindowContainer

nameBoxContainer

ProtectedonActionInput

pendingPrompt

prompt

Protectedscene

ProtectedtextCallbackTimer

ProtectedtextTimer

tutorialActive

tutorialOverlay

ReadonlywordWrapWidth

Methods

clear

Returns void

clearText

Returns void

getCursor

Returns number

getIvDescriptor

Parameters

Returns string

getTextColor

Parameters

Returns string

getTopIvs

Parameters

Returns Stat[]

getUi

Returns default

hideNameText

Returns void

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

Parameters

`Protected`awaitingActionInput

`Protected`cursor

`Protected`mode

`Protected`onActionInput

`Protected`scene

`Protected`textCallbackTimer

`Protected`textTimer

`Readonly`wordWrapWidth

`Protected`setMouseCursorStyle