Package foundry.veil.api.quasar.data.module.render

Record Class TrailParticleModuleData

java.lang.Object

java.lang.Record

foundry.veil.api.quasar.data.module.render.TrailParticleModuleData

All Implemented Interfaces:

ParticleModuleData

public record TrailParticleModuleData(List<TrailSettings> settings)
extends Record
implements ParticleModuleData

A module that adds trails to a particle.

See Also:

• TrailSettings
• RenderParticleModule
• WARNING: Trails add a lot of time to the rendering process, so use them sparingly.

Field Summary

Fields

Modifier and Type	Field	Description
static final com.mojang.serialization.MapCodec<TrailParticleModuleData>	CODEC

Fields inherited from interface foundry.veil.api.quasar.data.module.ParticleModuleData

INIT_CODEC, INIT_DIRECT_CODEC, RENDER_CODEC, RENDER_DIRECT_CODEC, UPDATE_CODEC, UPDATE_DIRECT_CODEC

Constructor Summary

Constructors

Constructor	Description
TrailParticleModuleData(List<TrailSettings> settings)	Creates an instance of a TrailParticleModuleData record class.

Method Summary

Modifier and Type	Method	Description
void	addModules(ParticleModuleSet.Builder builder)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
ModuleType<?>	getType()
final int	hashCode()	Returns a hash code value for this object.
List<TrailSettings>	settings()	Returns the value of the settings 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

Field Details

CODEC

public static final com.mojang.serialization.MapCodec<TrailParticleModuleData> CODEC

Constructor Details

TrailParticleModuleData

public TrailParticleModuleData(List<TrailSettings> settings)

Creates an instance of a TrailParticleModuleData record class.

Parameters:

settings - the value for the settings record component

Method Details

addModules

public void addModules(ParticleModuleSet.Builder builder)

Specified by:

addModules in interface ParticleModuleData

getType

public ModuleType<?> getType()

Specified by:

getType in interface ParticleModuleData

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.

settings

public List<TrailSettings> settings()

Returns the value of the settings record component.

Returns:

the value of the settings record component