Class SettingsPage

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.soulfiremc.grpc.generated.SettingsPage
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, SettingsPageOrBuilder, Serializable
@Generated public final class SettingsPage extends com.google.protobuf.GeneratedMessage implements SettingsPageOrBuilder
A settings page that groups related settings together for UI navigation.
Pages provide a logical organization of settings with visual elements like
icons and names. Each page references settings by their identifiers rather
than embedding the definitions, allowing settings to be shared across pages.
Protobuf type soulfire.v1.SettingsPage
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    SettingsPage.Builder
    A settings page that groups related settings together for UI navigation.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT, T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    ENABLED_IDENTIFIER_FIELD_NUMBER
     
    static final int
    ENTRIES_FIELD_NUMBER
     
    static final int
    ICON_ID_FIELD_NUMBER
     
    static final int
    ID_FIELD_NUMBER
     
    static final int
    OWNING_PLUGIN_ID_FIELD_NUMBER
     
    static final int
    PAGE_NAME_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static SettingsPage
    getDefaultInstance()
     
    SettingsPage
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    SettingsEntryIdentifier
    getEnabledIdentifier()
    Optional identifier for a boolean setting that controls whether this page/feature is enabled.
    SettingsEntryIdentifierOrBuilder
    getEnabledIdentifierOrBuilder()
    Optional identifier for a boolean setting that controls whether this page/feature is enabled.
    SettingsEntryIdentifier
    getEntries(int index)
    Ordered list of setting identifiers to display on this page.
    int
    getEntriesCount()
    Ordered list of setting identifiers to display on this page.
    List<SettingsEntryIdentifier>
    getEntriesList()
    Ordered list of setting identifiers to display on this page.
    SettingsEntryIdentifierOrBuilder
    getEntriesOrBuilder(int index)
    Ordered list of setting identifiers to display on this page.
    List<? extends SettingsEntryIdentifierOrBuilder>
    getEntriesOrBuilderList()
    Ordered list of setting identifiers to display on this page.
    String
    getIconId()
    Icon identifier for visual representation of this page.
    com.google.protobuf.ByteString
    getIconIdBytes()
    Icon identifier for visual representation of this page.
    String
    getId()
    Unique page identifier, URL-safe for navigation.
    com.google.protobuf.ByteString
    getIdBytes()
    Unique page identifier, URL-safe for navigation.
    String
    getOwningPluginId()
    The ID of the plugin that owns this page (optional).
    com.google.protobuf.ByteString
    getOwningPluginIdBytes()
    The ID of the plugin that owns this page (optional).
    String
    getPageName()
    The human-readable display name shown in the UI navigation.
    com.google.protobuf.ByteString
    getPageNameBytes()
    The human-readable display name shown in the UI navigation.
    com.google.protobuf.Parser<SettingsPage>
    getParserForType()
     
    int
    getSerializedSize()
     
    boolean
    hasEnabledIdentifier()
    Optional identifier for a boolean setting that controls whether this page/feature is enabled.
    int
    hashCode()
     
    boolean
    hasOwningPluginId()
    The ID of the plugin that owns this page (optional).
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static SettingsPage.Builder
    newBuilder()
     
    static SettingsPage.Builder
    newBuilder(SettingsPage prototype)
     
    SettingsPage.Builder
    newBuilderForType()
     
    protected SettingsPage.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static SettingsPage
    parseDelimitedFrom(InputStream input)
     
    static SettingsPage
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SettingsPage
    parseFrom(byte[] data)
     
    static SettingsPage
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SettingsPage
    parseFrom(com.google.protobuf.ByteString data)
     
    static SettingsPage
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SettingsPage
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static SettingsPage
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SettingsPage
    parseFrom(InputStream input)
     
    static SettingsPage
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SettingsPage
    parseFrom(ByteBuffer data)
     
    static SettingsPage
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<SettingsPage>
    parser()
     
    SettingsPage.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • ID_FIELD_NUMBER

      public static final int ID_FIELD_NUMBER
      See Also:

    • OWNING_PLUGIN_ID_FIELD_NUMBER

      public static final int OWNING_PLUGIN_ID_FIELD_NUMBER
      See Also:

    • PAGE_NAME_FIELD_NUMBER

      public static final int PAGE_NAME_FIELD_NUMBER
      See Also:

    • ENTRIES_FIELD_NUMBER

      public static final int ENTRIES_FIELD_NUMBER
      See Also:

    • ICON_ID_FIELD_NUMBER

      public static final int ICON_ID_FIELD_NUMBER
      See Also:

    • ENABLED_IDENTIFIER_FIELD_NUMBER

      public static final int ENABLED_IDENTIFIER_FIELD_NUMBER
      See Also:

  • 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

    • getId

      public String getId()
      Unique page identifier, URL-safe for navigation.
