PokéRogue
    Preparing search index...

    Abstract class for handling UI elements related to settings.

    Hierarchy (View Summary)

    Index
    active: boolean = false
    awaitingActionInput: boolean
    category: keyof UserFacingSettings
    cursor: number = 0
    message: Text
    navigationIcons: InputsIcons
    onActionInput: AnyFn<any> | null
    pendingPrompt: boolean = false
    prompt: Sprite
    rowsToDisplay: number = 8
    settingsTabs: { labelKey: string; mode: UiMode }[] = ...
    tabMenu: TabMenu
    textCallbackTimer: TimerEvent | null
    textTimer: TimerEvent | null
    title: string
    tutorialActive: boolean = false
    tutorialOverlay: Rectangle
    • Parameters

      • lang:
            | "en"
            | "es-ES"
            | "es-419"
            | "fr"
            | "de"
            | "it"
            | "pt-BR"
            | "ko"
            | "ja"
            | "zh-Hans"
            | "zh-Hant"
            | "th"
            | "ca"
            | "eu"
            | "tr"
            | "ru"
            | "uk"
            | "pl"
            | "id"
            | "hi"
            | "vi"
            | "da"
            | "sv"
            | "tl"
      • label: string

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

    • Set the option cursor to the specified position.

      Parameters

      • settingIndex: number

        The index of the setting or -1 to change the current 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.

    • Parameters

      • text: string
      • Optional_name: string
      • Optionaldelay: number | null
      • Optionalcallback: (() => void) | null
      • OptionalcallbackDelay: number | null
      • Optionalprompt: boolean | null
      • OptionalpromptDelay: number | null

      Returns void

    • Parameters

      • text: string
      • Optionaldelay: number
      • Optionalcallback: () => void
      • OptionalcallbackDelay: number
      • Optionalprompt: boolean
      • OptionalpromptDelay: number

      Returns void