SoulFire TypeScript SDK 2.10.3
    Preparing search index...

    Type Alias SettingsDefinition

    SettingsDefinition: Message<"soulfire.v1.SettingsDefinition"> & {
        id?: SettingsEntryIdentifier;
        scope: SettingsPageEntryScopeType;
        type:
            | { case: "string"; value: StringSetting }
            | { case: "int"; value: IntSetting }
            | { case: "double"; value: DoubleSetting }
            | { case: "bool"; value: BoolSetting }
            | { case: "combo"; value: ComboSetting }
            | { case: "stringList"; value: StringListSetting }
            | { case: "minMax"; value: MinMaxSetting }
            | { case: undefined; value?: undefined };
    }

    A complete setting definition that describes a single configurable value. Contains all information needed for a client to render the setting UI, validate input, and store/retrieve values by identifier. Definitions are exported from the server and referenced by SettingsPage.

    Type Declaration

    • Optionalid?: SettingsEntryIdentifier

      Unique identifier for this setting (namespace + key). Used to reference this setting from pages and to store/retrieve values.

      from field: soulfire.v1.SettingsEntryIdentifier id = 1;

    • scope: SettingsPageEntryScopeType

      The configuration scope where this setting applies (SERVER, INSTANCE, BOT). Determines where values are stored and how they cascade.

      from field: soulfire.v1.SettingsPageEntryScopeType scope = 2;

    • type:
          | { case: "string"; value: StringSetting }
          | { case: "int"; value: IntSetting }
          | { case: "double"; value: DoubleSetting }
          | { case: "bool"; value: BoolSetting }
          | { case: "combo"; value: ComboSetting }
          | { case: "stringList"; value: StringListSetting }
          | { case: "minMax"; value: MinMaxSetting }
          | { case: undefined; value?: undefined }

      The setting type and its UI configuration. Exactly one of these fields will be set based on the setting's data type.

      from oneof soulfire.v1.SettingsDefinition.type

    from message soulfire.v1.SettingsDefinition

    Settings
    Member Visibility