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

BlockParticleEffectBuilder

interface BlockParticleEffectBuilder : BaseParticleEffectBuilder<BlockParticleEffectBuilder>

A builder for building block particle effects.

Functions

Link copied to clipboard
@Contract(value = "_ -> this", mutates = "this")
abstract fun block(block: BlockState): BlockParticleEffectBuilder

Sets the block state of the texture to be used.

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 longDistance(longDistance: Boolean): BlockParticleEffectBuilder

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): BlockParticleEffectBuilder

Sets the offset the particles can be from the origin.

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

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