Package kr.toxicity.model.api.event

Record Class ModelInteractAtEvent

java.lang.Object

java.lang.Record

kr.toxicity.model.api.event.ModelInteractAtEvent

Record Components:

who - the player interacting

hitbox - the hitbox being interacted with

hand - the hand used for interaction

position - the relative position of the interaction

All Implemented Interfaces:

ModelEvent

public record ModelInteractAtEvent(@NotNull PlatformPlayer who, @NotNull HitBox hitbox, @NotNull ModelInteractionHand hand, @NotNull org.joml.Vector3f position)
extends Record
implements ModelEvent

Triggered when a player interacts with a model's hitbox at a specific position.

This event provides the precise interaction coordinates relative to the hitbox.

Since:

2.0.0

Constructor Summary

Constructors

Constructor	Description
ModelInteractAtEvent(@NotNull PlatformPlayer who, @NotNull HitBox hitbox, @NotNull ModelInteractionHand hand, @NotNull org.joml.Vector3f position)	Creates an instance of a ModelInteractAtEvent record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
@NotNull ModelInteractionHand	hand()	Returns the value of the hand record component.
final int	hashCode()	Returns a hash code value for this object.
@NotNull HitBox	hitbox()	Returns the value of the hitbox record component.
@NotNull org.joml.Vector3f	position()	Returns the value of the position record component.
final String	toString()	Returns a string representation of this record class.
@NotNull PlatformPlayer	who()	Returns the value of the who record component.

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

ModelInteractAtEvent

public ModelInteractAtEvent(@NotNull
 @NotNull PlatformPlayer who,
 @NotNull
 @NotNull HitBox hitbox,
 @NotNull
 @NotNull ModelInteractionHand hand,
 @NotNull
 @NotNull org.joml.Vector3f position)

Creates an instance of a ModelInteractAtEvent record class.

Parameters:

who - the value for the who record component

hitbox - the value for the hitbox record component

hand - the value for the hand record component

position - the value for the position 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.

who

@NotNull
public @NotNull PlatformPlayer who()

Returns the value of the who record component.

Returns:

the value of the who record component

hitbox

@NotNull
public @NotNull HitBox hitbox()

Returns the value of the hitbox record component.

Returns:

the value of the hitbox record component

hand

@NotNull
public @NotNull ModelInteractionHand hand()

Returns the value of the hand record component.

Returns:

the value of the hand record component

position

@NotNull
public @NotNull org.joml.Vector3f position()

Returns the value of the position record component.

Returns:

the value of the position record component