Package kr.toxicity.model.api.event

Record Class PlayerPerAnimationStartEvent

java.lang.Object
java.lang.Record
kr.toxicity.model.api.event.PlayerPerAnimationStartEvent
Record Components:
tracker - the tracker playing the animation
player - the player viewing the animation
All Implemented Interfaces:
ModelEvent
public record PlayerPerAnimationStartEvent(@NotNull Tracker tracker, @NotNull PlatformPlayer player) extends Record implements ModelEvent
Triggered when a per-player animation sequence starts.

This event signifies that a specific animation is beginning to play for only one player.

Since:
2.0.0

  • Constructor Details

    • PlayerPerAnimationStartEvent

      public PlayerPerAnimationStartEvent(@NotNull @NotNull Tracker tracker, @NotNull @NotNull PlatformPlayer player)
      Creates an instance of a PlayerPerAnimationStartEvent record class.
      Parameters:
      tracker - the value for the tracker record component
      player - the value for the player 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.

    • tracker

      @NotNull public @NotNull Tracker tracker()
      Returns the value of the tracker record component.
      Returns:
      the value of the tracker record component

    • player

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