Package dev.getelements.elements.sdk.model.match

Enum Class MultiMatchStatus

java.lang.Object
java.lang.Enum<MultiMatchStatus>
dev.getelements.elements.sdk.model.match.MultiMatchStatus
All Implemented Interfaces:
Serializable, Comparable<MultiMatchStatus>, Constable
public enum MultiMatchStatus extends Enum<MultiMatchStatus>
Indicates the current status of the MultiMatch.

  • Enum Constant Details

    • OPEN

      public static final MultiMatchStatus OPEN
      The match is open and accepting new players. Wen the match hits the maximum number of players defined in the configuration it will automatically transition to FULL.

    • FULL

      public static final MultiMatchStatus FULL
      The match is full and no longer accepting new players. But may be reopened if a player leaves. If players leaves while the match is FULL the match will automatically transition back to OPEN.

    • CLOSED

      public static final MultiMatchStatus CLOSED
      The match is closed to new players and will not accept new players, even if somebody leaves. The match may be reopened, though explicit actions, but it will not automatically transition back to OPEN if a player leaves thereby effectively locking new players out regardless of player departures.

    • ENDED

      public static final MultiMatchStatus ENDED
      The match has ended and will be deleted shortly, based on the configuration of the match. No new players may join, nor the match reopened. Matches in this state will linger for a brief period of time for the sake of reporting or end of game victory celebration. Code must always consider matches in this state as effectively deleted.

  • Method Details

    • values

      public static MultiMatchStatus[] 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 MultiMatchStatus 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