java.lang.Object

java.lang.Record

net.minecraft.world.item.enchantment.effects.SpawnParticlesEffect

All Implemented Interfaces:: EnchantmentEntityEffect, EnchantmentLocationBasedEffect

public record SpawnParticlesEffect(ParticleOptions particle, SpawnParticlesEffect.PositionSource horizontalPosition, SpawnParticlesEffect.PositionSource verticalPosition, SpawnParticlesEffect.VelocitySource horizontalVelocity, SpawnParticlesEffect.VelocitySource verticalVelocity, FloatProvider speed) extends Record implements EnchantmentEntityEffect

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static final record

SpawnParticlesEffect.PositionSource

static enum

SpawnParticlesEffect.PositionSourceType

static final record

SpawnParticlesEffect.VelocitySource
Field Summary

Fields

Modifier and Type

Field

Description

static final MapCodec<SpawnParticlesEffect>

CODEC

private final SpawnParticlesEffect.PositionSource

horizontalPosition

The field for the horizontalPosition record component.

private final SpawnParticlesEffect.VelocitySource

horizontalVelocity

The field for the horizontalVelocity record component.

private final ParticleOptions

particle

The field for the particle record component.

private final FloatProvider

speed

The field for the speed record component.

private final SpawnParticlesEffect.PositionSource

verticalPosition

The field for the verticalPosition record component.

private final SpawnParticlesEffect.VelocitySource

verticalVelocity

The field for the verticalVelocity record component.
Constructor Summary

Constructors

Constructor

Description

SpawnParticlesEffect(ParticleOptions particle, SpawnParticlesEffect.PositionSource horizontalPosition, SpawnParticlesEffect.PositionSource verticalPosition, SpawnParticlesEffect.VelocitySource horizontalVelocity, SpawnParticlesEffect.VelocitySource verticalVelocity, FloatProvider speed)

Creates an instance of a SpawnParticlesEffect record class.
Method Summary

Modifier and Type

Method

Description

void

apply(ServerLevel serverLevel, int enchantmentLevel, EnchantedItemInUse item, Entity entity, Vec3 position)

MapCodec<SpawnParticlesEffect>

codec()

final boolean

equals(Object o)

Indicates whether some other object is "equal to" this one.

static SpawnParticlesEffect.VelocitySource

fixedVelocity(FloatProvider provider)

final int

hashCode()

Returns a hash code value for this object.

SpawnParticlesEffect.PositionSource

horizontalPosition()

Returns the value of the horizontalPosition record component.

SpawnParticlesEffect.VelocitySource

horizontalVelocity()

Returns the value of the horizontalVelocity record component.

static SpawnParticlesEffect.PositionSource

inBoundingBox()

static SpawnParticlesEffect.VelocitySource

movementScaled(float scale)

static SpawnParticlesEffect.PositionSource

offsetFromEntityPosition(float offset)

ParticleOptions

particle()

Returns the value of the particle record component.

FloatProvider

speed()

Returns the value of the speed record component.

final String

toString()

Returns a string representation of this record class.

SpawnParticlesEffect.PositionSource

verticalPosition()

Returns the value of the verticalPosition record component.

SpawnParticlesEffect.VelocitySource

verticalVelocity()

Returns the value of the verticalVelocity record component.

Methods inherited from class Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface EnchantmentEntityEffect
onChangedBlock

Methods inherited from interface EnchantmentLocationBasedEffect
onDeactivated

Field Details
- particle
  
  private final ParticleOptions particle
  
  The field for the particle record component.
- horizontalPosition
  
  private final SpawnParticlesEffect.PositionSource horizontalPosition
  
  The field for the horizontalPosition record component.
- verticalPosition
  
  private final SpawnParticlesEffect.PositionSource verticalPosition
  
  The field for the verticalPosition record component.
- horizontalVelocity
  
  private final SpawnParticlesEffect.VelocitySource horizontalVelocity
  
  The field for the horizontalVelocity record component.
