Module technology.sola.engine
Package technology.sola.engine.physics.component.particle.movement

Record Class ParticleNoise

java.lang.Object
java.lang.Record
technology.sola.engine.physics.component.particle.movement.ParticleNoise
Record Components:
xStrength - the strength of the noise effect on the x-axis (positive value or zero)
yStrength - the strength of the noise effect on the y-axis (positive value or zero)
frequency - the frequency of direction change (higher values mean more direction changes [0.5f is a decent default])
public record ParticleNoise(float xStrength, float yStrength, float frequency) extends Record
ParticleNoise hold details on how much noise in a Particles movement there is.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ParticleNoise(float xStrength, float yStrength, float frequency)
    Creates an instance of a ParticleNoise record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    float
    frequency()
    Returns the value of the frequency record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    final String
    toString()
    Returns a string representation of this record class.
    float
    xStrength()
    Returns the value of the xStrength record component.
    float
    yStrength()
    Returns the value of the yStrength record component.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • ParticleNoise

      public ParticleNoise(float xStrength, float yStrength, float frequency)
      Creates an instance of a ParticleNoise record class.
      Parameters:
      xStrength - the value for the xStrength record component
      yStrength - the value for the yStrength record component
      frequency - the value for the frequency record component

  • Method Details

    • 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 '=='.
      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.

    • xStrength

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

    • yStrength

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

    • frequency

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