Class BaseControlSettingsUiHandler`Abstract`

Abstract class for handling UI elements related to control settings.

Hierarchy (View Summary)

UiHandler
- BaseControlSettingsUiHandler
  - SettingsGamepadUiHandler
  - SettingsKeyboardUiHandler

Constructors

constructor

new BaseControlSettingsUiHandler(
mode?: UiMode | null,
): BaseControlSettingsUiHandler
Parameters
- mode: UiMode | null = null
Returns BaseControlSettingsUiHandler
Overrides UiHandler.constructor
- Defined in src/ui/settings/base-control-settings-ui-handler.ts:70

Properties

`Protected`actionsBg

actionsBg: NineSlice

active

active: boolean = false

`Protected`bindingSettings

bindingSettings: MappingSettingName[]

`Protected`commonSettingsCount

commonSettingsCount: any

`Protected`configs

configs: any

`Protected`cursor

cursor: number = 0

`Protected`cursorObj

cursorObj: NineSlice | null

`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: number | null

`Protected`navigationIcons

navigationIcons: InputsIcons

`Protected`optionCursors

optionCursors: number[]

`Protected`optionsBg

optionsBg: NineSlice

`Protected`optionsContainer

optionsContainer: Container

`Protected`optionValueLabels

optionValueLabels: Text[][]

`Protected`rowsToDisplay

rowsToDisplay: number

`Protected`scrollBar

scrollBar: ScrollBar

`Protected`scrollCursor

scrollCursor: number

`Protected`setting

setting: Record<string, MappingSettingName>

`Protected`settingBlacklisted

settingBlacklisted: string[]

`Protected`settingDeviceDefaults

settingDeviceDefaults: any

`Protected`settingDeviceOptions

settingDeviceOptions: any

`Protected`settingLabels

settingLabels: Text[]

`Protected`settingsContainer

settingsContainer: Container

`Protected` `Readonly`settingsTabs

settingsTabs: { labelKey: string; mode: UiMode }[] = ...

`Protected`tabMenu

tabMenu: TabMenu

`Protected`textureOverride

textureOverride: any

`Protected`titleSelected

titleSelected: any

Methods

clear

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

Returns void
Overrides UiHandler.clear
- Defined in src/ui/settings/base-control-settings-ui-handler.ts:709

destroy

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

Returns void
Inherited from UiHandler.destroy
- Defined in src/ui/handlers/ui-handler.ts:63

`Private`eraseCursor

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

Returns void
- Defined in src/ui/settings/base-control-settings-ui-handler.ts:722

`Protected`getActiveConfig

getActiveConfig(): CustomInterfaceConfig | null
Get the active configuration.

Returns CustomInterfaceConfig | null
The active configuration for current device
- Defined in src/ui/settings/base-control-settings-ui-handler.ts:318

getCursor

getCursor(): number
Returns number
Inherited from UiHandler.getCursor
- Defined in src/ui/handlers/ui-handler.ts:34

`Private`getLocalStorageSetting

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

getUi

getUi(): UI
Returns UI
Inherited from UiHandler.getUi
- Defined in src/ui/handlers/ui-handler.ts:30

processInput

processInput(button: 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 UiHandler.processInput
- Defined in src/ui/settings/base-control-settings-ui-handler.ts:471

`Protected`resetScroll

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

`Abstract`saveSettingToLocalStorage

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

setCursor

setCursor(cursor: number): 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 UiHandler.setCursor
- Defined in src/ui/settings/base-control-settings-ui-handler.ts:596

`Protected`setLayout

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

`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 UiHandler.setMouseCursorStyle
- Defined in src/ui/handlers/ui-handler.ts:52

setOptionCursor

setOptionCursor(settingIndex: number, cursor: number, save?: boolean): 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/base-control-settings-ui-handler.ts:650

setScrollCursor

setScrollCursor(scrollCursor: number): 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/base-control-settings-ui-handler.ts:623

`Abstract`setSetting

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

setup

setup(): void
Returns void
Overrides UiHandler.setup
- Defined in src/ui/settings/base-control-settings-ui-handler.ts:83

show

show(args: any[]): 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 UiHandler.show
- Defined in src/ui/settings/base-control-settings-ui-handler.ts:398

updateBindings

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

Returns void
- Defined in src/ui/settings/base-control-settings-ui-handler.ts:325

`Private`updateNavigationDisplay

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

`Private`updateSettingsScroll

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

Returns void
- Defined in src/ui/settings/base-control-settings-ui-handler.ts:684

Class BaseControlSettingsUiHandlerAbstract

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns BaseControlSettingsUiHandler

Properties

ProtectedactionsBg

active

ProtectedbindingSettings

ProtectedcommonSettingsCount

Protectedconfigs

Protectedcursor

ProtectedcursorObj

Protecteddevice

ProtectedinputsIcons

Protectedkeys

Protectedlayout

ProtectedlocalStoragePropertyName

Protectedmode

ProtectednavigationIcons

ProtectedoptionCursors

ProtectedoptionsBg

ProtectedoptionsContainer

ProtectedoptionValueLabels

ProtectedrowsToDisplay

ProtectedscrollBar

ProtectedscrollCursor

Protectedsetting

ProtectedsettingBlacklisted

ProtectedsettingDeviceDefaults

ProtectedsettingDeviceOptions

ProtectedsettingLabels

ProtectedsettingsContainer

Protected ReadonlysettingsTabs

ProtectedtabMenu

ProtectedtextureOverride

ProtectedtitleSelected

Methods

clear

Returns void

destroy

Returns void

PrivateeraseCursor

Returns void

ProtectedgetActiveConfig

Returns CustomInterfaceConfig | null

getCursor

Returns number

PrivategetLocalStorageSetting

Returns object

getUi

Returns UI

processInput

Parameters

Returns boolean

ProtectedresetScroll

Returns void

AbstractsaveSettingToLocalStorage

Parameters

Returns void

setCursor

Parameters

Returns boolean

ProtectedsetLayout

Parameters

Returns activeConfig is InterfaceConfig

ProtectedsetMouseCursorStyle

Parameters

Returns void

See

setOptionCursor

Parameters

Returns boolean

setScrollCursor

Parameters

Class BaseControlSettingsUiHandler`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`navigationIcons

`Protected`optionCursors

`Protected`optionsBg

`Protected`optionsContainer

`Protected`optionValueLabels

`Protected`rowsToDisplay

`Protected`scrollBar

`Protected`scrollCursor

`Protected`setting

`Protected`settingBlacklisted

`Protected`settingDeviceDefaults

`Protected`settingDeviceOptions

`Protected`settingLabels

`Protected`settingsContainer

`Protected` `Readonly`settingsTabs

`Protected`tabMenu

`Protected`textureOverride

`Protected`titleSelected

`Private`eraseCursor

`Protected`getActiveConfig

`Private`getLocalStorageSetting

`Protected`resetScroll

`Abstract`saveSettingToLocalStorage

`Protected`setLayout

`Protected`setMouseCursorStyle

`Abstract`setSetting

`Private`updateNavigationDisplay

`Private`updateSettingsScroll