Package org.geysermc.mcprotocollib.protocol.data.game.item.component

Record Class PiercingWeapon

java.lang.Object

java.lang.Record

org.geysermc.mcprotocollib.protocol.data.game.item.component.PiercingWeapon

public record PiercingWeapon(boolean dealsKnockback, boolean dismounts, @Nullable Sound sound, @Nullable Sound hitSound)
extends Record

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PiercingWeapon.PiercingWeaponBuilder

Constructor Summary

Constructors

Constructor	Description
PiercingWeapon(boolean dealsKnockback, boolean dismounts, @Nullable Sound sound, @Nullable Sound hitSound)	Creates an instance of a PiercingWeapon record class.

Method Summary

Modifier and Type	Method	Description
static @NonNull PiercingWeapon.PiercingWeaponBuilder	builder()
boolean	dealsKnockback()	Returns the value of the dealsKnockback record component.
boolean	dismounts()	Returns the value of the dismounts record component.
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 Sound	hitSound()	Returns the value of the hitSound record component.
@Nullable Sound	sound()	Returns the value of the sound record component.
@NonNull PiercingWeapon.PiercingWeaponBuilder	toBuilder()
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

PiercingWeapon

public PiercingWeapon(boolean dealsKnockback,
 boolean dismounts,
 @Nullable
 @Nullable Sound sound,
 @Nullable
 @Nullable Sound hitSound)

Creates an instance of a PiercingWeapon record class.

Parameters:

dealsKnockback - the value for the dealsKnockback record component

dismounts - the value for the dismounts record component

sound - the value for the sound record component

hitSound - the value for the hitSound record component

Method Details

builder

public static @NonNull PiercingWeapon.PiercingWeaponBuilder builder()

toBuilder

public @NonNull PiercingWeapon.PiercingWeaponBuilder toBuilder()

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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

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.

dealsKnockback

public boolean dealsKnockback()

Returns the value of the dealsKnockback record component.

Returns:

the value of the dealsKnockback record component

dismounts

public boolean dismounts()

Returns the value of the dismounts record component.

Returns:

the value of the dismounts record component

sound

@Nullable
public @Nullable Sound sound()

Returns the value of the sound record component.

Returns:

the value of the sound record component

hitSound

@Nullable
public @Nullable Sound hitSound()

Returns the value of the hitSound record component.

Returns:

the value of the hitSound record component