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

Record Class WindForceData

java.lang.Object

java.lang.Record

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

All Implemented Interfaces:

ParticleModuleData

public record WindForceData(org.joml.Vector3dc windDirection, float windSpeed, float strength)
extends Record
implements ParticleModuleData

A force that applies a wind force to a particle.

Wind forces are useful for simulating wind. The strength of the force is determined by the strength parameter. The falloff parameter is unused. The direction and speed of the wind is determined by the windDirection and windSpeed parameters. The windDirection parameter is a vector that determines the direction of the wind. The windSpeed parameter determines the speed of the wind. The windSpeed parameter is measured in blocks/tick^2.

Field Summary

Fields

Modifier and Type	Field	Description
static final com.mojang.serialization.MapCodec<WindForceData>	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
WindForceData(org.joml.Vector3dc windDirection, float windSpeed, float strength)	Creates an instance of a WindForceData 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.
org.joml.Vector3dc	windDirection()	Returns the value of the windDirection record component.
float	windSpeed()	Returns the value of the windSpeed 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.MapCodec<WindForceData> CODEC

Constructor Details

WindForceData

public WindForceData(org.joml.Vector3dc windDirection,
 float windSpeed,
 float strength)

Creates an instance of a WindForceData record class.

Parameters:

windDirection - the value for the windDirection record component

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

windDirection

public org.joml.Vector3dc windDirection()

Returns the value of the windDirection record component.

Returns:

the value of the windDirection record component

windSpeed

public float windSpeed()

Returns the value of the windSpeed record component.

Returns:

the value of the windSpeed record component

strength

public float strength()

Returns the value of the strength record component.

Returns:

the value of the strength record component