mirai-core-api/net.mamoe.mirai.event.events/MessagePreSendEvent

MessagePreSendEvent

sealed class MessagePreSendEvent : AbstractEvent, BotEvent, BotActiveEvent, CancellableEvent, VerboseEvent

在发送消息前广播的事件. 可被取消.

此事件总是在 MessagePostSendEvent 之前广播.

当 MessagePreSendEvent 被取消后:

MessagePostSendEvent 不会广播
消息不会发送.
Contact.sendMessage 会抛出异常 EventCancelledException

See also

net.mamoe.mirai.contact.Contact

发送消息. 为广播这个事件的唯一途径

Functions

fun cancel()

abstract fun intercept()

拦截这个事件

Properties

@MiraiInternalApi

var _intercepted: Boolean = false

override val bot: Bot

@MiraiInternalApi

val broadCastLock: Mutex

限制一个事件实例不能并行广播. (适用于 object 广播的情况)

val isCancelled: Boolean

abstract val isIntercepted: Boolean

事件是否已被拦截.

abstract var message: Message

待发送的消息. 修改后将会同时应用于发送.

abstract val target: Contact

发信目标.

Inheritors

GroupMessagePreSendEvent

UserMessagePreSendEvent