Record Class EntityEffect.SpawnParticles

java.lang.Object

java.lang.Record

net.minestom.server.item.enchant.EntityEffect.SpawnParticles

All Implemented Interfaces:

Enchantment.Effect, EntityEffect, LocationEffect

Enclosing interface:

EntityEffect

public static record EntityEffect.SpawnParticles(Codec.RawValue particle, Codec.RawValue horizontalPosition, Codec.RawValue verticalPosition, Codec.RawValue horizontalVelocity, Codec.RawValue verticalVelocity, Codec.RawValue speed)
extends Record
implements EntityEffect, LocationEffect

Nested Class Summary

Nested classes/interfaces inherited from interface EntityEffect

EntityEffect.AllOf, EntityEffect.ApplyPotionEffect, EntityEffect.ChangeItemDamage, EntityEffect.DamageEntity, EntityEffect.Explode, EntityEffect.Ignite, EntityEffect.PlaySound, EntityEffect.ReplaceBlock, EntityEffect.ReplaceDisc, EntityEffect.RunFunction, EntityEffect.SetBlockProperties, EntityEffect.SpawnParticles, EntityEffect.SummonEntity

Nested classes/interfaces inherited from interface LocationEffect

LocationEffect.AllOf

Field Summary

Fields

Modifier and Type	Field	Description
static final StructCodec<EntityEffect.SpawnParticles>	CODEC

Constructor Summary

Constructors

Constructor	Description
SpawnParticles(Codec.RawValue particle, Codec.RawValue horizontalPosition, Codec.RawValue verticalPosition, Codec.RawValue horizontalVelocity, Codec.RawValue verticalVelocity, Codec.RawValue speed)	Creates an instance of a SpawnParticles record class.

Method Summary

Modifier and Type	Method	Description
StructCodec<EntityEffect.SpawnParticles>	codec()
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.
Codec.RawValue	horizontalPosition()	Returns the value of the horizontalPosition record component.
Codec.RawValue	horizontalVelocity()	Returns the value of the horizontalVelocity record component.
Codec.RawValue	particle()	Returns the value of the particle record component.
Codec.RawValue	speed()	Returns the value of the speed record component.
final String	toString()	Returns a string representation of this record class.
Codec.RawValue	verticalPosition()	Returns the value of the verticalPosition record component.
Codec.RawValue	verticalVelocity()	Returns the value of the verticalVelocity record component.

Methods inherited from class Object

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

Field Details

CODEC

public static final StructCodec<EntityEffect.SpawnParticles> CODEC

Constructor Details

SpawnParticles

public SpawnParticles(Codec.RawValue particle,
 Codec.RawValue horizontalPosition,
 Codec.RawValue verticalPosition,
 Codec.RawValue horizontalVelocity,
 Codec.RawValue verticalVelocity,
 Codec.RawValue speed)

Creates an instance of a SpawnParticles record class.

Parameters:

particle - the value for the particle record component

horizontalPosition - the value for the horizontalPosition record component

verticalPosition - the value for the verticalPosition record component

horizontalVelocity - the value for the horizontalVelocity record component

verticalVelocity - the value for the verticalVelocity record component

speed - the value for the speed record component

Method Details

codec

public StructCodec<EntityEffect.SpawnParticles> codec()

Specified by:

codec in interface EntityEffect

Specified by:

codec in interface LocationEffect

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.

particle

public Codec.RawValue particle()

Returns the value of the particle record component.

Returns:

the value of the particle record component

horizontalPosition

public Codec.RawValue horizontalPosition()

Returns the value of the horizontalPosition record component.

Returns:

the value of the horizontalPosition record component

verticalPosition

public Codec.RawValue verticalPosition()

Returns the value of the verticalPosition record component.

Returns:

the value of the verticalPosition record component

horizontalVelocity

public Codec.RawValue horizontalVelocity()

Returns the value of the horizontalVelocity record component.

Returns:

the value of the horizontalVelocity record component

verticalVelocity

public Codec.RawValue verticalVelocity()

Returns the value of the verticalVelocity record component.

Returns:

the value of the verticalVelocity record component

speed

public Codec.RawValue speed()

Returns the value of the speed record component.

Returns:

the value of the speed record component