Package valorless.rarespawns.api.enums

Enum Class SpawnCause

java.lang.Object
java.lang.Enum<SpawnCause>
valorless.rarespawns.api.enums.SpawnCause
All Implemented Interfaces:
Serializable, Comparable<SpawnCause>, Constable
public enum SpawnCause extends Enum<SpawnCause>
Describes where a rare entity spawn originated.

INTERNAL = spawned by RareSpawns' own systems (built‑in logic, schedules, config rules, or internal commands). EXTERNAL = spawned through the RareSpawns public API (i.e., a call into the API triggered the spawn), typically by another plugin. Use NULL when the origin cannot be determined.

  • Enum Constant Details

    • NULL

      public static final SpawnCause NULL
      Unspecified or unknown cause. Use when the origin cannot be determined.

    • INTERNAL

      public static final SpawnCause INTERNAL
      Spawned by this plugin (RareSpawns) via its internal mechanisms such as natural/automated spawns, scheduled tasks, configuration rules, or internal command handlers.

    • EXTERNAL

      public static final SpawnCause EXTERNAL
      Spawned through the RareSpawns public API.

      This indicates an API call initiated the spawn, usually from another plugin integrating with RareSpawns. Prefer this over INTERNAL whenever the spawn path goes through API entry points.

  • Method Details

    • values

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