Package dev.itsharshxd.zentrix.api.scenario

Enum Class ScenarioSelectionMode

java.lang.Object
java.lang.Enum<ScenarioSelectionMode>
dev.itsharshxd.zentrix.api.scenario.ScenarioSelectionMode
All Implemented Interfaces:
Serializable, Comparable<ScenarioSelectionMode>, Constable
public enum ScenarioSelectionMode extends Enum<ScenarioSelectionMode>
How a match decides which scenarios it runs.

The mode is resolved per match through the normal override chain, so one arena can vote while another runs a fixed set.

Since:
1.6.0

  • Enum Constant Details

    • ADMIN_SET

      public static final ScenarioSelectionMode ADMIN_SET
      An administrator picked the scenarios, globally or per arena. The set is known before the lobby even opens.

    • PLAYER_VOTING

      public static final ScenarioSelectionMode PLAYER_VOTING
      Players vote in the waiting lobby. The match cannot start until the vote is resolved and the winners are locked in.

    • AUTOMATIC

      public static final ScenarioSelectionMode AUTOMATIC
      Zentrix draws a configurable number of scenarios at random from the allowed pool when the match is created.

    • DISABLED

      public static final ScenarioSelectionMode DISABLED
      The scenario system is switched off for the match. No set is drawn, no vote is opened and no scenario activates, whatever the rest of the configuration says.

      Resolved through the same override chain as every other mode, so switching the global mode off still leaves an arena free to run scenarios through its own enabled override.

      Since:
      1.6.0

  • Method Details

    • values

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