Class default

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

Hierarchy (View Summary)

default
- default

Constructors

constructor

new default(mode?: null | Mode): default
Parameters
- mode: null | Mode = null
Returns default
Overrides default.constructor
- Defined in src/ui/achvs-ui-handler.ts:62

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`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/achvs-ui-handler.ts:478

clearText

clearText(): void
Returns void
Inherited from default.clearText
- Defined in src/ui/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 default.destroy
- Defined in src/ui/ui-handler.ts:69

eraseCursor

eraseCursor(): void
Returns void
- Defined in src/ui/achvs-ui-handler.ts:487

getCursor

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

getTextColor

getTextColor(style: TextStyle, shadow?: boolean): 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: 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: 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:259

processInput

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

processTutorialInput

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

setCursor

setCursor(cursor: number, pageChange?: boolean): boolean
Parameters
- cursor: number
- OptionalpageChange: boolean
Returns boolean
Overrides default.setCursor
- Defined in src/ui/achvs-ui-handler.ts:331

`Protected`setMouseCursorStyle

setMouseCursorStyle(cursorStyle: "default" | "pointer"): 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

setScrollCursor

setScrollCursor(scrollCursor: number): boolean
setScrollCursor(scrollCursor: number) : boolean scrollCursor refers to the page's position within the entire sum of the data, unlike cursor, which refers to a user's position within displayed data
Parameters
- scrollCursor: number
  takes a value that has been updated based on user behavior
Returns boolean
returns a boolean that indicates whether the updated scrollCursor led to an update in the data displayed.
- Defined in src/ui/achvs-ui-handler.ts:374

setup

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

show

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

`Protected`showAchv

showAchv(achv: Achv): void
Parameters
- achv: Achv
Returns void
- Defined in src/ui/achvs-ui-handler.ts:218

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

`Protected`showVoucher

showVoucher(voucher: Voucher): void
Parameters
- voucher: Voucher
Returns void
- Defined in src/ui/achvs-ui-handler.ts:238

updateAchvIcons

updateAchvIcons(): void
updateAchvIcons(): void Determines what data is to be displayed on the UI and updates it accordingly based on the current value of this.scrollCursor

Returns void
- Defined in src/ui/achvs-ui-handler.ts:405

updateVoucherIcons

updateVoucherIcons(): void
updateVoucherIcons(): void Determines what data is to be displayed on the UI and updates it accordingly based on the current value of this.scrollCursor

Returns void
- Defined in src/ui/achvs-ui-handler.ts:445