1.21.4-2.1.3-SNAPSHOT

surf-api-bukkit-api/dev.slne.surf.surfapi.bukkit.api.event/SingleListener

SingleListener

abstract class SingleListener<T : Event>(val priority: EventPriority = EventPriority.NORMAL, val ignoreCancelled: Boolean = false) : Listener

This class represents a Listener with only one event to listen to.

Constructors

constructor(priority: EventPriority = EventPriority.NORMAL, ignoreCancelled: Boolean = false)

Properties

ignoreCancelled

val ignoreCancelled: Boolean = false

val priority: EventPriority

Functions

abstract fun T.onEvent()

inline fun <T : Event> SingleListener<T>.register()

Registers the SingleListener with its event listener.

inline fun Listener.register()

fun Listener.register(plugin: Plugin)

fun <T : Event> SingleListener<T>.register(plugin: Plugin, eventClass: KClass<T>)

fun <T : Event> Listener.register(plugin: Plugin, eventClass: KClass<T>, priority: EventPriority = EventPriority.NORMAL, ignoreCancelled: Boolean = false, executor: (Listener, Event) -> Unit)

inline fun <T : Event> Listener.register(priority: EventPriority = EventPriority.NORMAL, ignoreCancelled: Boolean = false, noinline executor: (Listener, Event) -> Unit)

Registers the event with a custom event executor.

fun Listener.unregister()

Shortcut for unregistering all events in this listener.