api/org.kryptonmc.api.effect.particle.builder/DirectionalParticleEffectBuilder

DirectionalParticleEffectBuilder

interface DirectionalParticleEffectBuilder : BaseParticleEffectBuilder<DirectionalParticleEffectBuilder>

A builder for building directional particle effects.

Functions

Link copied to clipboard
@Contract(value = "-> new", pure = true)
@NotNull
abstract fun build(): @NotNull ParticleEffect
Link copied to clipboard
@Contract(value = "_ -> this", mutates = "this")
abstract fun direction(direction: Vec3d): DirectionalParticleEffectBuilder

Sets the direction that the particle effect will travel.

Link copied to clipboard
@Contract(value = "_ -> this", mutates = "this")
abstract fun longDistance(longDistance: Boolean): DirectionalParticleEffectBuilder

Sets whether the particle effect can be viewed from a further distance than normal.

Link copied to clipboard
@Contract(value = "_ -> this", mutates = "this")
abstract fun offset(offset: Vec3d): DirectionalParticleEffectBuilder

Sets the offset the particles can be from the origin.

Link copied to clipboard
@Contract(value = "_ -> this", mutates = "this")
abstract fun quantity(quantity: Int): DirectionalParticleEffectBuilder

Sets the number of particles to be spawned by the particle effect.

Link copied to clipboard
@Contract(value = "_ -> this", mutates = "this")
abstract fun velocity(velocity: Float): DirectionalParticleEffectBuilder

Sets the velocity that the particle effect will travel with.