Class SettingsDefinition

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.soulfiremc.grpc.generated.SettingsDefinition
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, SettingsDefinitionOrBuilder, Serializable
@Generated public final class SettingsDefinition extends com.google.protobuf.GeneratedMessage implements SettingsDefinitionOrBuilder
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.
Protobuf type soulfire.v1.SettingsDefinition
See Also:

  • Field Details

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getTypeCase

      public SettingsDefinition.TypeCase getTypeCase()
      Specified by:
      getTypeCase in interface SettingsDefinitionOrBuilder

    • hasId

      public boolean hasId()
      Unique identifier for this setting (namespace + key).
Used to reference this setting from pages and to store/retrieve values.
      .soulfire.v1.SettingsEntryIdentifier id = 1;
      Specified by:
      hasId in interface SettingsDefinitionOrBuilder
      Returns:
      Whether the id field is set.

    • getId

      public SettingsEntryIdentifier getId()
      Unique identifier for this setting (namespace + key).
Used to reference this setting from pages and to store/retrieve values.
      .soulfire.v1.SettingsEntryIdentifier id = 1;
      Specified by:
      getId in interface SettingsDefinitionOrBuilder
      Returns:
      The id.

    • getIdOrBuilder

      public SettingsEntryIdentifierOrBuilder getIdOrBuilder()
      Unique identifier for this setting (namespace + key).
Used to reference this setting from pages and to store/retrieve values.
      .soulfire.v1.SettingsEntryIdentifier id = 1;
      Specified by:
      getIdOrBuilder in interface SettingsDefinitionOrBuilder

    • getScopeValue

      public int getScopeValue()
      The configuration scope where this setting applies (SERVER, INSTANCE, BOT).
Determines where values are stored and how they cascade.
      .soulfire.v1.SettingsPageEntryScopeType scope = 2;
      Specified by:
      getScopeValue in interface SettingsDefinitionOrBuilder
      Returns:
      The enum numeric value on the wire for scope.

    • getScope

      public SettingsPageEntryScopeType getScope()
      The configuration scope where this setting applies (SERVER, INSTANCE, BOT).
