Package cn.nukkit.level.vibration

Record Class VibrationEvent

java.lang.Object

java.lang.Record

cn.nukkit.level.vibration.VibrationEvent

Record Components:

initiator - The object which cause the vibration (can be an instance of Block, Entity ...)

source - The vibration source pos

type - Vibration type

@PowerNukkitXOnly
@Since("1.19.21-r3")
public record VibrationEvent(Object initiator, Vector3 source, VibrationType type)
extends Record

Constructor Summary

Constructors

Constructor	Description
VibrationEvent(Object initiator, Vector3 source, VibrationType type)	Creates an instance of a VibrationEvent 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.
Object	initiator()	Returns the value of the initiator record component.
Vector3	source()	Returns the value of the source record component.
final String	toString()	Returns a string representation of this record class.
VibrationType	type()	Returns the value of the type record component.

Methods inherited from class java.lang.Object

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

Constructor Details

VibrationEvent

public VibrationEvent(Object initiator,
 Vector3 source,
 VibrationType type)

Creates an instance of a VibrationEvent record class.

Parameters:

initiator - the value for the initiator record component

source - the value for the source record component

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

initiator

public Object initiator()

Returns the value of the initiator record component.

Returns:

the value of the initiator record component

source

public Vector3 source()

Returns the value of the source record component.

Returns:

the value of the source record component

type

public VibrationType type()

Returns the value of the type record component.

Returns:

the value of the type record component