Class default

Class representing the settings UI handler for keyboards.

Hierarchy (view full)

default
- default

Index

Constructors

constructor

new default(scene, mode?): default
Creates an instance of SettingsKeyboardUiHandler.
Parameters
- scene: default
  The BattleScene instance.
- Optional mode: Mode
  The UI mode, optional.
Returns default
Overrides default.constructor
- Defined in src/ui/settings/settings-keyboard-ui-handler.ts:31

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: NineSlice

`Protected` inputsIcons

inputsIcons: InputsIcons

`Protected` keys

keys: String[]

`Protected` layout

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

`Protected` localStoragePropertyName

localStoragePropertyName: any

`Protected` mode

mode: 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` scene

scene: default

`Protected` scrollCursor

scrollCursor: number

`Protected` settingBlacklisted

settingBlacklisted: any

`Protected` settingDevice

settingDevice: 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
Inherited from default.clear
- Defined in src/ui/settings/abstract-settings-ui-handler.ts:624

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:637

getActiveConfig

getActiveConfig(): InterfaceConfig
Get the active configuration.

Returns InterfaceConfig
The active keyboard configuration.
Overrides default.getActiveConfig
- Defined in src/ui/settings/settings-keyboard-ui-handler.ts:122

getCursor

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

getLocalStorageSetting

getLocalStorageSetting(): object
Get the keyboard settings from local storage.

Returns object
The keyboard settings from local storage.
Overrides default.getLocalStorageSetting
- Defined in src/ui/settings/settings-keyboard-ui-handler.ts:131

getTextColor

getTextColor(style, shadow?): string
Parameters
- style: TextStyle
- shadow: boolean = false
Returns string
Inherited from default.getTextColor
- Defined in src/ui/ui-handler.ts:31

getUi

getUi(): default
Returns default
Inherited from default.getUi
- Defined in src/ui/ui-handler.ts:27

navigateMenuLeft

navigateMenuLeft(): boolean
Navigate to the left menu tab.

Returns boolean
true indicating the navigation was successful.
Overrides default.navigateMenuLeft
- Defined in src/ui/settings/settings-keyboard-ui-handler.ts:162

navigateMenuRight

navigateMenuRight(): boolean
Navigate to the right menu tab.

Returns boolean
true indicating the navigation was successful.
Overrides default.navigateMenuRight
- Defined in src/ui/settings/settings-keyboard-ui-handler.ts:172

onDeleteDown

onDeleteDown(): void
Handle the delete key press event.

Returns void
- Defined in src/ui/settings/settings-keyboard-ui-handler.ts:100

onHomeDown

onHomeDown(): void
Handle the home key press event.

Returns void
- Defined in src/ui/settings/settings-keyboard-ui-handler.ts:89

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.
Inherited from default.processInput
- Defined in src/ui/settings/abstract-settings-ui-handler.ts:399

resetScroll

resetScroll(): void
Returns void
Inherited from default.resetScroll
- Defined in src/ui/settings/abstract-settings-ui-handler.ts:498

saveCustomKeyboardMappingToLocalStorage

saveCustomKeyboardMappingToLocalStorage(config): void
Save the custom keyboard mapping to local storage.
Parameters
- config: any
  The configuration to save.
Returns void
- Defined in src/ui/settings/settings-keyboard-ui-handler.ts:209

saveSettingToLocalStorage

saveSettingToLocalStorage(settingName, cursor): void
Save the setting to local storage.
Parameters
- settingName: any
  The name of the setting to save.
- cursor: any
  The cursor position to save.
Returns void
Overrides default.saveSettingToLocalStorage
- Defined in src/ui/settings/settings-keyboard-ui-handler.ts:219

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:513

setLayout

setLayout(activeConfig): boolean
Set the layout for the active configuration.
Parameters
- activeConfig: InterfaceConfig
  The active keyboard configuration.
Returns boolean
true if the layout was successfully applied, otherwise false.
Overrides default.setLayout
- Defined in src/ui/settings/settings-keyboard-ui-handler.ts:143

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.
- Optional save: 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:565

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:539

setSetting

setSetting(scene, setting, value): boolean
Parameters
- scene: default
- setting: any
- value: number
Returns boolean
Overrides default.setSetting
- Defined in src/ui/settings/settings-keyboard-ui-handler.ts:49

setup

setup(): void
Setup UI elements.

Returns void
Overrides default.setup
- Defined in src/ui/settings/settings-keyboard-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:335

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:263

updateChosenKeyboardDisplay

updateChosenKeyboardDisplay(): void
Update the display of the chosen keyboard layout.

Returns void
- Defined in src/ui/settings/settings-keyboard-ui-handler.ts:180

updateNavigationDisplay

updateNavigationDisplay(): void
Returns void
Inherited from default.updateNavigationDisplay
- Defined in src/ui/settings/abstract-settings-ui-handler.ts:305

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:599

Class default

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns default

Properties

Protected actionsBg

active

Protected bindingSettings

Protected commonSettingsCount

Protected configs

Protected cursor

Protected cursorObj

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 scene

Protected scrollCursor

Protected settingBlacklisted

Protected settingDevice

Protected settingDeviceDefaults

Protected settingDeviceOptions

Protected settingLabels

Protected settingsContainer

Protected textureOverride

Protected titleSelected

Methods

clear

Returns void

eraseCursor

Returns void

getActiveConfig

Returns InterfaceConfig

getCursor

Returns number

getLocalStorageSetting

Returns object

getTextColor

Parameters

Returns string

getUi

Returns default

navigateMenuLeft

Returns boolean

navigateMenuRight

Returns boolean

onDeleteDown

Returns void

onHomeDown

Returns void

processInput

Parameters

Returns boolean

resetScroll

Returns void

saveCustomKeyboardMappingToLocalStorage

Parameters

Returns void

saveSettingToLocalStorage

Parameters

Returns void

setCursor

Parameters

Returns boolean

setLayout

Parameters

`Protected` actionsBg

`Protected` bindingSettings

`Protected` commonSettingsCount

`Protected` configs

`Protected` cursor

`Protected` cursorObj

`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` scene

`Protected` scrollCursor

`Protected` settingBlacklisted

`Protected` settingDevice

`Protected` settingDeviceDefaults

`Protected` settingDeviceOptions

`Protected` settingLabels

`Protected` settingsContainer

`Protected` textureOverride

`Protected` titleSelected