Package foundry.veil.api.quasar.data

Record Class ParticleEmitterData

java.lang.Object
java.lang.Record
foundry.veil.api.quasar.data.ParticleEmitterData
Record Components:
maxLifetime -
loop - Whether the emitter will loop. If true, the emitter will reset after maxLifetime ticks
rate - The rate at which particles are emitted. Count particles per rate ticks.
count - The number of particles emitted per rate ticks
maxParticles - The maximum number of particles to have alive
emitterSettings - The settings for how to emit particles
particleDataHolder - The particle to emit
public record ParticleEmitterData(int maxLifetime, boolean loop, int rate, int count, int maxParticles, EmitterSettings emitterSettings, net.minecraft.core.Holder<QuasarParticleData> particleDataHolder) extends Record

  • Field Details

    • DIRECT_CODEC

      public static final com.mojang.serialization.Codec<ParticleEmitterData> DIRECT_CODEC

    • CODEC

      public static final com.mojang.serialization.Codec<net.minecraft.core.Holder<ParticleEmitterData>> CODEC

  • Constructor Details

    • ParticleEmitterData

      public ParticleEmitterData(int maxLifetime, boolean loop, int rate, int count, int maxParticles, EmitterSettings emitterSettings, net.minecraft.core.Holder<QuasarParticleData> particleDataHolder)
      Creates an instance of a ParticleEmitterData record class.
      Parameters:
      maxLifetime - the value for the maxLifetime record component
      loop - the value for the loop record component
      rate - the value for the rate record component
      count - the value for the count record component
      maxParticles - the value for the maxParticles record component
      emitterSettings - the value for the emitterSettings record component
      particleDataHolder - the value for the particleDataHolder record component

  • Method Details

    • particleData

      public QuasarParticleData particleData()

    • getRegistryId

      @Nullable public @Nullable net.minecraft.resources.ResourceLocation getRegistryId()

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

    • maxLifetime

      public int maxLifetime()
      Returns the value of the maxLifetime record component.
      Returns:
      the value of the maxLifetime record component

    • loop

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

    • rate

      public int rate()
      Returns the value of the rate record component.
      Returns:
      the value of the rate record component

    • count

      public int count()
      Returns the value of the count record component.
      Returns:
      the value of the count record component

    • maxParticles

      public int maxParticles()
      Returns the value of the maxParticles record component.
      Returns:
      the value of the maxParticles record component

    • emitterSettings

      public EmitterSettings emitterSettings()
      Returns the value of the emitterSettings record component.
      Returns:
      the value of the emitterSettings record component

    • particleDataHolder

      public net.minecraft.core.Holder<QuasarParticleData> particleDataHolder()
      Returns the value of the particleDataHolder record component.
      Returns:
      the value of the particleDataHolder record component