Determines where values are stored and how they cascade.
      .soulfire.v1.SettingsPageEntryScopeType scope = 2;
      Specified by:
      getScope in interface SettingsDefinitionOrBuilder
      Returns:
      The scope.

    • hasString

      public boolean hasString()
      String/text setting with optional validation.
      .soulfire.v1.StringSetting string = 3;
      Specified by:
      hasString in interface SettingsDefinitionOrBuilder
      Returns:
      Whether the string field is set.

    • getString

      public StringSetting getString()
      String/text setting with optional validation.
      .soulfire.v1.StringSetting string = 3;
      Specified by:
      getString in interface SettingsDefinitionOrBuilder
      Returns:
      The string.

    • getStringOrBuilder

      public StringSettingOrBuilder getStringOrBuilder()
      String/text setting with optional validation.
      .soulfire.v1.StringSetting string = 3;
      Specified by:
      getStringOrBuilder in interface SettingsDefinitionOrBuilder

    • hasInt

      public boolean hasInt()
      Integer number setting with range constraints.
      .soulfire.v1.IntSetting int = 4;
      Specified by:
      hasInt in interface SettingsDefinitionOrBuilder
      Returns:
      Whether the int field is set.

    • getInt

      public IntSetting getInt()
      Integer number setting with range constraints.
      .soulfire.v1.IntSetting int = 4;
      Specified by:
      getInt in interface SettingsDefinitionOrBuilder
      Returns:
      The int.

    • getIntOrBuilder

      public IntSettingOrBuilder getIntOrBuilder()
      Integer number setting with range constraints.
      .soulfire.v1.IntSetting int = 4;
      Specified by:
      getIntOrBuilder in interface SettingsDefinitionOrBuilder

    • hasDouble

      public boolean hasDouble()
      Floating-point number setting with precision control.
      .soulfire.v1.DoubleSetting double = 5;
      Specified by:
      hasDouble in interface SettingsDefinitionOrBuilder
      Returns:
      Whether the double field is set.

    • getDouble

      public DoubleSetting getDouble()
      Floating-point number setting with precision control.
      .soulfire.v1.DoubleSetting double = 5;
      Specified by:
      getDouble in interface SettingsDefinitionOrBuilder
      Returns:
      The double.

    • getDoubleOrBuilder

      public DoubleSettingOrBuilder getDoubleOrBuilder()
      Floating-point number setting with precision control.
      .soulfire.v1.DoubleSetting double = 5;
      Specified by:
      getDoubleOrBuilder in interface SettingsDefinitionOrBuilder

    • hasBool

      public boolean hasBool()
      Boolean toggle setting.
      .soulfire.v1.BoolSetting bool = 6;
      Specified by:
      hasBool in interface SettingsDefinitionOrBuilder
      Returns:
      Whether the bool field is set.

    • getBool

      public BoolSetting getBool()
      Boolean toggle setting.
      .soulfire.v1.BoolSetting bool = 6;
      Specified by:
      getBool in interface SettingsDefinitionOrBuilder
      Returns:
      The bool.

    • getBoolOrBuilder

      public BoolSettingOrBuilder getBoolOrBuilder()
      Boolean toggle setting.
      .soulfire.v1.BoolSetting bool = 6;
      Specified by:
      getBoolOrBuilder in interface SettingsDefinitionOrBuilder

    • hasCombo

      public boolean hasCombo()
      Dropdown/select setting with predefined options.
      .soulfire.v1.ComboSetting combo = 7;
      Specified by:
      hasCombo in interface SettingsDefinitionOrBuilder
      Returns:
      Whether the combo field is set.

    • getCombo

      public ComboSetting getCombo()
      Dropdown/select setting with predefined options.
      .soulfire.v1.ComboSetting combo = 7;
      Specified by:
      getCombo in interface SettingsDefinitionOrBuilder
      Returns:
      The combo.

    • getComboOrBuilder

      public ComboSettingOrBuilder getComboOrBuilder()
      Dropdown/select setting with predefined options.
      .soulfire.v1.ComboSetting combo = 7;
      Specified by:
      getComboOrBuilder in interface SettingsDefinitionOrBuilder

    • hasStringList

      public boolean hasStringList()
      List of strings setting for multi-value input.
      .soulfire.v1.StringListSetting string_list = 8;
      Specified by:
      hasStringList in interface SettingsDefinitionOrBuilder
      Returns:
      Whether the stringList field is set.

    • getStringList

      public StringListSetting getStringList()
      List of strings setting for multi-value input.
      .soulfire.v1.StringListSetting string_list = 8;
      Specified by:
      getStringList in interface SettingsDefinitionOrBuilder
      Returns:
      The stringList.

    • getStringListOrBuilder

      public StringListSettingOrBuilder getStringListOrBuilder()
      List of strings setting for multi-value input.
      .soulfire.v1.StringListSetting string_list = 8;
      Specified by:
      getStringListOrBuilder in interface SettingsDefinitionOrBuilder

    • hasMinMax

      public boolean hasMinMax()
      Min/max range setting with two paired integer values.
      .soulfire.v1.MinMaxSetting min_max = 9;
      Specified by:
      hasMinMax in interface SettingsDefinitionOrBuilder
      Returns:
      Whether the minMax field is set.

    • getMinMax

      public MinMaxSetting getMinMax()
      Min/max range setting with two paired integer values.
      .soulfire.v1.MinMaxSetting min_max = 9;
      Specified by:
      getMinMax in interface SettingsDefinitionOrBuilder
      Returns:
      The minMax.

    • getMinMaxOrBuilder

      public MinMaxSettingOrBuilder getMinMaxOrBuilder()
      Min/max range setting with two paired integer values.
      .soulfire.v1.MinMaxSetting min_max = 9;
      Specified by:
      getMinMaxOrBuilder in interface SettingsDefinitionOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static SettingsDefinition parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SettingsDefinition parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SettingsDefinition parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SettingsDefinition parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SettingsDefinition parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SettingsDefinition parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SettingsDefinition parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SettingsDefinition parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SettingsDefinition parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SettingsDefinition parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SettingsDefinition parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SettingsDefinition parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public SettingsDefinition.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static SettingsDefinition.Builder newBuilder()

    • newBuilder

      public static SettingsDefinition.Builder newBuilder(SettingsDefinition prototype)

    • toBuilder

      public SettingsDefinition.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected SettingsDefinition.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static SettingsDefinition getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<SettingsDefinition> parser()

    • getParserForType

      public com.google.protobuf.Parser<SettingsDefinition> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public SettingsDefinition getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder