Class ServerDialog

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.soulfiremc.grpc.generated.ServerDialog
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ServerDialogOrBuilder, Serializable
@Generated public final class ServerDialog extends com.google.protobuf.GeneratedMessage implements ServerDialogOrBuilder
Complete server dialog definition.
Contains all information needed to render and interact with a dialog.
Protobuf type soulfire.v1.ServerDialog
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

    • getId

      public String getId()
      Dialog identifier from the server.
Format: namespaced identifier (e.g., "myserver:welcome_dialog").
      string id = 1;
      Specified by:
      getId in interface ServerDialogOrBuilder
      Returns:
      The id.

    • getIdBytes

      public com.google.protobuf.ByteString getIdBytes()
      Dialog identifier from the server.
Format: namespaced identifier (e.g., "myserver:welcome_dialog").
      string id = 1;
      Specified by:
      getIdBytes in interface ServerDialogOrBuilder
      Returns:
      The bytes for id.

    • getTypeValue

      public int getTypeValue()
      The type of dialog, determining overall structure.
      .soulfire.v1.DialogType type = 2;
      Specified by:
      getTypeValue in interface ServerDialogOrBuilder
      Returns:
      The enum numeric value on the wire for type.

    • getType

      public DialogType getType()
      The type of dialog, determining overall structure.
      .soulfire.v1.DialogType type = 2;
      Specified by:
      getType in interface ServerDialogOrBuilder
      Returns:
      The type.

    • getTitle

      public String getTitle()
      Dialog title (may be a JSON text component).
      string title = 3;
      Specified by:
      getTitle in interface ServerDialogOrBuilder
      Returns:
      The title.

    • getTitleBytes

      public com.google.protobuf.ByteString getTitleBytes()
      Dialog title (may be a JSON text component).
      string title = 3;
      Specified by:
      getTitleBytes in interface ServerDialogOrBuilder
      Returns:
      The bytes for title.

    • hasExternalTitle

      public boolean hasExternalTitle()
      Button label when shown as an external/minimized button.
      optional string external_title = 4;
      Specified by:
      hasExternalTitle in interface ServerDialogOrBuilder
      Returns:
      Whether the externalTitle field is set.

    • getExternalTitle

      public String getExternalTitle()
      Button label when shown as an external/minimized button.
      optional string external_title = 4;
      Specified by:
      getExternalTitle in interface ServerDialogOrBuilder
      Returns:
      The externalTitle.

    • getExternalTitleBytes

      public com.google.protobuf.ByteString getExternalTitleBytes()
      Button label when shown as an external/minimized button.
      optional string external_title = 4;
      Specified by:
      getExternalTitleBytes in interface ServerDialogOrBuilder
      Returns:
      The bytes for externalTitle.

    • getBodyList

      public List<DialogBodyElement> getBodyList()
      Body elements (text and items) displayed in the dialog.
      repeated .soulfire.v1.DialogBodyElement body = 5;
      Specified by:
      getBodyList in interface ServerDialogOrBuilder

    • getBodyOrBuilderList

      public List<? extends DialogBodyElementOrBuilder> getBodyOrBuilderList()
      Body elements (text and items) displayed in the dialog.
      repeated .soulfire.v1.DialogBodyElement body = 5;
      Specified by:
      getBodyOrBuilderList in interface ServerDialogOrBuilder

    • getBodyCount

      public int getBodyCount()
      Body elements (text and items) displayed in the dialog.
      repeated .soulfire.v1.DialogBodyElement body = 5;
      Specified by:
      getBodyCount in interface ServerDialogOrBuilder

    • getBody

      public DialogBodyElement getBody(int index)
      Body elements (text and items) displayed in the dialog.
      repeated .soulfire.v1.DialogBodyElement body = 5;
      Specified by:
      getBody in interface ServerDialogOrBuilder

    • getBodyOrBuilder

      public DialogBodyElementOrBuilder getBodyOrBuilder(int index)
      Body elements (text and items) displayed in the dialog.
      repeated .soulfire.v1.DialogBodyElement body = 5;
      Specified by:
      getBodyOrBuilder in interface ServerDialogOrBuilder

    • getInputsList

      public List<DialogInput> getInputsList()
      Input controls for gathering user data.
      repeated .soulfire.v1.DialogInput inputs = 6;
      Specified by:
      getInputsList in interface ServerDialogOrBuilder

    • getInputsOrBuilderList

      public List<? extends DialogInputOrBuilder> getInputsOrBuilderList()
      Input controls for gathering user data.
      repeated .soulfire.v1.DialogInput inputs = 6;
      Specified by:
      getInputsOrBuilderList in interface ServerDialogOrBuilder

    • getInputsCount

      public int getInputsCount()
      Input controls for gathering user data.
      repeated .soulfire.v1.DialogInput inputs = 6;
      Specified by:
      getInputsCount in interface ServerDialogOrBuilder

    • getInputs

      public DialogInput getInputs(int index)
      Input controls for gathering user data.
      repeated .soulfire.v1.DialogInput inputs = 6;
      Specified by:
      getInputs in interface ServerDialogOrBuilder

    • getInputsOrBuilder

      public DialogInputOrBuilder getInputsOrBuilder(int index)
      Input controls for gathering user data.
      repeated .soulfire.v1.DialogInput inputs = 6;
      Specified by:
      getInputsOrBuilder in interface ServerDialogOrBuilder

    • getCanCloseWithEscape

      public boolean getCanCloseWithEscape()
      Whether ESC key can close the dialog.
