Class default

Abstract class for handling UI elements related to settings.

Hierarchy (view full)

Constructors

constructor

Properties

active cursor cursorObj localStorageKey mode navigationContainer navigationIcons optionCursors optionValueLabels optionsBg optionsContainer reloadRequired reloadSettings rowsToDisplay scene scrollCursor settingLabels settings settingsContainer title

Methods

clear eraseCursor getCursor getTextColor getUi processInput setCursor setOptionCursor setScrollCursor setup show updateBindings updateSettingsScroll

Constructors

constructor

Properties

active

active: boolean = false

Protected cursor

cursor: number = 0

Private cursorObj

cursorObj: NineSlice

Protected localStorageKey

localStorageKey: string

Protected mode

mode: number

Private navigationContainer

navigationContainer: default

Protected navigationIcons

navigationIcons: InputsIcons

Private optionCursors

optionCursors: number[]

Private optionValueLabels

optionValueLabels: Text[][]

Private optionsBg

optionsBg: NineSlice

Private optionsContainer

optionsContainer: Container

Private reloadRequired

reloadRequired: boolean

Private reloadSettings

reloadSettings: Setting[]

Private rowsToDisplay

rowsToDisplay: number

Protected scene

scene: default

Private scrollCursor

scrollCursor: number

Private settingLabels

settingLabels: Text[]

Protected settings

settings: Setting[]

Private settingsContainer

settingsContainer: Container

Protected title

title: string

Methods

clear

eraseCursor

getCursor

getTextColor

getUi

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.

setCursor

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.

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.

setup

show

updateBindings

updateSettingsScroll

Settings

Member Visibility

Theme

On This Page

constructoractivecursorcursorObjlocalStorageKeymodenavigationContainernavigationIconsoptionCursorsoptionValueLabelsoptionsBgoptionsContainerreloadRequiredreloadSettingsrowsToDisplayscenescrollCursorsettingLabelssettingssettingsContainertitlecleareraseCursorgetCursorgetTextColorgetUiprocessInputsetCursorsetOptionCursorsetScrollCursorsetupshowupdateBindingsupdateSettingsScroll