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/party-ui-handler.ts:221

Properties

active

active: boolean = false

`Protected`awaitingActionInput

awaitingActionInput: boolean

`Protected`cursor

cursor: number = 0

message

message: Text

`Protected`mode

mode: null | number

`Protected`onActionInput

onActionInput: null | Function

optionsContainer

optionsContainer: Container

This is only public for test/ui/transfer-item.test.ts

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

`Static`NoEffectMessage

NoEffectMessage: string = ...

Methods

clear

clear(): void
Returns void
Overrides default.clear
- Defined in src/ui/party-ui-handler.ts:1145

clearOptions

clearOptions(): void
Returns void
- Defined in src/ui/party-ui-handler.ts:1123

clearPartySlots

clearPartySlots(): void
Returns void
- Defined in src/ui/party-ui-handler.ts:1153

clearText

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

clearTransfer

clearTransfer(): void
Returns void
- Defined in src/ui/party-ui-handler.ts:1046

doRelease

doRelease(slotIndex): void
Parameters
- slotIndex: number
Returns void
- Defined in src/ui/party-ui-handler.ts:1058

eraseOptionsCursor

eraseOptionsCursor(): void
Returns void
- Defined in src/ui/party-ui-handler.ts:1138

getCursor

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

getFormChangeItemsModifiers

getFormChangeItemsModifiers(pokemon): PokemonFormChangeItemModifier[]
Parameters
- pokemon: default
Returns PokemonFormChangeItemModifier[]
- Defined in src/ui/party-ui-handler.ts:1102

getOptionsCursorWithScroll

getOptionsCursorWithScroll(): number
Returns number
- Defined in src/ui/party-ui-handler.ts:1119

getReleaseMessage

getReleaseMessage(pokemonName): string
Parameters
- pokemonName: string
Returns string
- Defined in src/ui/party-ui-handler.ts:1077

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

getUi

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

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

populatePartySlots

populatePartySlots(): void
Returns void
- Defined in src/ui/party-ui-handler.ts:666

processInput

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

processTutorialInput

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

setCursor

setCursor(cursor): boolean
Parameters
- cursor: number
Returns boolean
Overrides default.setCursor
- Defined in src/ui/party-ui-handler.ts:687

`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/party-ui-handler.ts:225

show

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

showDialogue

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

showOptions

showOptions(): void
Returns void
- Defined in src/ui/party-ui-handler.ts:763

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/party-ui-handler.ts:747

startTransfer

startTransfer(): void
Returns void
- Defined in src/ui/party-ui-handler.ts:1037

updateOptions

updateOptions(): void
Returns void
- Defined in src/ui/party-ui-handler.ts:802

`Static`FilterFainted

FilterFainted(pokemon): null | string
Parameters
- pokemon: PlayerPokemon
Returns null | string
- Defined in src/ui/party-ui-handler.ts:186

`Static`FilterItemMaxStacks

FilterItemMaxStacks(pokemon, modifier): null | string
Parameters
- pokemon: PlayerPokemon
- modifier: PokemonHeldItemModifier
Returns null | string
- Defined in src/ui/party-ui-handler.ts:209

`Static`FilterNonFainted

FilterNonFainted(pokemon): null | string
Parameters
- pokemon: PlayerPokemon
Returns null | string
- Defined in src/ui/party-ui-handler.ts:179

Class default

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns default

Properties

active

ProtectedawaitingActionInput

Protectedcursor

message

Protectedmode

ProtectedonActionInput

optionsContainer

pendingPrompt

prompt

Protectedscene

ProtectedtextCallbackTimer

ProtectedtextTimer

tutorialActive

tutorialOverlay

StaticNoEffectMessage

Methods

clear

Returns void

clearOptions

Returns void

clearPartySlots

Returns void

clearText

Returns void

clearTransfer

Returns void

doRelease

Parameters

Returns void

eraseOptionsCursor

Returns void

getCursor

Returns number

getFormChangeItemsModifiers

Parameters

Returns PokemonFormChangeItemModifier[]

getOptionsCursorWithScroll

Returns number

getReleaseMessage

Parameters

Returns string

getTextColor

Parameters

Returns string

getUi

Returns default

initPromptSprite

Parameters

Returns void

initTutorialOverlay

Parameters

Returns void

isTextAnimationInProgress

Returns boolean

populatePartySlots

Returns void

processInput

Parameters

Returns boolean

processTutorialInput

Parameters

Returns boolean

setCursor

Parameters

Returns boolean

ProtectedsetMouseCursorStyle

Parameters

Returns void

See

`Protected`awaitingActionInput

`Protected`cursor

`Protected`mode

`Protected`onActionInput

`Protected`scene

`Protected`textCallbackTimer

`Protected`textTimer

`Static`NoEffectMessage

`Protected`setMouseCursorStyle

`Static`FilterFainted

`Static`FilterItemMaxStacks

`Static`FilterNonFainted