Class default

Abstract class for handling UI elements related to settings.

Hierarchy (view full)

default
- default

Constructors

constructor

new default(mode?): default
Creates an instance of SettingsGamepadUiHandler.
Parameters
- mode: null | Mode = null
  The UI mode, optional.
Returns default
Overrides default.constructor
- Defined in src/ui/settings/settings-display-ui-handler.ts:12

Properties

active

active: boolean = false

`Protected`awaitingActionInput

awaitingActionInput: boolean

`Protected`cursor

cursor: number = 0

`Protected`localStorageKey

localStorageKey: string

message

message: Text

`Protected`mode

mode: null | number

`Protected`navigationIcons

navigationIcons: InputsIcons

`Protected`onActionInput

onActionInput: null | Function

pendingPrompt

pendingPrompt: boolean

prompt

prompt: Sprite

`Protected`rowsToDisplay

rowsToDisplay: number

`Protected`settings

settings: Setting[]

`Protected`textCallbackTimer

textCallbackTimer: null | TimerEvent

`Protected`textTimer

textTimer: null | TimerEvent

`Protected`title

title: string

tutorialActive

tutorialActive: boolean = false

tutorialOverlay

tutorialOverlay: Rectangle

Methods

activateSetting

activateSetting(setting): boolean
Activate the specified setting if it is activatable.
Parameters
- setting: Setting
  The setting to activate.
Returns boolean
Whether the setting was successfully activated.
Inherited from default.activateSetting
- Defined in src/ui/settings/abstract-settings-ui-handler.ts:315

clear

clear(): void
Clear the UI elements and state.

Returns void
Inherited from default.clear
- Defined in src/ui/settings/abstract-settings-ui-handler.ts:444

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

eraseCursor

eraseCursor(): void
Erase the cursor from the UI.

Returns void
Inherited from default.eraseCursor
- Defined in src/ui/settings/abstract-settings-ui-handler.ts:459

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
Processes input from a specified button. This method handles navigation through a UI menu, including movement through menu items and handling special actions like cancellation. Each button press may adjust the cursor position or the menu scroll, and plays a sound effect if the action was successful.
Parameters
- button: Button
  The button pressed by the user.
Returns boolean
true if the action associated with the button was successfully processed, false otherwise.
Inherited from default.processInput
- Defined in src/ui/settings/abstract-settings-ui-handler.ts:232

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
Set the cursor to the specified position.
Parameters
- cursor: number
  The cursor position to set.
Returns boolean
true if the cursor was set successfully.
Inherited from default.setCursor
- Defined in src/ui/settings/abstract-settings-ui-handler.ts:330

`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

setOptionCursor

setOptionCursor(settingIndex, cursor, save?): boolean
Set the option cursor to the specified position.
Parameters
- settingIndex: number
  The index of the setting or -1 to change the current setting
- cursor: number
  The cursor position to set.
- Optionalsave: boolean
  Whether to save the setting to local storage.
Returns boolean
true if the option cursor was set successfully.
Inherited from default.setOptionCursor
- Defined in src/ui/settings/abstract-settings-ui-handler.ts:353

setScrollCursor

setScrollCursor(scrollCursor): boolean
Set the scroll cursor to the specified position.
Parameters
- scrollCursor: number
  The scroll cursor position to set.
Returns boolean
true if the scroll cursor was set successfully.
Inherited from default.setScrollCursor
- Defined in src/ui/settings/abstract-settings-ui-handler.ts:411

setup

setup(): void
Setup UI elements

Returns void
Inherited from default.setup
- Defined in src/ui/settings/abstract-settings-ui-handler.ts:56

show

show(args): boolean
Show the UI with the provided arguments.
Parameters
- args: any[]
  Arguments to be passed to the show method.
Returns boolean
true if successful.
Inherited from default.show
- Defined in src/ui/settings/abstract-settings-ui-handler.ts:204

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: number
- Optionalcallback: Function
- OptionalcallbackDelay: number
- Optionalprompt: boolean
- OptionalpromptDelay: number
Returns void
Inherited from default.showText
- Defined in src/ui/settings/abstract-settings-ui-handler.ts:466

updateBindings

updateBindings(): void
Update the bindings for the current active device configuration.

Returns void
Inherited from default.updateBindings
- Defined in src/ui/settings/abstract-settings-ui-handler.ts:177

updateSettingsScroll

updateSettingsScroll(): void
Update the scroll position of the settings UI.

Returns void
Inherited from default.updateSettingsScroll
- Defined in src/ui/settings/abstract-settings-ui-handler.ts:429

Class default

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns default

Properties

active

ProtectedawaitingActionInput

Protectedcursor

ProtectedlocalStorageKey

message

Protectedmode

ProtectednavigationIcons

ProtectedonActionInput

pendingPrompt

prompt

ProtectedrowsToDisplay

Protectedsettings

ProtectedtextCallbackTimer

ProtectedtextTimer

Protectedtitle

tutorialActive

tutorialOverlay

Methods

activateSetting

Parameters

Returns boolean

clear

Returns void

clearText

Returns void

destroy

Returns void

eraseCursor

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

setOptionCursor

Parameters

Returns boolean

setScrollCursor

Parameters

Returns boolean

setup

Returns void

show

Parameters

Returns boolean

showDialogue

`Protected`awaitingActionInput

`Protected`cursor

`Protected`localStorageKey

`Protected`mode

`Protected`navigationIcons

`Protected`onActionInput

`Protected`rowsToDisplay

`Protected`settings

`Protected`textCallbackTimer

`Protected`textTimer

`Protected`title

`Protected`setMouseCursorStyle