event/com.peco2282.devcore.event/EventBuilder

EventBuilder

class EventBuilder<T : Event>(val plugin: Plugin, val type: Class<T>, var priority: EventPriority = EventPriority.NORMAL, var ignoreCancelled: Boolean = false)

A DSL builder for handling Bukkit events.

Parameters

The type of the event.

plugin

The plugin instance.

type

The class of the event.

priority

The priority of the event listener (default: NORMAL).

ignoreCancelled

Whether to ignore cancelled events (default: false).

Constructors

EventBuilder

constructor(plugin: Plugin, type: Class<T>, priority: EventPriority = EventPriority.NORMAL, ignoreCancelled: Boolean = false)

Properties

ignoreCancelled

var ignoreCancelled: Boolean

plugin

val plugin: Plugin

priority

var priority: EventPriority

type

val type: Class<T>

Functions

cancel

fun T.cancel()

Cancels the event if it is Cancellable.

debug

fun debug(): EventBuilder<T>

Enables debug mode for this listener.

expireAfter

fun expireAfter(seconds: Long): EventBuilder<T>

Automatically unregisters the listener after a specified number of seconds.

filter

fun filter(predicate: T.() -> Boolean): EventBuilder<T>

Adds a filter condition to the event handler.

filterPlayer

fun filterPlayer(predicate: Player.() -> Boolean): EventBuilder<T>

Filters the event based on the player associated with it (only for PlayerEvent).

handle

fun handle(action: T.() -> Unit): EventBuilder<T>

Defines the action to be performed when the event is handled. Calling this method will register the listener.

once

fun once(): EventBuilder<T>

Configures the listener to unregister itself after the first successful execution.

take

fun take(times: Int): EventBuilder<T>

Configures the listener to unregister itself after a certain number of executions.

takeWhile

fun takeWhile(predicate: T.() -> Boolean): EventBuilder<T>

Keeps the listener registered as long as the predicate returns true.

unregister

fun unregister()

Manually unregisters the listener.