Class default

active

clear

• clear(): void

• Clear the UI elements and state.

  Returns void

eraseCursor

• eraseCursor(): void

• Erase the cursor from the UI.

  Returns void

getCursor

• getCursor(): number

• Returns number

getTextColor

• getTextColor(style, shadow?): string

• Parameters

  • style: TextStyle
  • shadow: boolean = false

  Returns string

getUi

• getUi(): default

• Returns default

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

• 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.

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

• setup(): void

• Setup UI elements

  Returns void

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.

updateBindings

• updateBindings(): void

• Update the bindings for the current active device configuration.

  Returns void

updateSettingsScroll

• updateSettingsScroll(): void

• Update the scroll position of the settings UI.

  Returns void