simbot-api/love.forte.simbot.event/EventListenerRegistrar

EventListenerRegistrar

interface EventListenerRegistrar(source)

事件处理器的注册器。用于承载注册、管理处理器的职责。

Author

ForteScarlet

Inheritors

EventDispatcher

Functions

abstract fun dispose(listener: EventListener)

注销所有通过指定的 EventListener 所注册的事件处理器。

open fun register(listener: EventListener): EventListenerRegistrationHandle

注册一个默认属性的 EventListener.

abstract fun register(propertiesConsumer: ConfigurerFunction<EventListenerRegistrationProperties>?, listener: EventListener): EventListenerRegistrationHandle

注册一个 EventListener 并附加部分额外属性信息。

Inherited functions

inline fun <E : Event> EventListenerRegistrar.listen(propertiesConsumer: ConfigurerFunction<EventListenerRegistrationProperties>? = null, crossinline typeMismatchResult: EventListenerContext.() -> EventResult = { invalid() }, crossinline listenerFunction: suspend EventListenerContext.(E) -> EventResult): EventListenerRegistrationHandle

为特定事件类型注册事件处理器函数。

inline fun EventListenerRegistrar.process(crossinline defaultResult: () -> EventResult = { EventResult.empty() }, propertiesConsumer: ConfigurerFunction<EventListenerRegistrationProperties>? = null, crossinline listenerFunction: suspend EventListenerContext.() -> Unit): EventListenerRegistrationHandle

是 listen 或 EventListenerRegistrar.register 的进一步简写形式，注册一个事件处理器。通过 process 注册的事件处理器函数不会要求你返回 EventResult，取而代之的是始终返回默认的 defaultResult，默认为 EventResult.empty。

inline fun <E : Event> EventListenerRegistrar.process(propertiesConsumer: ConfigurerFunction<EventListenerRegistrationProperties>? = null, crossinline defaultResult: () -> EventResult = { EventResult.empty() }, crossinline typeMismatchResult: EventListenerContext.() -> EventResult = { invalid() }, crossinline listenerFunction: suspend EventListenerContext.(E) -> Unit): EventListenerRegistrationHandle

是 listen 或 EventListenerRegistrar.register 的进一步简写形式，注册一个处理特定类型 E 的事件处理器。通过 process 注册的事件处理器函数不会要求你返回 EventResult，取而代之的是始终返回默认的 defaultResult，默认为 EventResult.empty。