NollyAPI/com.thenolle.api.nollyapi.util.events/EventScope

EventScope

class EventScope<T : Event>(val filters: MutableList<(T) -> Boolean> = mutableListOf())

Defines a scope for filtering events based on various criteria.

This class provides a set of functions to filter events based on conditions like player names, permissions, world names, metadata, and more. It allows building complex event filters.

Constructors

EventScope

constructor(filters: MutableList<(T) -> Boolean> = mutableListOf())

Types

Companion

object Companion

Companion object for creating an instance of EventScope.

Properties

filters

val filters: MutableList<(T) -> Boolean>

Functions

custom

fun custom(block: (T) -> Boolean): EventScope<T>

Adds a custom condition to the scope.

meta

fun meta(key: String): EventScope<T>

Adds a condition that checks if the event has metadata for a given key.

metaMatch

fun metaMatch(key: String, test: (Any?) -> Boolean): EventScope<T>

Adds a condition that checks if the metadata value for a given key matches a specified test.

negate

fun negate(scopeFunction: EventScope<T>.() -> Unit): EventScope<T>

Negates the condition defined in the provided scopeFunction.

notOp

fun notOp(): EventScope<T>

Adds a condition that checks if the player is not an operator.

notPaused

fun notPaused(key: String): EventScope<T>

Adds a condition that checks if the event is not paused based on a given key.

notWorld

fun notWorld(name: String): EventScope<T>

Adds a condition that checks if the event did not occur in the specified world.

oneOfPlayers

fun oneOfPlayers(vararg names: String): EventScope<T>

Adds a condition that checks if the event was triggered by any of the specified player names.

fun oneOfPlayers(vararg players: Player): EventScope<T>

Adds a condition that checks if the event was triggered by any of the specified players.

fun op(): EventScope<T>

Adds a condition that checks if the player is an operator.

paused

fun paused(key: String): EventScope<T>

Adds a condition that checks if the event is paused based on a given key.

permission

fun permission(permission: String): EventScope<T>

Adds a condition that checks if the player involved in the event has the specified permission.

permissionsAll

fun permissionsAll(vararg permissions: String): EventScope<T>

Adds a condition that checks if the player has all of the specified permissions.

permissionsOne

fun permissionsOne(vararg permissions: String): EventScope<T>

Adds a condition that checks if the player has at least one of the specified permissions.

player

fun player(name: String): EventScope<T>

Adds a condition that checks if the event was triggered by a player with the specified name.

fun player(player: Player): EventScope<T>

Adds a condition that checks if the event was triggered by a specific player.

scope

fun scope(block: (T) -> Boolean): EventScope<T>

Adds a condition to the scope.

test

fun test(event: T): Boolean

Evaluates whether the event passes all filters defined in the scope.

useTemplate

fun useTemplate(name: String): EventScope<T>

Applies an event template with the specified name.

world

fun world(name: String): EventScope<T>

Adds a condition that checks if the event occurred in the specified world.