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

Record Class VortexForceData

java.lang.Object
java.lang.Record
foundry.veil.api.quasar.data.module.force.VortexForceData
All Implemented Interfaces:
ParticleModuleData
public record VortexForceData(org.joml.Vector3dc vortexAxis, org.joml.Vector3dc vortexCenter, boolean localPosition, double range, float strength) extends Record implements ParticleModuleData
A force that applies a vortex force to a particle.

Vortex forces are forces that are applied in a circular motion around a center point. They are useful for simulating whirlpools or tornadoes. The strength of the force is determined by the strength parameter. The falloff parameter determines how quickly the force falls off with distance. (unused)

  • Field Details

    • CODEC

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

  • Constructor Details

    • VortexForceData

      public VortexForceData(org.joml.Vector3dc vortexAxis, org.joml.Vector3dc vortexCenter, boolean localPosition, double range, float strength)
      Creates an instance of a VortexForceData record class.
      Parameters:
      vortexAxis - the value for the vortexAxis record component
      vortexCenter - the value for the vortexCenter record component
      localPosition - the value for the localPosition record component
      range - the value for the range 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.

    • vortexAxis

      public org.joml.Vector3dc vortexAxis()
      Returns the value of the vortexAxis record component.
      Returns:
      the value of the vortexAxis record component

    • vortexCenter

      public org.joml.Vector3dc vortexCenter()
      Returns the value of the vortexCenter record component.
      Returns:
      the value of the vortexCenter record component

    • localPosition

      public boolean localPosition()
      Returns the value of the localPosition record component.
      Returns:
      the value of the localPosition record component

    • range

      public double range()
      Returns the value of the range record component.
      Returns:
      the value of the range record component

    • strength

      public float strength()
      Returns the value of the strength record component.
      Returns:
      the value of the strength record component