Default: true.
      bool can_close_with_escape = 7;
      Specified by:
      getCanCloseWithEscape in interface ServerDialogOrBuilder
      Returns:
      The canCloseWithEscape.

    • getPause

      public boolean getPause()
      Whether to pause the game in singleplayer.
Default: true. No effect in multiplayer.
      bool pause = 8;
      Specified by:
      getPause in interface ServerDialogOrBuilder
      Returns:
      The pause.

    • getAfterActionValue

      public int getAfterActionValue()
      Behavior after an action button is clicked.
      .soulfire.v1.DialogAfterAction after_action = 9;
      Specified by:
      getAfterActionValue in interface ServerDialogOrBuilder
      Returns:
      The enum numeric value on the wire for afterAction.

    • getAfterAction

      public DialogAfterAction getAfterAction()
      Behavior after an action button is clicked.
      .soulfire.v1.DialogAfterAction after_action = 9;
      Specified by:
      getAfterAction in interface ServerDialogOrBuilder
      Returns:
      The afterAction.

    • hasAction

      public boolean hasAction()
      For NOTICE type: the single action button.
      optional .soulfire.v1.DialogButton action = 10;
      Specified by:
      hasAction in interface ServerDialogOrBuilder
      Returns:
      Whether the action field is set.

    • getAction

      public DialogButton getAction()
      For NOTICE type: the single action button.
      optional .soulfire.v1.DialogButton action = 10;
      Specified by:
      getAction in interface ServerDialogOrBuilder
      Returns:
      The action.

    • getActionOrBuilder

      public DialogButtonOrBuilder getActionOrBuilder()
      For NOTICE type: the single action button.
      optional .soulfire.v1.DialogButton action = 10;
      Specified by:
      getActionOrBuilder in interface ServerDialogOrBuilder

    • hasYes

      public boolean hasYes()
      For CONFIRMATION type: the "yes" button.
      optional .soulfire.v1.DialogButton yes = 11;
      Specified by:
      hasYes in interface ServerDialogOrBuilder
      Returns:
      Whether the yes field is set.

    • getYes

      public DialogButton getYes()
      For CONFIRMATION type: the "yes" button.
      optional .soulfire.v1.DialogButton yes = 11;
      Specified by:
      getYes in interface ServerDialogOrBuilder
      Returns:
      The yes.

    • getYesOrBuilder

      public DialogButtonOrBuilder getYesOrBuilder()
      For CONFIRMATION type: the "yes" button.
      optional .soulfire.v1.DialogButton yes = 11;
      Specified by:
      getYesOrBuilder in interface ServerDialogOrBuilder

    • hasNo

      public boolean hasNo()
      For CONFIRMATION type: the "no" button.
      optional .soulfire.v1.DialogButton no = 12;
      Specified by:
      hasNo in interface ServerDialogOrBuilder
      Returns:
      Whether the no field is set.

    • getNo

      public DialogButton getNo()
      For CONFIRMATION type: the "no" button.
      optional .soulfire.v1.DialogButton no = 12;
      Specified by:
      getNo in interface ServerDialogOrBuilder
      Returns:
      The no.

    • getNoOrBuilder

      public DialogButtonOrBuilder getNoOrBuilder()
      For CONFIRMATION type: the "no" button.
      optional .soulfire.v1.DialogButton no = 12;
      Specified by:
      getNoOrBuilder in interface ServerDialogOrBuilder

    • getActionsList

      public List<DialogButton> getActionsList()
      For MULTI_ACTION type: list of action buttons.
      repeated .soulfire.v1.DialogButton actions = 13;
      Specified by:
      getActionsList in interface ServerDialogOrBuilder

    • getActionsOrBuilderList

      public List<? extends DialogButtonOrBuilder> getActionsOrBuilderList()
      For MULTI_ACTION type: list of action buttons.
      repeated .soulfire.v1.DialogButton actions = 13;
      Specified by:
      getActionsOrBuilderList in interface ServerDialogOrBuilder

    • getActionsCount

      public int getActionsCount()
      For MULTI_ACTION type: list of action buttons.
      repeated .soulfire.v1.DialogButton actions = 13;
      Specified by:
      getActionsCount in interface ServerDialogOrBuilder

    • getActions

      public DialogButton getActions(int index)
      For MULTI_ACTION type: list of action buttons.
      repeated .soulfire.v1.DialogButton actions = 13;
      Specified by:
      getActions in interface ServerDialogOrBuilder

    • getActionsOrBuilder

      public DialogButtonOrBuilder getActionsOrBuilder(int index)
      For MULTI_ACTION type: list of action buttons.
      repeated .soulfire.v1.DialogButton actions = 13;
      Specified by:
      getActionsOrBuilder in interface ServerDialogOrBuilder

    • getColumns

      public int getColumns()
      For MULTI_ACTION and DIALOG_LIST: number of button columns.
