nova-network/xyz.xenondevs.nova.network.event

Package-level declarations

Types

abstract class PacketEvent<P : Packet<*>>

Base class for packet events.

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class PacketHandler(val priority: EventPriority = EventPriority.NORMAL, val ignoreIfCancelled: Boolean = false)

Annotate a function with a single parameter of type PacketEvent with this function to create an event handler for a packet. Requires implementing PacketListener and registration via registerPacketListener.

PacketListener

interface PacketListener

Marker interface for classes that are packet listeners. After registering via registerPacketListener, method annotated with PacketHandler will be called for packet events, just like with Bukkit's event system.

PlayerPacketEvent

abstract class PlayerPacketEvent<P : Packet<*>> : PacketEvent<P>

Base class for packet events that are related to a player.

Functions

registerPacketListener

context(listener: PacketListener)
fun registerPacketListener()

Registers the packet listener to receive packet events. After registering, methods annotated with PacketHandler will be called for packet events.

unregisterPacketListener

context(listener: PacketListener)
fun unregisterPacketListener()

Unregisters the packet listener from receiving packet events. After unregistering, methods annotated with PacketHandler will no longer be called for packet events.