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

Record Class VectorFieldForceData

java.lang.Object

java.lang.Record

foundry.veil.api.quasar.data.module.force.VectorFieldForceData

All Implemented Interfaces:

ParticleModuleData

public record VectorFieldForceData(VectorField vectorField, float strength)
extends Record
implements ParticleModuleData

A force that applies the force created in a vector field to a particle.

Vector fields are useful for creating complex forces that vary over time.

See Also:

• VectorField

Field Summary

Fields

Modifier and Type	Field	Description
static final com.mojang.serialization.Codec<VectorFieldForceData>	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
VectorFieldForceData(VectorField vectorField, float strength)	Creates an instance of a VectorFieldForceData 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.
float	strength()	Returns the value of the strength record component.
final String	toString()	Returns a string representation of this record class.
VectorField	vectorField()	Returns the value of the vectorField record component.

Methods inherited from class java.lang.Object

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

Field Details

CODEC

public static final com.mojang.serialization.Codec<VectorFieldForceData> CODEC

Constructor Details

VectorFieldForceData

public VectorFieldForceData(VectorField vectorField,
 float strength)

Creates an instance of a VectorFieldForceData record class.

Parameters:

vectorField - the value for the vectorField record component

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

vectorField

public VectorField vectorField()

Returns the value of the vectorField record component.

Returns:

the value of the vectorField record component

strength

public float strength()

Returns the value of the strength record component.

Returns:

the value of the strength record component