Enum SetupRequirement

java.lang.Object
java.lang.Enum<SetupRequirement>
net.blueva.arcade.api.setup.SetupRequirement
All Implemented Interfaces:
Serializable, Comparable<SetupRequirement>

public enum SetupRequirement extends Enum<SetupRequirement>
Enumerates the default setup requirements that the core enforces during arena configuration and enable/boot validation.

By default every requirement listed here is active. A module can opt out of one or more requirements by returning them from GameModule.getDisabledRequirements(). When a requirement is disabled the core will:

  • Skip the corresponding setup prompt during arena configuration.
  • Skip validation for that requirement when enabling/booting the minigame.

Since:
3.2
  • Enum Constant Details

    • BOUNDS

      public static final SetupRequirement BOUNDS
      Arena boundary positions (pos1 / pos2).
    • SPAWNS

      public static final SetupRequirement SPAWNS
      Player spawn points.
    • TIME

      public static final SetupRequirement TIME
      Time-related values (time limit, countdown duration, etc.).
  • Method Details

    • values

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

      public static SetupRequirement valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name
      NullPointerException - if the argument is null