Enum Class Phase

java.lang.Object
java.lang.Enum<Phase>
com.botwithus.bot.api.runtime.Phase
All Implemented Interfaces:
Serializable, Comparable<Phase>, Constable
public enum Phase extends Enum<Phase>
Identifies which lifecycle hook of a BotScript was executing when an event of interest (typically a crash) occurred.

The enum is shared between the runtime that produces the value (ScriptRunner) and any consumer that needs to render or filter on it (ScriptsPanel, ScriptCrashedEvent), so the value is part of the stable API surface — not a runtime-internal string.

  • Enum Constant Details

    • ON_START

      public static final Phase ON_START

    • ON_LOOP

      public static final Phase ON_LOOP

    • ON_STOP

      public static final Phase ON_STOP

    • ON_CONFIG_UPDATE

      public static final Phase ON_CONFIG_UPDATE

  • Method Details

    • values

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