Default: 2.
      int32 columns = 14;
      Specified by:
      getColumns in interface ServerDialogOrBuilder
      Returns:
      The columns.

    • hasExitAction

      public boolean hasExitAction()
      For MULTI_ACTION, SERVER_LINKS, DIALOG_LIST: exit/close button.
      optional .soulfire.v1.DialogButton exit_action = 15;
      Specified by:
      hasExitAction in interface ServerDialogOrBuilder
      Returns:
      Whether the exitAction field is set.

    • getExitAction

      public DialogButton getExitAction()
      For MULTI_ACTION, SERVER_LINKS, DIALOG_LIST: exit/close button.
      optional .soulfire.v1.DialogButton exit_action = 15;
      Specified by:
      getExitAction in interface ServerDialogOrBuilder
      Returns:
      The exitAction.

    • getExitActionOrBuilder

      public DialogButtonOrBuilder getExitActionOrBuilder()
      For MULTI_ACTION, SERVER_LINKS, DIALOG_LIST: exit/close button.
      optional .soulfire.v1.DialogButton exit_action = 15;
      Specified by:
      getExitActionOrBuilder in interface ServerDialogOrBuilder

    • getButtonWidth

      public int getButtonWidth()
      For SERVER_LINKS and DIALOG_LIST: button width.
Default: 150.
      int32 button_width = 16;
      Specified by:
      getButtonWidth in interface ServerDialogOrBuilder
      Returns:
      The buttonWidth.

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static ServerDialog.Builder newBuilder()

    • newBuilder

      public static ServerDialog.Builder newBuilder(ServerDialog prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static ServerDialog getDefaultInstance()

    • parser

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

    • getParserForType

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