Package dev.itsharshxd.zentrix.api.arena

Enum Class ArenaSourcePurpose

java.lang.Object
java.lang.Enum<ArenaSourcePurpose>
dev.itsharshxd.zentrix.api.arena.ArenaSourcePurpose
All Implemented Interfaces:
Serializable, Comparable<ArenaSourcePurpose>, Constable
public enum ArenaSourcePurpose extends Enum<ArenaSourcePurpose>
Why Zentrix is asking a provider for a source arena.

  • Enum Constant Details

    • CUSTOM_GAME

      public static final ArenaSourcePurpose CUSTOM_GAME
      A player is publishing a custom hosted game and needs a source of its own.

    • MATCHMAKING

      public static final ArenaSourcePurpose MATCHMAKING
      Players queued through matchmaking and no game they can join exists yet.

      Asked only after Zentrix has looked at every waiting game, every game still being created, and every source arena this server configured itself. A provider that has nothing ready may return a future it completes later — Zentrix keeps the matchmaking title up while it waits — but should complete it empty rather than leave it hanging once waiting stops being useful.

      Since:
      1.6.0

  • Method Details

    • values

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