Package kr.toxicity.model.api.event.hitbox

Record Class HitBoxMountEvent

java.lang.Object
java.lang.Record
kr.toxicity.model.api.event.hitbox.HitBoxMountEvent
Record Components:
hitBox - the hit box
entity - the entity
All Implemented Interfaces:
HitBoxEvent, ModelEvent
public record HitBoxMountEvent(@NotNull HitBox hitBox, @NotNull PlatformEntity entity) extends Record implements HitBoxEvent
An event called when an entity mounts to a hit box.
Since:
2.1.0

  • Constructor Details

    • HitBoxMountEvent

      public HitBoxMountEvent(@NotNull @NotNull HitBox hitBox, @NotNull @NotNull PlatformEntity entity)
      Creates an instance of a HitBoxMountEvent record class.
      Parameters:
      hitBox - the value for the hitBox record component
      entity - the value for the entity record component

  • Method Details

    • getHitBox

      @NotNull public @NotNull HitBox getHitBox()
      Description copied from interface: HitBoxEvent
      Returns the target hitbox of this event.
      Specified by:
      getHitBox in interface HitBoxEvent
      Returns:
      target hitbox

    • 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

    • entity

      @NotNull public @NotNull PlatformEntity entity()
      Returns the value of the entity record component.
      Returns:
      the value of the entity record component