Blockbench Reference Docs
    Preparing search index...

    Class Setting

    Settings can be used to add global configuration options to Blockbench. All settings are listed under File > Preferences > Settings.

    Index

    Constructors

    constructor

    Properties

    category click condition default_value description hidden icon id keybind_label launch_setting master_value max? min? name onChange options plugin? requires_restart step? type

    Accessors

    ui_value value

    Methods

    delete set trigger

    Constructors

    Properties

    category: string
    click: (event: MouseEvent | KeyboardEvent) => void
    condition: any
    default_value: SettingsValue
    description: string
    hidden: boolean
    icon: string
    id: string
    keybind_label: string
    launch_setting: boolean
    master_value: SettingsValue

    The master value, not affected by profiles

    max?: number
    min?: number
    name: string
    onChange: (value: SettingsValue) => void
    options: Record<string, string>
    plugin?: string
    requires_restart: boolean
    step?: number
    type: SettingsType

    Accessors

    • get ui_value(): SettingsValue

      The value that is displayed in the settings dialog

      Returns SettingsValue

    • set ui_value(value: SettingsValue): void

      Parameters

      • value: SettingsValue

      Returns void

    • get value(): SettingsValue

      The active value

      Returns SettingsValue

    • set value(value: SettingsValue): void

      Parameters

      • value: SettingsValue

      Returns void

    Methods

    • Returns void

    • Sets the value of the setting, while triggering the onChange function if available, and saving the change.

      Parameters

      • value: SettingsValue

      Returns void

    • Triggers the setting, as if selected in action control. This toggles boolean settings, opens a dialog for string or numeric settings, etc.

      Parameters

      • e: MouseEvent | KeyboardEvent

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods