simbot-core/love.forte.simbot.core.event

Package-level declarations

Types

EventInterceptEntrance

abstract class EventInterceptEntrance<C : EventInterceptor.Context<R>, R, EC : EventProcessingContext>

事件相关拦截器入口。通过解析拦截器列表提供一个最终的入口。

EventInterceptorsGenerator

class EventInterceptorsGenerator @InternalSimbotApi constructor

事件拦截器的生成/构建器，用于 SimpleListenerManagerConfiguration 中。

EventListenerExceptionHandler

typealias EventListenerExceptionHandler = suspend (EventListenerProcessingContext, Throwable) -> EventResult

监听函数执行的异常处理器。当 SimpleEventListenerManager 中的某一个 EventListener 执行过程中出现了异常（包括其过程中所经过的拦截器或过滤器），则本次执行内容与对应异常将会交由一个唯一的一场管理器进行处理，并得到一个应得的结果。

EventListenerRegistrationDescriptionsGenerator

class EventListenerRegistrationDescriptionsGenerator @InternalSimbotApi constructor : EventListenersGenerator

用于构建监听函数的构建器。

EventListenersGenerator

interface EventListenersGenerator

用于构建监听函数的构建器。

EventProcessingContextResolver

interface EventProcessingContextResolver<C : EventProcessingContext>

事件流程上下文的管理器，SimpleEventListenerManager 通过此接口实例完成对 EventProcessingContext 的统一管理。

ListenerInvokeType

enum ListenerInvokeType : Enum<ListenerInvokeType>

监听函数执行状态。由 EventProcessingContextResolver.appendResultIntoContext 进行返回。

SimpleEventListenerManager

interface SimpleEventListenerManager : EventListenerManager

核心监听函数管理器。

SimpleFunctionalEventInterceptor

sealed class SimpleFunctionalEventInterceptor<C : EventInterceptor.Context<R>, R> : Interceptor<C, R>

核心提供的事件拦截器实现, 基于函数提供外部事件逻辑。

SimpleFunctionalEventListenerInterceptor

class SimpleFunctionalEventListenerInterceptor(val point: EventListenerInterceptor.Point, val priority: Int = PriorityConstant.NORMAL, val interceptFunction: suspend (EventListenerInterceptor.Context) -> EventResult) : SimpleFunctionalEventInterceptor<EventListenerInterceptor.Context, EventResult> , EventListenerInterceptor

SimpleFunctionalEventProcessingInterceptor

class SimpleFunctionalEventProcessingInterceptor(val priority: Int = PriorityConstant.NORMAL, val interceptFunction: suspend (EventProcessingInterceptor.Context) -> EventProcessingResult) : SimpleFunctionalEventInterceptor<EventProcessingInterceptor.Context, EventProcessingResult> , EventProcessingInterceptor

SimpleListener

class SimpleListener(targets: Set<Event.Key<*>>, attributes: AttributeContainer? = null, matcher: suspend EventListenerProcessingContext.() -> Boolean = { true }, function: suspend EventListenerProcessingContext.() -> EventResult) : EventListener

核心模块中所提供的最基础的 EventListener 实现。

SimpleListenerBuilder

open class SimpleListenerBuilder<E : Event>(val target: Event.Key<E>) : EventListenerBuilder

用于构建一个 SimpleListener 监听函数。

SimpleListenerBuilderDslFunction

fun interface SimpleListenerBuilderDslFunction<E : Event>

使用于 EventListenerRegistrationDescriptionsGenerator.listen, 用于兼容Kotlin和Java的函数接口差异。

SimpleListenerManagerConfig

data class SimpleListenerManagerConfig(coroutineContext: CoroutineContext, exceptionHandler: (Throwable) -> EventResult? = null, processingInterceptors: IDMaps<EventProcessingInterceptor>, listenerInterceptors: IDMaps<EventListenerInterceptor>, listeners: List<EventListenerRegistrationDescription>, messageSerializersModule: SerializersModule)

SimpleListenerManagerConfiguration

open class SimpleListenerManagerConfiguration

SimpleEventListenerManager 的配置文件. 当配置文件作为构建参数的时候，他会被立即使用。

SimpleListenerRegistrationDescriptionBuilder

class SimpleListenerRegistrationDescriptionBuilder<E : Event>(target: Event.Key<E>) : SimpleListenerBuilder<E> , EventListenerRegistrationDescriptionBuilder

