nova-packet-entity/xyz.xenondevs.nova.packetentity/PassengerPacketEntityDsl

PassengerPacketEntityDsl

sealed interface PassengerPacketEntityDsl<M : EntityMetadataDsl>

DSL scope for configuring a packet entity that is used as a passenger.

Passenger entities do not define their own location, viewer whitelist/blacklist, or spawn/despawn handlers. Instead, they are tied to the parent entity and are spawned and despawned with it.

Properties

attributes

abstract val attributes: AttributesDslProperty

The entity's attributes.

equipment

abstract val equipment: EquipmentDslProperty

The entity's equipment slots.

Functions

equipment

abstract fun equipment(equipment: EquipmentDsl.() -> Unit)

Configures equipment using named equipment slots.

metadata

abstract fun metadata(metadata: M.() -> Unit)

Configures entity metadata.

onAttack

abstract fun onAttack(handler: AttackDsl.() -> Unit)

Registers a handler called on the main server thread when a player attacks this passenger (left click).

onAttackAsync

abstract fun onAttackAsync(handler: (ServerboundAttackPacketEvent) -> Unit)

Registers a handler called on the player's Netty event-loop thread when they attack this passenger (left click).

onInteract

abstract fun onInteract(handler: InteractDsl.() -> InteractionResult)

Registers a handler called on the main server thread when a player interacts with this passenger (right click).

onInteractAsync

abstract fun onInteractAsync(handler: (ServerboundInteractPacketEvent) -> Unit)

Registers a handler called on the player's Netty event-loop thread when they interact with this passenger (right click).

onPickAsync

abstract fun onPickAsync(handler: (ServerboundPickItemFromEntityPacketEvent) -> Unit)

Registers a handler called on the player's Netty event-loop thread when they pick this passenger (middle click).

passengers

abstract fun passengers(passengers: PacketEntityPassengersDsl.() -> Unit)

Adds nested passenger packet entities to this passenger.