Enum StatScope

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

public enum StatScope extends Enum<StatScope>
Defines the scope of a statistic definition.

Stats can be either globally tracked across all games or specific to individual game modules. This allows for both universal statistics (like total wins) and game-specific statistics (like blocks destroyed in TNT Run).

  • Enum Constant Details

    • GLOBAL

      public static final StatScope GLOBAL
      The statistic is globally tracked across all game modules.

      Global stats include metrics like total games played, total wins, total kills, etc. These are accumulated regardless of which game module is being played.

    • MODULE

      public static final StatScope MODULE
      The statistic is specific to a particular game module.

      Module-specific stats track game-unique metrics like "eggs thrown" in Egg Wars or "laps completed" in Race games. These are only tracked for that specific game.

  • Method Details

    • values

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