Class default

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

Hierarchy (view full)

default
- default

Index

Constructors

constructor

Constructors

constructor

new default(scene): default
Parameters
- scene: default
Returns default
Overrides default.constructor
- Defined in src/ui/party-ui-handler.ts:156

Properties

active

active: boolean = false

`Protected` awaitingActionInput

awaitingActionInput: boolean

`Protected` cursor

cursor: number = 0

`Private` fieldIndex

fieldIndex: number

`Private` iconAnimHandler

iconAnimHandler: default

`Private` lastCursor

lastCursor: number = 0

`Private` localizedOptions

localizedOptions: PartyOption[] = ...

message

message: Text

`Protected` mode

mode: number

`Private` moveInfoOverlay

moveInfoOverlay: default

`Private` moveSelectFilter

moveSelectFilter: PokemonMoveSelectFilter

`Protected` onActionInput

onActionInput: Function

`Private` options

options: number[]

`Private` optionsBg

optionsBg: NineSlice

`Private` optionsContainer

optionsContainer: Container

`Private` optionsCursor

optionsCursor: number = 0

`Private` optionsCursorObj

optionsCursorObj: Image

`Private` optionsMode

optionsMode: boolean

`Private` optionsScroll

optionsScroll: boolean

`Private` optionsScrollCursor

optionsScrollCursor: number = 0

`Private` optionsScrollTotal

optionsScrollTotal: number = 0

`Private` partyBg

partyBg: Image

`Private` partyCancelButton

partyCancelButton: PartyCancelButton

`Private` partyContainer

partyContainer: Container

`Private` partyMessageBox

partyMessageBox: NineSlice

`Private` partySlots

partySlots: PartySlot[]

`Private` partySlotsContainer

partySlotsContainer: Container

`Private` partyUiMode

partyUiMode: PartyUiMode

pendingPrompt

pendingPrompt: boolean

prompt

prompt: Sprite

`Private` showMovePp

showMovePp: boolean

`Protected` textCallbackTimer

textCallbackTimer: TimerEvent

`Protected` textTimer

textTimer: TimerEvent

`Private` tmMoveId

tmMoveId: Moves

`Private` transferAll

transferAll: boolean

Whether to transfer all items

`Private` transferCursor

transferCursor: number

`Private` transferMode

transferMode: boolean

`Private` transferOptionCursor

transferOptionCursor: number

`Private` transferQuantities

transferQuantities: number[]

Current quantity selection for every item held by the pokemon selected for the transfer

`Private` transferQuantitiesMax

transferQuantitiesMax: number[]

Stack size of every item that the selected pokemon is holding

tutorialActive

tutorialActive: boolean = false

`Static` NoEffectMessage

NoEffectMessage: string = "It won't have any effect."

Methods

`Private` FilterChallengeLegal

FilterChallengeLegal(pokemon): string
For consistency reasons, this looks like the above filters. However this is used only internally and is always enforced for switching.
Parameters
- pokemon: PlayerPokemon
  The pokemon to check.
Returns string
- Defined in src/ui/party-ui-handler.ts:133

clear

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

clearOptions

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

clearPartySlots

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

clearText

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

clearTransfer

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

doRelease

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

eraseOptionsCursor

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

getCursor

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

getOptionsCursorWithScroll

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

getReleaseMessage

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

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

populatePartySlots

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

processInput

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

processTutorialInput

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

setCursor

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

setup

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

show

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

showDialogue

showDialogue(text, name, delay?, callback?, callbackDelay?, prompt?, promptDelay?): void
Parameters
- text: string
- name: string
- Optional delay: number
- Optional callback: Function
- Optional callbackDelay: number
- Optional prompt: boolean
- Optional promptDelay: number
Returns void
Inherited from default.showDialogue
- Defined in src/ui/message-ui-handler.ts:24

showOptions

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

showPrompt

showPrompt(callback, callbackDelay): void
Parameters
- callback: Function
- callbackDelay: number
Returns void
Inherited from default.showPrompt
- Defined in src/ui/message-ui-handler.ts:154

showText

showText(text, delay?, callback?, callbackDelay?, prompt?, promptDelay?): void
Parameters
- text: string
- Optional delay: number
- Optional callback: Function
- Optional callbackDelay: number
- Optional prompt: boolean
- Optional promptDelay: number
Returns void
Overrides default.showText
- Defined in src/ui/party-ui-handler.ts:625

startTransfer

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

updateOptions

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

`Static` `Private` FilterAll

FilterAll(_pokemon): any
Parameters
- _pokemon: PlayerPokemon
Returns any
- Defined in src/ui/party-ui-handler.ts:112

`Static` `Private` FilterAllMoves

FilterAllMoves(_pokemonMove): any
Parameters
- _pokemonMove: PokemonMove
Returns any
- Defined in src/ui/party-ui-handler.ts:142

`Static` FilterFainted

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

`Static` FilterItemMaxStacks

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

`Static` FilterNonFainted

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

Class default

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns default

Properties

active

Protected awaitingActionInput

Protected cursor

Private fieldIndex

Private iconAnimHandler

Private lastCursor

Private localizedOptions

message

Protected mode

Private moveInfoOverlay

Private moveSelectFilter

Protected onActionInput

Private options

Private optionsBg

Private optionsContainer

Private optionsCursor

Private optionsCursorObj

Private optionsMode

Private optionsScroll

Private optionsScrollCursor

Private optionsScrollTotal

Private partyBg

Private partyCancelButton

Private partyContainer

Private partyMessageBox

Private partySlots

Private partySlotsContainer

Private partyUiMode

pendingPrompt

prompt

Protected scene

Private selectCallback

Private selectFilter

Private showMovePp

Protected textCallbackTimer

Protected textTimer

Private tmMoveId

Private transferAll

Private transferCursor

Private transferMode

Private transferOptionCursor

Private transferQuantities

Private transferQuantitiesMax

tutorialActive

Static NoEffectMessage

Methods

Private FilterChallengeLegal

Parameters

Returns string

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

getOptionsCursorWithScroll

Returns number

getReleaseMessage

`Protected` awaitingActionInput

`Protected` cursor

`Private` fieldIndex

`Private` iconAnimHandler

`Private` lastCursor

`Private` localizedOptions

`Protected` mode

`Private` moveInfoOverlay

`Private` moveSelectFilter

`Protected` onActionInput

`Private` options

`Private` optionsBg

`Private` optionsContainer

`Private` optionsCursor

`Private` optionsCursorObj

`Private` optionsMode

`Private` optionsScroll

`Private` optionsScrollCursor

`Private` optionsScrollTotal

`Private` partyBg

`Private` partyCancelButton

`Private` partyContainer

`Private` partyMessageBox

`Private` partySlots

`Private` partySlotsContainer

`Private` partyUiMode

`Protected` scene

`Private` selectCallback

`Private` selectFilter

`Private` showMovePp

`Protected` textCallbackTimer

`Protected` textTimer

`Private` tmMoveId

`Private` transferAll

`Private` transferCursor

`Private` transferMode

`Private` transferOptionCursor

`Private` transferQuantities

`Private` transferQuantitiesMax

`Static` NoEffectMessage

`Private` FilterChallengeLegal

`Static` `Private` FilterAll

`Static` `Private` FilterAllMoves

`Static` FilterFainted

`Static` FilterItemMaxStacks

`Static` FilterNonFainted