Package org.geysermc.geyser.api.item.custom

Record Class CustomRenderOffsets

java.lang.Object

java.lang.Record

org.geysermc.geyser.api.item.custom.CustomRenderOffsets

public record CustomRenderOffsets(@Nullable CustomRenderOffsets.Hand mainHand, @Nullable CustomRenderOffsets.Hand offhand)
extends Record

This class is used to store the render offsets of custom items.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	CustomRenderOffsets.Hand	The hand that is used for the offset.
static final record	CustomRenderOffsets.Offset	The offset of the item.
static final record	CustomRenderOffsets.OffsetXYZ	X, Y and Z positions for the offset.

Constructor Summary

Constructors

Constructor	Description
CustomRenderOffsets(@Nullable CustomRenderOffsets.Hand mainHand, @Nullable CustomRenderOffsets.Hand offhand)	Creates an instance of a CustomRenderOffsets record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
@Nullable CustomRenderOffsets.Hand	mainHand()	Returns the value of the mainHand record component.
@Nullable CustomRenderOffsets.Hand	offhand()	Returns the value of the offhand record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Constructor Details

CustomRenderOffsets

public CustomRenderOffsets(@Nullable CustomRenderOffsets.Hand mainHand,
 @Nullable CustomRenderOffsets.Hand offhand)

Creates an instance of a CustomRenderOffsets record class.

Parameters:

mainHand - the value for the mainHand record component

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

mainHand

public @Nullable CustomRenderOffsets.Hand mainHand()

Returns the value of the mainHand record component.

Returns:

the value of the mainHand record component

offhand

public @Nullable CustomRenderOffsets.Hand offhand()

Returns the value of the offhand record component.

Returns:

the value of the offhand record component