Package net.minestom.server.network.packet.server.play

Record Class ParticlePacket

java.lang.Object

java.lang.Record

net.minestom.server.network.packet.server.play.ParticlePacket

All Implemented Interfaces:

SendablePacket, ServerPacket, ServerPacket.Play

public record ParticlePacket(@NotNull Particle particle, boolean overrideLimiter, boolean longDistance, double x, double y, double z, float offsetX, float offsetY, float offsetZ, float maxSpeed, int particleCount)
extends Record
implements ServerPacket.Play

Nested Class Summary

Nested classes/interfaces inherited from interface net.minestom.server.network.packet.server.ServerPacket

ServerPacket.ComponentHolding, ServerPacket.Configuration, ServerPacket.Login, ServerPacket.Play, ServerPacket.Status

Field Summary

Fields

Modifier and Type	Field	Description
static final NetworkBuffer.Type<ParticlePacket>	SERIALIZER

Constructor Summary

Constructors

Constructor	Description
ParticlePacket(@NotNull Particle particle, boolean overrideLimiter, boolean longDistance, double x, double y, double z, float offsetX, float offsetY, float offsetZ, float maxSpeed, int particleCount)	Creates an instance of a ParticlePacket record class.
ParticlePacket(@NotNull Particle particle, boolean overrideLimiter, boolean longDistance, @NotNull Point position, @NotNull Point offset, float maxSpeed, int particleCount)
ParticlePacket(@NotNull Particle particle, double x, double y, double z, float offsetX, float offsetY, float offsetZ, float maxSpeed, int particleCount)
ParticlePacket(@NotNull Particle particle, @NotNull Point position, @NotNull Point offset, float maxSpeed, int particleCount)

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.
boolean	longDistance()	Returns the value of the longDistance record component.
float	maxSpeed()	Returns the value of the maxSpeed record component.
float	offsetX()	Returns the value of the offsetX record component.
float	offsetY()	Returns the value of the offsetY record component.
float	offsetZ()	Returns the value of the offsetZ record component.
boolean	overrideLimiter()	Returns the value of the overrideLimiter record component.
@NotNull Particle	particle()	Returns the value of the particle record component.
int	particleCount()	Returns the value of the particleCount record component.
final String	toString()	Returns a string representation of this record class.
double	x()	Returns the value of the x record component.
double	y()	Returns the value of the y record component.
double	z()	Returns the value of the z record component.

Methods inherited from class java.lang.Object

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

Field Details

SERIALIZER

public static final NetworkBuffer.Type<ParticlePacket> SERIALIZER

Constructor Details

ParticlePacket

public ParticlePacket(@NotNull
 @NotNull Particle particle,
 double x,
 double y,
 double z,
 float offsetX,
 float offsetY,
 float offsetZ,
 float maxSpeed,
 int particleCount)

ParticlePacket

public ParticlePacket(@NotNull
 @NotNull Particle particle,
 boolean overrideLimiter,
 boolean longDistance,
 @NotNull
 @NotNull Point position,
 @NotNull
 @NotNull Point offset,
 float maxSpeed,
 int particleCount)

ParticlePacket

public ParticlePacket(@NotNull
 @NotNull Particle particle,
 @NotNull
 @NotNull Point position,
 @NotNull
 @NotNull Point offset,
 float maxSpeed,
 int particleCount)

ParticlePacket

public ParticlePacket(@NotNull
 @NotNull Particle particle,
 boolean overrideLimiter,
 boolean longDistance,
 double x,
 double y,
 double z,
 float offsetX,
 float offsetY,
 float offsetZ,
 float maxSpeed,
 int particleCount)

Creates an instance of a ParticlePacket record class.

Parameters:

particle - the value for the particle record component

overrideLimiter - the value for the overrideLimiter record component

longDistance - the value for the longDistance record component

x - the value for the x record component

y - the value for the y record component

z - the value for the z record component

offsetX - the value for the offsetX record component

offsetY - the value for the offsetY record component

offsetZ - the value for the offsetZ record component

maxSpeed - the value for the maxSpeed record component

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

particle

@NotNull
public @NotNull Particle particle()

Returns the value of the particle record component.

Returns:

the value of the particle record component

overrideLimiter

public boolean overrideLimiter()

Returns the value of the overrideLimiter record component.

Returns:

the value of the overrideLimiter record component

longDistance

public boolean longDistance()

Returns the value of the longDistance record component.

Returns:

the value of the longDistance record component

x

public double x()

Returns the value of the x record component.

Returns:

the value of the x record component

y

public double y()

Returns the value of the y record component.

Returns:

the value of the y record component

z

public double z()

Returns the value of the z record component.

Returns:

the value of the z record component

offsetX

public float offsetX()

Returns the value of the offsetX record component.

Returns:

the value of the offsetX record component

offsetY

public float offsetY()

Returns the value of the offsetY record component.

Returns:

the value of the offsetY record component

offsetZ

public float offsetZ()

Returns the value of the offsetZ record component.

Returns:

the value of the offsetZ record component

maxSpeed

public float maxSpeed()

Returns the value of the maxSpeed record component.

Returns:

the value of the maxSpeed record component

particleCount

public int particleCount()

Returns the value of the particleCount record component.

Returns:

the value of the particleCount record component