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

StartPointEvent

@BaseEvent

interface StartPointEvent : ChangedEvent

一个起点事件。

StartPointEvent 是一个变化的起始变化，通常情况下其代表在变化后变化体开始存在，因此在 StartPointEvent 中 before 通常为 null。

Note: StartPointEvent 主要为 IncreaseEvent 事件提供上层语义, 很少有直接使用此事件的情况。

Types

Key

object Key : BaseEventKey<StartPointEvent>

Functions

after

abstract suspend fun after(): Any?

变更行为后的内容。

before

open suspend override fun before(): Any?

开端事件, before通常为null。

source

abstract suspend fun source(): Any

变更载体，或者说变更内容的源。

Properties

bot

abstract override val bot: Bot

与这个事件有关系的 Bot.

changedTime

abstract val changedTime: Timestamp

此事件所代表的变更发生的时间。

component

open override val component: Component

一个事件所属的组件。通常与 bot 的组件所属一致。

abstract override val id: ID

事件的唯一标识。

key

abstract val key: Event.Key<out Event>

得到当前事件所对应的类型key。

timestamp

open override val timestamp: Timestamp

通常情况下，事件时间就相当于其变更时的时间。

Inheritors

IncreaseEvent

Extensions

replyIfSupport

suspend fun Event.replyIfSupport(message: Message): MessageReceipt?

suspend fun Event.replyIfSupport(message: () -> Message): MessageReceipt?

suspend fun Event.replyIfSupport(message: MessageContent): MessageReceipt?

suspend fun Event.replyIfSupport(message: String): MessageReceipt?

如果此事件允许回复消息，发送，否则得到null。

sameIdWith

infix fun IDContainer.sameIdWith(other: IDContainer): Boolean

比较两个 IDContainer 的 IDContainer.id 是否一致。