Record Class AnimationSignalEvent

java.lang.Object
java.lang.Record
kr.toxicity.model.api.event.AnimationSignalEvent
Record Components:
player - the player associated with the animation
signal - the signal
All Implemented Interfaces:
ModelEvent
public record AnimationSignalEvent(@NotNull PlatformPlayer player, @NotNull String signal) extends Record implements ModelEvent
Triggered when an animation script emits a signal.

This event allows plugins/mods to react to custom signals defined within BlockBench animations.

Since:
2.0.0

  • Constructor Details

    • AnimationSignalEvent

      public AnimationSignalEvent(@NotNull @NotNull PlatformPlayer player, @NotNull @NotNull String signal)
      Creates an instance of a AnimationSignalEvent record class.
      Parameters:
      player - the value for the player record component
      signal - the value for the signal 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. All components in this record class are compared with Objects::equals(Object,Object).
      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.

    • player

      @NotNull public @NotNull PlatformPlayer player()
      Returns the value of the player record component.
      Returns:
      the value of the player record component

    • signal

      @NotNull public @NotNull String signal()
      Returns the value of the signal record component.
      Returns:
      the value of the signal record component