基于 SimpleListenerBuilder 构建一个 SimpleEventListenerRegistrationDescription.

Functions

addListenerInterceptors

fun SimpleListenerManagerConfiguration.addListenerInterceptors(vararg interceptors: Pair<ID, EventListenerInterceptor>)

针对 SimpleListenerManagerConfiguration.addListenerInterceptors 的扩展函数。

addProcessingInterceptors

fun SimpleListenerManagerConfiguration.addProcessingInterceptors(vararg interceptors: Pair<ID, EventProcessingInterceptor>)

针对 SimpleListenerManagerConfiguration.addProcessingInterceptors 的扩展函数。

blockingSimpleFilter

@Api4J

@JvmOverloads

@JvmName(name = "simpleFilter")

fun blockingSimpleFilter(priority: Int = PriorityConstant.NORMAL, tester: Predicate<EventListenerProcessingContext>): EventFilter

使用阻塞的逻辑构建一个 EventFilter.

blockingSimpleListener

@Api4J

@JvmName(name = "listener")

@JvmOverloads

fun <E : Event> blockingSimpleListener(target: Event.Key<E>, matcher: BiPredicate<EventListenerProcessingContext, E>? = null, function: BiFunction<EventListenerProcessingContext, E, EventResult>): EventListener

构建一个 EventListener 实例。为不支持挂起函数的使用者准备，例如 Java 。

blockingSimpleListenerWithoutResult

@Api4J

@JvmName(name = "listener")

@JvmOverloads

fun <E : Event> blockingSimpleListenerWithoutResult(target: Event.Key<E>, matcher: BiPredicate<EventListenerProcessingContext, E>? = null, function: BiConsumer<EventListenerProcessingContext, E>): EventListener

构建一个 EventListener 实例。为不支持挂起函数的使用者准备，例如 Java 。

buildSimpleListener

@ExperimentalSimbotApi

inline fun <E : Event> buildSimpleListener(block: SimpleListenerBuilder<E>.() -> Unit): EventListener

inline fun <E : Event> buildSimpleListener(target: Event.Key<E>, block: SimpleListenerBuilder<E>.() -> Unit): EventListener

通过 SimpleListenerBuilder 构建一个 EventListener 实例。

buildSimpleListenerRegistrationDescription

@ExperimentalSimbotApi

inline fun <E : Event> buildSimpleListenerRegistrationDescription(block: SimpleListenerRegistrationDescriptionBuilder<E>.() -> Unit): EventListenerRegistrationDescription

inline fun <E : Event> buildSimpleListenerRegistrationDescription(target: Event.Key<E>, block: SimpleListenerRegistrationDescriptionBuilder<E>.() -> Unit): EventListenerRegistrationDescription

通过 SimpleListenerRegistrationDescriptionBuilder 构建一个 EventListenerRegistrationDescription 实例。

inSession

@ExperimentalSimbotApi

inline fun <R> EventProcessingContext.inSession(block: ContinuousSessionContext.() -> R): R

通过 EventProcessingContext 获取并进入 ContinuousSessionContext 的作用域中, 可以在存在 EventProcessingContext 时搭配使用：

listen

inline fun <E : Event> EventListenerRegistrar.listen(key: Event.Key<E>, block: SimpleListenerRegistrationDescriptionBuilder<E>.() -> Unit): EventListenerHandle

向 EventListenerRegistrar 中注册一个监听函数。

@ExperimentalSimbotApi

inline fun <E : Event> EventListenerRegistrar.listen(attributes: AttributeContainer? = null, crossinline matcher: suspend EventListenerProcessingContext.(E) -> Boolean = { true }, crossinline func: suspend EventListenerProcessingContext.(E) -> EventResult): EventListener

@ExperimentalSimbotApi

inline fun <E : Event> EventListenerRegistrar.listen(eventKey: Event.Key<E>, attributes: AttributeContainer? = null, crossinline matcher: suspend EventListenerProcessingContext.(E) -> Boolean = { true }, crossinline func: suspend EventListenerProcessingContext.(E) -> EventResult): EventListener

向 EventListenerManager 中注册一个监听器。

listenerInterceptor4J

@Api4J

@JvmOverloads

@JvmName(name = "simpleListenerInterceptor")

fun listenerInterceptor4J(point: EventListenerInterceptor.Point = EventListenerInterceptor.Point.DEFAULT, priority: Int = PriorityConstant.NORMAL, interceptFunction: Function<EventListenerInterceptor.Context, EventResult>): EventListenerInterceptor

