VfxBuilder

class VfxBuilder(player: Player)

DSL builder for sending packet-based visual and audio effects to a Player.

Obtain an instance via the Player.vfx extension function.

player

The target player for all operations in this builder.

Constructors

constructor(player: Player)

fun blockCrack(location: Location, stage: Int)

Sends a block crack (mining progress) animation to the player.

fun explosion(location: Location, power: Float = 1.0f)

Sends a fake explosion effect to the player at the given location.

fun fakeEquipment(entityId: Int, slot: EquipmentSlot, item: ItemStack)

Sends a fake equipment packet to the player for the specified entity slot.

fun lightning(location: Location)

Sends a fake lightning strike effect to the player at the given location.

fun localSound(sound: Sound, location: Location, volume: Float = 1.0f, pitch: Float = 1.0f)

Plays a sound at a specific location for the player only.

fun onFire(entityId: Int, onFire: Boolean = true)

Sets the on-fire visual state of an entity for the player.