Class EggListUiHandler

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

Hierarchy (View Summary)

MessageUiHandler
- EggListUiHandler

Constructors

constructor

new EggListUiHandler(): EggListUiHandler
Returns EggListUiHandler
Overrides MessageUiHandler.constructor
- Defined in src/ui/handlers/egg-list-ui-handler.ts:32

Properties

active

active: boolean = false

`Protected`awaitingActionInput

awaitingActionInput: boolean

`Private` `Readonly`COLUMNS

COLUMNS: 11

`Protected`cursor

cursor: number = 0

`Private`cursorObj

cursorObj: Image

`Private`eggDateText

eggDateText: Text

`Private`eggGachaInfoText

eggGachaInfoText: Text

`Private`eggHatchWavesText

eggHatchWavesText: Text

`Private`eggIcons

eggIcons: Sprite[]

`Private`eggListContainer

eggListContainer: Container

`Private`eggListIconContainer

eggListIconContainer: Container

`Private`eggListMessageBoxContainer

eggListMessageBoxContainer: Container

`Private`eggNameText

eggNameText: Text

`Private`eggSprite

eggSprite: Sprite

`Private`iconAnimHandler

iconAnimHandler: PokemonIconAnimHelper

message

message: Text

`Protected`mode

mode: null | number

`Protected`onActionInput

onActionInput: null | Function

pendingPrompt

pendingPrompt: boolean

prompt

prompt: Sprite

`Private` `Readonly`ROWS

ROWS: 9

`Private`scrollGridHandler

scrollGridHandler: ScrollableGridHelper

`Protected`textCallbackTimer

textCallbackTimer: null | TimerEvent

`Protected`textTimer

textTimer: null | TimerEvent

tutorialActive

tutorialActive: boolean = false

tutorialOverlay

tutorialOverlay: Rectangle

Methods

clear

clear(): void
Returns void
Overrides MessageUiHandler.clear
- Defined in src/ui/handlers/egg-list-ui-handler.ts:214

clearText

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

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:63

getCursor

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

getUi

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

`Private`initEggIcons

initEggIcons(): void
Create the grid of egg icons to display

Returns void
- Defined in src/ui/handlers/egg-list-ui-handler.ts:120

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:24

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:259

processInput

processInput(button: Button): boolean
Parameters
- button: Button
Returns boolean
Overrides MessageUiHandler.processInput
- Defined in src/ui/handlers/egg-list-ui-handler.ts:173

processTutorialInput

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

setCursor

setCursor(cursor: number): boolean
Parameters
- cursor: number
Returns boolean
Overrides MessageUiHandler.setCursor
- Defined in src/ui/handlers/egg-list-ui-handler.ts:192

`Private`setEggDetails

setEggDetails(index: number): void
Update the information panel with the information of the given egg
Parameters
- index: number
  which egg in the list to display the info for
Returns void
- Defined in src/ui/handlers/egg-list-ui-handler.ts:157

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

setup

setup(): void
Returns void
Overrides MessageUiHandler.setup
- Defined in src/ui/handlers/egg-list-ui-handler.ts:36

show

show(args: any[]): boolean
Parameters
- args: any[]
Returns boolean
Overrides MessageUiHandler.show
- Defined in src/ui/handlers/egg-list-ui-handler.ts:100

showDialogue

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

showPrompt

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

showText

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

`Private`updateEggIcons

updateEggIcons(): void
Show the grid of egg icons

Returns void
- Defined in src/ui/handlers/egg-list-ui-handler.ts:137

Class EggListUiHandler

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Returns EggListUiHandler

Properties

active

ProtectedawaitingActionInput

Private ReadonlyCOLUMNS

Protectedcursor

PrivatecursorObj

PrivateeggDateText

PrivateeggGachaInfoText

PrivateeggHatchWavesText

PrivateeggIcons

PrivateeggListContainer

PrivateeggListIconContainer

PrivateeggListMessageBoxContainer

PrivateeggNameText

PrivateeggSprite

PrivateiconAnimHandler

message

Protectedmode

ProtectedonActionInput

pendingPrompt

prompt

Private ReadonlyROWS

PrivatescrollGridHandler

ProtectedtextCallbackTimer

ProtectedtextTimer

tutorialActive

tutorialOverlay

Methods

clear

Returns void

clearText

Returns void

destroy

Returns void

getCursor

Returns number

getUi

Returns UI

PrivateinitEggIcons

Returns void

initPromptSprite

Parameters

Returns void

initTutorialOverlay

Parameters

Returns void

isTextAnimationInProgress

Returns boolean

processInput

Parameters

Returns boolean

processTutorialInput

Parameters

Returns boolean

setCursor

Parameters

Returns boolean

PrivatesetEggDetails

Parameters

Returns void

ProtectedsetMouseCursorStyle

Parameters

Returns void

See

setup

Returns void

show

Parameters

Returns boolean

showDialogue

Parameters

`Protected`awaitingActionInput

`Private` `Readonly`COLUMNS

`Protected`cursor

`Private`cursorObj

`Private`eggDateText

`Private`eggGachaInfoText

`Private`eggHatchWavesText

`Private`eggIcons

`Private`eggListContainer

`Private`eggListIconContainer

`Private`eggListMessageBoxContainer

`Private`eggNameText

`Private`eggSprite

`Private`iconAnimHandler

`Protected`mode

`Protected`onActionInput

`Private` `Readonly`ROWS

`Private`scrollGridHandler

`Protected`textCallbackTimer

`Protected`textTimer

`Private`initEggIcons

`Private`setEggDetails

`Protected`setMouseCursorStyle

`Private`updateEggIcons