Examples: "bot", "account", "auto-reconnect", "anti-afk".
Should be lowercase with hyphens for word separation.
      string id = 1;
      Specified by:
      getId in interface SettingsPageOrBuilder
      Returns:
      The id.

    • getIdBytes

      public com.google.protobuf.ByteString getIdBytes()
      Unique page identifier, URL-safe for navigation.
Examples: "bot", "account", "auto-reconnect", "anti-afk".
Should be lowercase with hyphens for word separation.
      string id = 1;
      Specified by:
      getIdBytes in interface SettingsPageOrBuilder
      Returns:
      The bytes for id.

    • hasOwningPluginId

      public boolean hasOwningPluginId()
      The ID of the plugin that owns this page (optional).
Null/empty for internal SoulFire pages.
Used to group pages by plugin in the UI navigation.
      optional string owning_plugin_id = 2;
      Specified by:
      hasOwningPluginId in interface SettingsPageOrBuilder
      Returns:
      Whether the owningPluginId field is set.

    • getOwningPluginId

      public String getOwningPluginId()
      The ID of the plugin that owns this page (optional).
Null/empty for internal SoulFire pages.
Used to group pages by plugin in the UI navigation.
      optional string owning_plugin_id = 2;
      Specified by:
      getOwningPluginId in interface SettingsPageOrBuilder
      Returns:
      The owningPluginId.

    • getOwningPluginIdBytes

      public com.google.protobuf.ByteString getOwningPluginIdBytes()
      The ID of the plugin that owns this page (optional).
Null/empty for internal SoulFire pages.
Used to group pages by plugin in the UI navigation.
      optional string owning_plugin_id = 2;
      Specified by:
      getOwningPluginIdBytes in interface SettingsPageOrBuilder
      Returns:
      The bytes for owningPluginId.

    • getPageName

      public String getPageName()
      The human-readable display name shown in the UI navigation.
Examples: "Bot Settings", "Account", "Auto Reconnect".
      string page_name = 3;
      Specified by:
      getPageName in interface SettingsPageOrBuilder
      Returns:
      The pageName.

    • getPageNameBytes

      public com.google.protobuf.ByteString getPageNameBytes()
      The human-readable display name shown in the UI navigation.
Examples: "Bot Settings", "Account", "Auto Reconnect".
      string page_name = 3;
      Specified by:
      getPageNameBytes in interface SettingsPageOrBuilder
      Returns:
      The bytes for pageName.

    • getEntriesList

      public List<SettingsEntryIdentifier> getEntriesList()
      Ordered list of setting identifiers to display on this page.
Settings are rendered in the order they appear in this list.
Each identifier must correspond to a valid SettingsDefinition.
      repeated .soulfire.v1.SettingsEntryIdentifier entries = 5;
      Specified by:
      getEntriesList in interface SettingsPageOrBuilder

    • getEntriesOrBuilderList

      public List<? extends SettingsEntryIdentifierOrBuilder> getEntriesOrBuilderList()
      Ordered list of setting identifiers to display on this page.
