Class default

UI Handler for the egg summary. Handles navigation and display of each pokemon as a list Also handles display of the pokemon-hatch-info-container

Hierarchy (view full)

default
- default

Constructors

constructor

new default(): default
Returns default
Overrides default.constructor
- Defined in src/ui/egg-summary-ui-handler.ts:56

Properties

active

active: boolean = false

`Protected`awaitingActionInput

awaitingActionInput: boolean

`Protected`cursor

cursor: number = 0

`Readonly`eventTarget

eventTarget: EventTarget = ...

Allows subscribers to listen for events

Current Events:

EggEventType.EGG_COUNT_CHANGED EggCountChangedEvent

message

message: Text

`Protected`mode

mode: null | number

`Protected`onActionInput

onActionInput: null | Function

pendingPrompt

pendingPrompt: boolean

prompt

prompt: Sprite

`Protected`textCallbackTimer

textCallbackTimer: null | TimerEvent

`Protected`textTimer

textTimer: null | TimerEvent

tutorialActive

tutorialActive: boolean = false

tutorialOverlay

tutorialOverlay: Rectangle

Methods

clear

clear(): void
Returns void
Overrides default.clear
- Defined in src/ui/egg-summary-ui-handler.ts:103

clearText

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

destroy

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

Returns void
Inherited from default.destroy
- Defined in src/ui/ui-handler.ts:69

getCursor

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

getTextColor

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

getUi

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

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/egg-summary-ui-handler.ts:212

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/egg-summary-ui-handler.ts:240

`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:58

setup

setup(): void
Returns void
Overrides default.setup
- Defined in src/ui/egg-summary-ui-handler.ts:60

show

show(args): boolean
Parameters
- args: EggHatchData[][]
  EggHatchData[][] args[0]: list of EggHatchData for each egg/pokemon hatched
Returns boolean
Overrides default.show
- Defined in src/ui/egg-summary-ui-handler.ts:140

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

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
Inherited from default.showText
- Defined in src/ui/message-ui-handler.ts:37

Class default

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Returns default

Properties

active

ProtectedawaitingActionInput

Protectedcursor

ReadonlyeventTarget

message

Protectedmode

ProtectedonActionInput

pendingPrompt

prompt

ProtectedtextCallbackTimer

ProtectedtextTimer

tutorialActive

tutorialOverlay

Methods

clear

Returns void

clearText

Returns void

destroy

Returns void

getCursor

Returns number

getTextColor

Parameters

Returns string

getUi

Returns default

initPromptSprite

Parameters

Returns void

initTutorialOverlay

Parameters

Returns void

isTextAnimationInProgress

Returns boolean

processInput

Parameters

Returns boolean

processTutorialInput

Parameters

Returns boolean

setCursor

Parameters

Returns boolean

ProtectedsetMouseCursorStyle

Parameters

Returns void

See

setup

Returns void

show

Parameters

Returns boolean

showDialogue

Parameters

Returns void

showPrompt

Parameters

Returns void

showText

Parameters

Returns void

Settings

On This Page

`Protected`awaitingActionInput

`Protected`cursor

`Readonly`eventTarget

`Protected`mode

`Protected`onActionInput

`Protected`textCallbackTimer

`Protected`textTimer

`Protected`setMouseCursorStyle