Record Class HitBoxRemoveEvent

java.lang.Object
java.lang.Record
kr.toxicity.model.api.event.hitbox.HitBoxRemoveEvent
Record Components:
hitBox - removed hitbox
All Implemented Interfaces:
HitBoxEvent, ModelEvent

public record HitBoxRemoveEvent(@NotNull HitBox hitBox) extends Record implements HitBoxEvent
Triggered when a hitbox is removed.
Since:
2.1.0
  • Constructor Summary

    Constructors
    Constructor
    Description
    HitBoxRemoveEvent(@NotNull HitBox hitBox)
    Creates an instance of a HitBoxRemoveEvent record class.
  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    Indicates whether some other object is "equal to" this one.
    @NotNull HitBox
    Returns the removed hitbox.
    final int
    Returns a hash code value for this object.
    @NotNull HitBox
    Returns the value of the hitBox record component.
    final String
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface kr.toxicity.model.api.event.ModelEvent

    call
  • Constructor Details

    • HitBoxRemoveEvent

      public HitBoxRemoveEvent(@NotNull @NotNull HitBox hitBox)
      Creates an instance of a HitBoxRemoveEvent record class.
      Parameters:
      hitBox - the value for the hitBox record component
  • Method Details

    • getHitBox

      @NotNull public @NotNull HitBox getHitBox()
      Returns the removed hitbox.
      Specified by:
      getHitBox in interface HitBoxEvent
      Returns:
      removed hitbox
      Since:
      2.1.0
    • 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.
    • hitBox

      @NotNull public @NotNull HitBox hitBox()
      Returns the value of the hitBox record component.
      Returns:
      the value of the hitBox record component