Enum Class InstanceState

java.lang.Object
java.lang.Enum<InstanceState>
com.soulfiremc.grpc.generated.InstanceState
All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<InstanceState>, Constable
@Generated public enum InstanceState extends Enum<InstanceState> implements com.google.protobuf.ProtocolMessageEnum
Represents the lifecycle state of an instance session.
State transitions follow a specific flow:
STOPPED -> STARTING -> RUNNING <-> PAUSED -> STOPPING -> STOPPED
Protobuf enum soulfire.v1.InstanceState

  • Enum Constant Details

    • STARTING

      public static final InstanceState STARTING
      The instance is currently starting up and initializing bots.
This is a transitional state.
      STARTING = 0;

    • RUNNING

      public static final InstanceState RUNNING
      The instance is fully running with active bot connections.
Bots are ticking and processing game logic.
      RUNNING = 1;

    • PAUSED

      public static final InstanceState PAUSED
      The instance is paused. Bots maintain their connections but
stop ticking and processing game logic.
      PAUSED = 2;

    • STOPPING

      public static final InstanceState STOPPING
      The instance is in the process of stopping.
This is a transitional state while bots disconnect.
      STOPPING = 3;

    • STOPPED

      public static final InstanceState STOPPED
      The instance is fully stopped with no active bot connections.
This is the initial state for new instances.
      STOPPED = 4;

    • UNRECOGNIZED

      public static final InstanceState UNRECOGNIZED

  • Field Details

    • STARTING_VALUE

      public static final int STARTING_VALUE
      The instance is currently starting up and initializing bots.
This is a transitional state.
      STARTING = 0;
      See Also:

    • RUNNING_VALUE

      public static final int RUNNING_VALUE
      The instance is fully running with active bot connections.
Bots are ticking and processing game logic.
      RUNNING = 1;
      See Also:

    • PAUSED_VALUE

      public static final int PAUSED_VALUE
      The instance is paused. Bots maintain their connections but
stop ticking and processing game logic.
      PAUSED = 2;
      See Also:

    • STOPPING_VALUE

      public static final int STOPPING_VALUE
      The instance is in the process of stopping.
This is a transitional state while bots disconnect.
      STOPPING = 3;
      See Also:

    • STOPPED_VALUE

      public static final int STOPPED_VALUE
      The instance is fully stopped with no active bot connections.
This is the initial state for new instances.
      STOPPED = 4;
      See Also:

  • Method Details

    • values

      public static InstanceState[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static InstanceState valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getNumber

      public final int getNumber()
      Specified by:
      getNumber in interface com.google.protobuf.Internal.EnumLite
      Specified by:
      getNumber in interface com.google.protobuf.ProtocolMessageEnum

    • valueOf

      @Deprecated public static InstanceState valueOf(int value)
      Deprecated.
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      value - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • forNumber

      public static InstanceState forNumber(int value)
      Parameters:
      value - The numeric wire value of the corresponding enum entry.
      Returns:
      The enum associated with the given numeric wire value.

    • internalGetValueMap

      public static com.google.protobuf.Internal.EnumLiteMap<InstanceState> internalGetValueMap()

    • getValueDescriptor

      public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()
      Specified by:
      getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum

    • getDescriptorForType

      public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum

    • getDescriptor

      public static com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()

    • valueOf

      public static InstanceState valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      desc - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null