提供一个优先级和拦截函数, 得到一个流程拦截器 EventListenerInterceptor.

listeners

inline fun EventListenerRegistrar.listeners(block: EventListenerRegistrationDescriptionsGenerator.() -> Unit)

向 EventListenerRegistrar 中注册多个监听函数。

matchMessage

inline fun <E : MessageEvent, M : Message.Element<M>> SimpleListenerBuilder<E>.matchMessage(messageKey: Message.Key<M>, require: Boolean = true, crossinline matcher: suspend EventListenerProcessingContext.(E, M, index: Int) -> Boolean)

对一个消息事件 E 的消息元素中指定的类型进行校验。

matchText

inline fun <E : MessageEvent> SimpleListenerBuilder<E>.matchText(crossinline textProvider: suspend EventListenerProcessingContext.(E) -> String)

对一个消息事件 E 的文本内容进行匹配。

plus

operator fun EventListener.plus(filters: Iterable<EventFilter>): EventListener

向目标 EventListener 外层包装多个 EventFilter.

operator fun EventListener.plus(filter: EventFilter): EventListener

向目标 EventListener 外层包装 EventFilter.

processingInterceptor4J

@Api4J

@JvmOverloads

@JvmName(name = "simpleProcessingInterceptor")

fun processingInterceptor4J(priority: Int = PriorityConstant.NORMAL, interceptFunction: Function<EventProcessingInterceptor.Context, EventProcessingResult>): EventProcessingInterceptor

提供一个优先级和拦截函数, 得到一个流程拦截器 EventProcessingInterceptor.

proxy

fun <E : EventListener> E.proxy(handleMatch: suspend EventListenerProcessingContext.(E) -> Boolean = { it.match(this) }, handleInvoke: suspend EventListenerProcessingContext.(E) -> EventResult): EventListener

提供一层包装来代理目标监听函数。

simpleFilter

fun simpleFilter(priority: Int = PriorityConstant.NORMAL, tester: suspend (context: EventListenerProcessingContext) -> Boolean): EventFilter

构建一个 EventFilter.

simpleListener

@FragileSimbotApi

inline fun <E : Event> simpleListener(attributes: AttributeContainer? = null, crossinline matcher: suspend EventListenerProcessingContext.(E) -> Boolean = { true }, crossinline function: suspend EventListenerProcessingContext.(E) -> EventResult): EventListener

构建一个监听指定类型的监听函数。

inline fun simpleListener(targets: Collection<Event.Key<*>>, attributes: AttributeContainer? = null, crossinline matcher: suspend EventListenerProcessingContext.() -> Boolean = { true }, crossinline function: suspend EventListenerProcessingContext.() -> EventResult): EventListener

构建一个监听多个类型的监听函数。

inline fun <E : Event> simpleListener(target: Event.Key<E>, attributes: AttributeContainer? = null, crossinline matcher: suspend EventListenerProcessingContext.(E) -> Boolean = EventListenerProcessingContext::defaultMatcher, crossinline function: suspend EventListenerProcessingContext.(E) -> EventResult): EventListener

构建一个监听指定的类型的监听函数。

simpleListenerInterceptor

fun simpleListenerInterceptor(point: EventListenerInterceptor.Point = EventListenerInterceptor.Point.DEFAULT, priority: Int = PriorityConstant.NORMAL, interceptFunction: suspend (EventListenerInterceptor.Context) -> EventResult): EventListenerInterceptor

提供一个优先级和拦截函数, 得到一个流程拦截器 EventListenerInterceptor.

simpleListenerManager

inline fun simpleListenerManager(initial: SimpleListenerManagerConfiguration = SimpleListenerManagerConfiguration(), block: SimpleListenerManagerConfiguration.() -> Unit): SimpleEventListenerManager

构建一个 SimpleEventListenerManager.

simpleProcessingInterceptor

fun simpleProcessingInterceptor(priority: Int = PriorityConstant.NORMAL, interceptFunction: suspend (EventProcessingInterceptor.Context) -> EventProcessingResult): EventProcessingInterceptor

提供一个优先级和拦截函数, 得到一个流程拦截器 EventProcessingInterceptor.

withMatcher

fun EventListener.withMatcher(matcher: suspend EventListenerProcessingContext.() -> Boolean = { true }): EventListener

提供一个匹配函数，将当前监听函数根据新的匹配函数转化为一个新的 EventListener.