Record Class ScriptCrashedEvent

java.lang.Object
java.lang.Record
com.botwithus.bot.api.event.ScriptCrashedEvent
Record Components:
scriptName - the script's manifest name (or class simple name)
connectionName - the originating connection, or null for runners not yet bound to a connection
crash - the structured crash description
timestamp - event creation time in milliseconds since epoch
All Implemented Interfaces:
GameEvent
public record ScriptCrashedEvent(String scriptName, String connectionName, LastCrash crash, long timestamp) extends Record implements GameEvent
Fired by the runtime when a script's lifecycle hook throws. The producer (the ScriptRunner) builds the LastCrash payload describing which phase failed and the underlying throwable, then publishes this event once via the per-connection EventBus.

  • Constructor Details

    • ScriptCrashedEvent

      public ScriptCrashedEvent(String scriptName, String connectionName, LastCrash crash)

    • ScriptCrashedEvent

      public ScriptCrashedEvent(String scriptName, String connectionName, LastCrash crash, long timestamp)
      Creates an instance of a ScriptCrashedEvent record class.
      Parameters:
      scriptName - the value for the scriptName record component
      connectionName - the value for the connectionName record component
      crash - the value for the crash record component
      timestamp - the value for the timestamp record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • scriptName

      public String scriptName()
      Returns the value of the scriptName record component.
      Returns:
      the value of the scriptName record component

    • connectionName

      public String connectionName()
      Returns the value of the connectionName record component.
      Returns:
      the value of the connectionName record component

    • crash

      public LastCrash crash()
      Returns the value of the crash record component.
      Returns:
      the value of the crash record component

    • timestamp

      public long timestamp()
      Returns the value of the timestamp record component.
      Specified by:
      timestamp in interface GameEvent
      Returns:
      the value of the timestamp record component