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/egg-gacha-ui-handler.ts:42

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

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

Methods

clear

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

clearText

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

consumeVouchers

consumeVouchers(voucherType, count): void
Parameters
- voucherType: VoucherType
- count: number
Returns void
- Defined in src/ui/egg-gacha-ui-handler.ts:578

getCursor

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

getDelayValue

getDelayValue(delay): number
Parameters
- delay: number
Returns number
- Defined in src/ui/egg-gacha-ui-handler.ts:334

getGuaranteedEggTierFromPullCount

getGuaranteedEggTierFromPullCount(pullCount): EggTier
Parameters
- pullCount: number
Returns EggTier
- Defined in src/ui/egg-gacha-ui-handler.ts:471

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

hideSummary

hideSummary(): void
Returns void
- Defined in src/ui/egg-gacha-ui-handler.ts:549

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-gacha-ui-handler.ts:619

processTutorialInput

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

pull

pull(pullCount?, count?, eggs?): void
Parameters
- pullCount: number = 0
- count: number = 0
- Optionaleggs: Egg[]
Returns void
- Defined in src/ui/egg-gacha-ui-handler.ts:341

setCursor

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

setGachaCursor

setGachaCursor(cursor): boolean
Parameters
- cursor: number
Returns boolean
- Defined in src/ui/egg-gacha-ui-handler.ts:768

`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

setTransitioning

setTransitioning(transitioning): void
Parameters
- transitioning: boolean
Returns void
- Defined in src/ui/egg-gacha-ui-handler.ts:611

setup

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

show

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

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

showError

showError(text): void
Parameters
- text: string
Returns void
- Defined in src/ui/egg-gacha-ui-handler.ts:607

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

showSummary

showSummary(eggs): void
Parameters
- eggs: Egg[]
Returns void
- Defined in src/ui/egg-gacha-ui-handler.ts:482

showText

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

updateGachaInfo

updateGachaInfo(gachaType): void
Parameters
- gachaType: GachaType
Returns void
- Defined in src/ui/egg-gacha-ui-handler.ts:567

updateVoucherCounts

updateVoucherCounts(): void
Returns void
- Defined in src/ui/egg-gacha-ui-handler.ts:583