Interface ServerDialogOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ServerDialog, ServerDialog.Builder
@Generated public interface ServerDialogOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getId

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

    • getIdBytes

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

    • getTypeValue

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

    • getType

      DialogType getType()
      The type of dialog, determining overall structure.
      .soulfire.v1.DialogType type = 2;
      Returns:
      The type.

    • getTitle

      String getTitle()
      Dialog title (may be a JSON text component).
      string title = 3;
      Returns:
      The title.

    • getTitleBytes

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

    • hasExternalTitle

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

    • getExternalTitle

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

    • getExternalTitleBytes

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

    • getBodyList

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

    • getBody

      DialogBodyElement getBody(int index)
      Body elements (text and items) displayed in the dialog.
      repeated .soulfire.v1.DialogBodyElement body = 5;

    • getBodyCount

      int getBodyCount()
      Body elements (text and items) displayed in the dialog.
      repeated .soulfire.v1.DialogBodyElement body = 5;

    • getBodyOrBuilderList

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

    • getBodyOrBuilder

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

    • getInputsList

      List<DialogInput> getInputsList()
      Input controls for gathering user data.
      repeated .soulfire.v1.DialogInput inputs = 6;

    • getInputs

      DialogInput getInputs(int index)
      Input controls for gathering user data.
      repeated .soulfire.v1.DialogInput inputs = 6;

    • getInputsCount

      int getInputsCount()
      Input controls for gathering user data.
      repeated .soulfire.v1.DialogInput inputs = 6;

    • getInputsOrBuilderList

      List<? extends DialogInputOrBuilder> getInputsOrBuilderList()
      Input controls for gathering user data.
      repeated .soulfire.v1.DialogInput inputs = 6;

    • getInputsOrBuilder

      DialogInputOrBuilder getInputsOrBuilder(int index)
      Input controls for gathering user data.
      repeated .soulfire.v1.DialogInput inputs = 6;

    • getCanCloseWithEscape

      boolean getCanCloseWithEscape()
      Whether ESC key can close the dialog.
Default: true.
      bool can_close_with_escape = 7;
      Returns:
      The canCloseWithEscape.

    • getPause

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

    • getAfterActionValue

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

    • getAfterAction

      DialogAfterAction getAfterAction()
      Behavior after an action button is clicked.
      .soulfire.v1.DialogAfterAction after_action = 9;
      Returns:
      The afterAction.

    • hasAction

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

    • getAction

      DialogButton getAction()
      For NOTICE type: the single action button.
      optional .soulfire.v1.DialogButton action = 10;
      Returns:
      The action.

    • getActionOrBuilder

      DialogButtonOrBuilder getActionOrBuilder()
      For NOTICE type: the single action button.
      optional .soulfire.v1.DialogButton action = 10;

    • hasYes

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

    • getYes

      DialogButton getYes()
      For CONFIRMATION type: the "yes" button.
      optional .soulfire.v1.DialogButton yes = 11;
      Returns:
      The yes.

    • getYesOrBuilder

      DialogButtonOrBuilder getYesOrBuilder()
      For CONFIRMATION type: the "yes" button.
      optional .soulfire.v1.DialogButton yes = 11;

    • hasNo

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

    • getNo

      DialogButton getNo()
      For CONFIRMATION type: the "no" button.
      optional .soulfire.v1.DialogButton no = 12;
      Returns:
      The no.

    • getNoOrBuilder

      DialogButtonOrBuilder getNoOrBuilder()
      For CONFIRMATION type: the "no" button.
      optional .soulfire.v1.DialogButton no = 12;

    • getActionsList

      List<DialogButton> getActionsList()
      For MULTI_ACTION type: list of action buttons.
      repeated .soulfire.v1.DialogButton actions = 13;

    • getActions

      DialogButton getActions(int index)
      For MULTI_ACTION type: list of action buttons.
      repeated .soulfire.v1.DialogButton actions = 13;

    • getActionsCount

      int getActionsCount()
      For MULTI_ACTION type: list of action buttons.
      repeated .soulfire.v1.DialogButton actions = 13;

    • getActionsOrBuilderList

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

    • getActionsOrBuilder

      DialogButtonOrBuilder getActionsOrBuilder(int index)
      For MULTI_ACTION type: list of action buttons.
      repeated .soulfire.v1.DialogButton actions = 13;

    • getColumns

      int getColumns()
      For MULTI_ACTION and DIALOG_LIST: number of button columns.
Default: 2.
      int32 columns = 14;
      Returns:
      The columns.

    • hasExitAction

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

    • getExitAction

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

    • getExitActionOrBuilder

      DialogButtonOrBuilder getExitActionOrBuilder()
      For MULTI_ACTION, SERVER_LINKS, DIALOG_LIST: exit/close button.
      optional .soulfire.v1.DialogButton exit_action = 15;

    • getButtonWidth

      int getButtonWidth()
      For SERVER_LINKS and DIALOG_LIST: button width.
Default: 150.
      int32 button_width = 16;
      Returns:
      The buttonWidth.