- verticalVelocity
  
  private final SpawnParticlesEffect.VelocitySource verticalVelocity
  
  The field for the verticalVelocity record component.
- speed
  
  private final FloatProvider speed
  
  The field for the speed record component.
- CODEC
  
  public static final MapCodec<SpawnParticlesEffect> CODEC
Constructor Details
- SpawnParticlesEffect
  
  public SpawnParticlesEffect(ParticleOptions particle, SpawnParticlesEffect.PositionSource horizontalPosition, SpawnParticlesEffect.PositionSource verticalPosition, SpawnParticlesEffect.VelocitySource horizontalVelocity, SpawnParticlesEffect.VelocitySource verticalVelocity, FloatProvider speed)
  
  Creates an instance of a SpawnParticlesEffect record class.
  
  Parameters:
  
  particle - the value for the particle record component
  
  horizontalPosition - the value for the horizontalPosition record component
  
  verticalPosition - the value for the verticalPosition record component
  
  horizontalVelocity - the value for the horizontalVelocity record component
  
  verticalVelocity - the value for the verticalVelocity record component
  
  speed - the value for the speed record component
Method Details
- offsetFromEntityPosition
  
  public static SpawnParticlesEffect.PositionSource offsetFromEntityPosition(float offset)
- inBoundingBox
  
  public static SpawnParticlesEffect.PositionSource inBoundingBox()
- movementScaled
  
  public static SpawnParticlesEffect.VelocitySource movementScaled(float scale)
- fixedVelocity
  
  public static SpawnParticlesEffect.VelocitySource fixedVelocity(FloatProvider provider)
- apply
  
  public void apply(ServerLevel serverLevel, int enchantmentLevel, EnchantedItemInUse item, Entity entity, Vec3 position)
  
  Specified by:
  
  apply in interface EnchantmentEntityEffect
- codec
  
  public MapCodec<SpawnParticlesEffect> codec()
  
  Specified by:
  
  codec in interface EnchantmentEntityEffect
  
  Specified by:
  
  codec in interface EnchantmentLocationBasedEffect
- 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 Objects::equals(Object,Object).
  
  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.
- particle
  
  public ParticleOptions particle()
  
  Returns the value of the particle record component.
  
  Returns:
  
  the value of the particle record component
- horizontalPosition
  
  public SpawnParticlesEffect.PositionSource horizontalPosition()
  
  Returns the value of the horizontalPosition record component.
  
  Returns:
  
  the value of the horizontalPosition record component
- verticalPosition
  
  public SpawnParticlesEffect.PositionSource verticalPosition()
  
  Returns the value of the verticalPosition record component.
  
  Returns:
  
  the value of the verticalPosition record component
- horizontalVelocity
  
  public SpawnParticlesEffect.VelocitySource horizontalVelocity()
  
  Returns the value of the horizontalVelocity record component.
  
  Returns:
  
  the value of the horizontalVelocity record component
- verticalVelocity
  
  public SpawnParticlesEffect.VelocitySource verticalVelocity()
  
  Returns the value of the verticalVelocity record component.
  
  Returns:
  
  the value of the verticalVelocity record component
- speed
  
  public FloatProvider speed()
  
  Returns the value of the speed record component.
  
  Returns:
  
  the value of the speed record component

Record Class SpawnParticlesEffect

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class Object

Methods inherited from interface EnchantmentEntityEffect

Methods inherited from interface EnchantmentLocationBasedEffect

Field Details

particle

horizontalPosition

verticalPosition

horizontalVelocity

verticalVelocity

speed

CODEC

Constructor Details

SpawnParticlesEffect

Method Details

offsetFromEntityPosition

inBoundingBox

movementScaled

fixedVelocity

apply

codec

toString

hashCode

equals

particle

horizontalPosition

verticalPosition

horizontalVelocity

verticalVelocity

speed