Class default`Abstract`

Abstract class for handling UI elements related to control settings.

Hierarchy (view full)

default
- default
  - default
  - default

Constructors

constructor

new default(mode?): default
Constructor for the AbstractSettingsUiHandler.
Parameters
- mode: null | Mode = null
  The UI mode.
Returns default
Overrides default.constructor
- Defined in src/ui/settings/abstract-control-settings-ui-handler.ts:77

Properties

`Protected`actionsBg

actionsBg: NineSlice

active

active: boolean = false

`Protected`bindingSettings

bindingSettings: String[]

`Protected`commonSettingsCount

commonSettingsCount: any

`Protected`configs

configs: any

`Protected`cursor

cursor: number = 0

`Protected`cursorObj

cursorObj: null | NineSlice

`Protected`device

device: Device

`Protected`inputsIcons

inputsIcons: InputsIcons

`Protected`keys

keys: String[]

`Protected`layout

layout: Map<string, LayoutConfig> = ...

`Protected`localStoragePropertyName

localStoragePropertyName: any

`Protected`mode

mode: null | number

`Protected`navigationContainer

navigationContainer: default

`Protected`navigationIcons

navigationIcons: InputsIcons

`Protected`optionCursors

optionCursors: number[]

`Protected`optionValueLabels

optionValueLabels: Text[][]

`Protected`optionsBg

optionsBg: NineSlice

`Protected`optionsContainer

optionsContainer: Container

`Protected`rowsToDisplay

rowsToDisplay: number

`Protected`scrollBar

scrollBar: ScrollBar

`Protected`scrollCursor

scrollCursor: number

`Protected`setting

setting: any

`Protected`settingBlacklisted

settingBlacklisted: any

`Protected`settingDeviceDefaults

settingDeviceDefaults: any

`Protected`settingDeviceOptions

settingDeviceOptions: any

`Protected`settingLabels

settingLabels: Text[]

`Protected`settingsContainer

settingsContainer: Container

`Protected`textureOverride

textureOverride: any

`Protected`titleSelected

titleSelected: any

Methods

clear

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

Returns void
Overrides default.clear
- Defined in src/ui/settings/abstract-control-settings-ui-handler.ts:662

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
- Defined in src/ui/settings/abstract-control-settings-ui-handler.ts:675

getActiveConfig

getActiveConfig(): InterfaceConfig
Get the active configuration.

Returns InterfaceConfig
The active configuration for current device
- Defined in src/ui/settings/abstract-control-settings-ui-handler.ts:290

getCursor

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

getLocalStorageSetting

getLocalStorageSetting(): object
Returns object
- Defined in src/ui/settings/abstract-control-settings-ui-handler.ts:82

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

processInput

processInput(button): boolean
Process the input for the given button.
Parameters
- button: Button
  The button to process.
Returns boolean
true if the input was processed successfully.
Overrides default.processInput
- Defined in src/ui/settings/abstract-control-settings-ui-handler.ts:435

resetScroll

resetScroll(): void
Returns void
- Defined in src/ui/settings/abstract-control-settings-ui-handler.ts:534

`Abstract`saveSettingToLocalStorage

saveSettingToLocalStorage(setting, cursor): void
Parameters
- setting: any
- cursor: any
Returns void
- Defined in src/ui/settings/abstract-control-settings-ui-handler.ts:69

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.
Overrides default.setCursor
- Defined in src/ui/settings/abstract-control-settings-ui-handler.ts:549

setLayout

setLayout(activeConfig): boolean
Set the UI layout for the active device configuration.
Parameters
- activeConfig: InterfaceConfig
  The active device configuration.
Returns boolean
true if the layout was successfully applied, otherwise false.
- Defined in src/ui/settings/abstract-control-settings-ui-handler.ts:398

`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.
- 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.
- Defined in src/ui/settings/abstract-control-settings-ui-handler.ts:603

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.
- Defined in src/ui/settings/abstract-control-settings-ui-handler.ts:576

`Abstract`setSetting

setSetting(setting, value): boolean
Parameters
- setting: any
- value: number
Returns boolean
- Defined in src/ui/settings/abstract-control-settings-ui-handler.ts:70

setup

setup(): void
Setup UI elements.

Returns void
Overrides default.setup
- Defined in src/ui/settings/abstract-control-settings-ui-handler.ts:97

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.
Overrides default.show
- Defined in src/ui/settings/abstract-control-settings-ui-handler.ts:369

updateBindings

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

Returns void
- Defined in src/ui/settings/abstract-control-settings-ui-handler.ts:297

updateNavigationDisplay

updateNavigationDisplay(): void
Returns void
- Defined in src/ui/settings/abstract-control-settings-ui-handler.ts:339

updateSettingsScroll

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

Returns void
- Defined in src/ui/settings/abstract-control-settings-ui-handler.ts:637

Class defaultAbstract

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns default

Properties

ProtectedactionsBg

active

ProtectedbindingSettings

ProtectedcommonSettingsCount

Protectedconfigs

Protectedcursor

ProtectedcursorObj

Protecteddevice

ProtectedinputsIcons

Protectedkeys

Protectedlayout

ProtectedlocalStoragePropertyName

Protectedmode

ProtectednavigationContainer

ProtectednavigationIcons

ProtectedoptionCursors

ProtectedoptionValueLabels

ProtectedoptionsBg

ProtectedoptionsContainer

ProtectedrowsToDisplay

ProtectedscrollBar

ProtectedscrollCursor

Protectedsetting

ProtectedsettingBlacklisted

ProtectedsettingDeviceDefaults

ProtectedsettingDeviceOptions

ProtectedsettingLabels

ProtectedsettingsContainer

ProtectedtextureOverride

ProtectedtitleSelected

Methods

clear

Returns void

destroy

Returns void

eraseCursor

Returns void

getActiveConfig

Returns InterfaceConfig

getCursor

Returns number

getLocalStorageSetting

Returns object

getTextColor

Parameters

Returns string

getUi

Returns default

processInput

Parameters

Returns boolean

resetScroll

Returns void

AbstractsaveSettingToLocalStorage

Parameters

Returns void

setCursor

Parameters

Returns boolean

setLayout

Parameters

Returns boolean

ProtectedsetMouseCursorStyle

Parameters

Returns void

See

setOptionCursor

Parameters

Returns boolean

Class default`Abstract`

`Protected`actionsBg

`Protected`bindingSettings

`Protected`commonSettingsCount

`Protected`configs

`Protected`cursor

`Protected`cursorObj

`Protected`device

`Protected`inputsIcons

`Protected`keys

`Protected`layout

`Protected`localStoragePropertyName

`Protected`mode

`Protected`navigationContainer

`Protected`navigationIcons

`Protected`optionCursors

`Protected`optionValueLabels

`Protected`optionsBg

`Protected`optionsContainer

`Protected`rowsToDisplay

`Protected`scrollBar

`Protected`scrollCursor

`Protected`setting

`Protected`settingBlacklisted

`Protected`settingDeviceDefaults

`Protected`settingDeviceOptions

`Protected`settingLabels

`Protected`settingsContainer

`Protected`textureOverride

`Protected`titleSelected

`Abstract`saveSettingToLocalStorage

`Protected`setMouseCursorStyle

`Abstract`setSetting