Settings are rendered in the order they appear in this list.
Each identifier must correspond to a valid SettingsDefinition.
      repeated .soulfire.v1.SettingsEntryIdentifier entries = 5;
      Specified by:
      getEntriesOrBuilderList in interface SettingsPageOrBuilder

    • getEntriesCount

      public int getEntriesCount()
      Ordered list of setting identifiers to display on this page.
Settings are rendered in the order they appear in this list.
Each identifier must correspond to a valid SettingsDefinition.
      repeated .soulfire.v1.SettingsEntryIdentifier entries = 5;
      Specified by:
      getEntriesCount in interface SettingsPageOrBuilder

    • getEntries

      public SettingsEntryIdentifier getEntries(int index)
      Ordered list of setting identifiers to display on this page.
Settings are rendered in the order they appear in this list.
Each identifier must correspond to a valid SettingsDefinition.
      repeated .soulfire.v1.SettingsEntryIdentifier entries = 5;
      Specified by:
      getEntries in interface SettingsPageOrBuilder

    • getEntriesOrBuilder

      public SettingsEntryIdentifierOrBuilder getEntriesOrBuilder(int index)
      Ordered list of setting identifiers to display on this page.
Settings are rendered in the order they appear in this list.
Each identifier must correspond to a valid SettingsDefinition.
      repeated .soulfire.v1.SettingsEntryIdentifier entries = 5;
      Specified by:
      getEntriesOrBuilder in interface SettingsPageOrBuilder

    • getIconId

      public String getIconId()
      Icon identifier for visual representation of this page.
Uses lucide.dev icon IDs (e.g., "bot", "user", "refresh-cw").
Rendered next to the page name in navigation menus.
      string icon_id = 6;
      Specified by:
      getIconId in interface SettingsPageOrBuilder
      Returns:
      The iconId.

    • getIconIdBytes

      public com.google.protobuf.ByteString getIconIdBytes()
      Icon identifier for visual representation of this page.
Uses lucide.dev icon IDs (e.g., "bot", "user", "refresh-cw").
Rendered next to the page name in navigation menus.
      string icon_id = 6;
      Specified by:
      getIconIdBytes in interface SettingsPageOrBuilder
      Returns:
      The bytes for iconId.

    • hasEnabledIdentifier

      public boolean hasEnabledIdentifier()
      Optional identifier for a boolean setting that controls whether
this page/feature is enabled. Used primarily for plugin pages.
When set, the page may show an enable/disable toggle.
      optional .soulfire.v1.SettingsEntryIdentifier enabled_identifier = 7;
      Specified by:
      hasEnabledIdentifier in interface SettingsPageOrBuilder
      Returns:
      Whether the enabledIdentifier field is set.

    • getEnabledIdentifier

      public SettingsEntryIdentifier getEnabledIdentifier()
      Optional identifier for a boolean setting that controls whether
this page/feature is enabled. Used primarily for plugin pages.
When set, the page may show an enable/disable toggle.
      optional .soulfire.v1.SettingsEntryIdentifier enabled_identifier = 7;
      Specified by:
      getEnabledIdentifier in interface SettingsPageOrBuilder
      Returns:
      The enabledIdentifier.

    • getEnabledIdentifierOrBuilder

      public SettingsEntryIdentifierOrBuilder getEnabledIdentifierOrBuilder()
      Optional identifier for a boolean setting that controls whether
this page/feature is enabled. Used primarily for plugin pages.
When set, the page may show an enable/disable toggle.
      optional .soulfire.v1.SettingsEntryIdentifier enabled_identifier = 7;
      Specified by:
      getEnabledIdentifierOrBuilder in interface SettingsPageOrBuilder

    • 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 SettingsPage parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static SettingsPage.Builder newBuilder()

    • newBuilder

      public static SettingsPage.Builder newBuilder(SettingsPage prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static SettingsPage getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<SettingsPage> 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 SettingsPage getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder