mirai-core-api/net.mamoe.mirai.message.data/SuperFace

SuperFace

@Serializable

class SuperFace @MiraiInternalApi constructor(val face: Int, val id: String, val type: Int) : HummerMessage, CodableMessage

表示一个超级表情.

超级表情由普通表情转换而来. 不是所有的普通表情都有对应的超级表情.

要构造超级表情, 使用 SuperFace.from 或 SuperFace.fromOrNull. 在 Kotlin 还可以使用对应扩展函数: Face.toSuperFace 或 Face.toSuperFaceOrNull.

Since

2.16

Constructors

SuperFace

@MiraiInternalApi

constructor(face: Int, id: String, type: Int)

Types

Key

object Key : AbstractPolymorphicMessageKey<MessageContent, SuperFace>

Functions

appendMiraiCodeTo

@MiraiExperimentalApi

open override fun appendMiraiCodeTo(builder: StringBuilder)

contentEquals

open fun contentEquals(another: String, ignoreCase: Boolean = false): Boolean

判断内容是否与 another 相等.

open fun contentEquals(another: Message, ignoreCase: Boolean = false): Boolean

判断内容是否与 another 相等即 this 与 another 的 contentToString 相等.

open fun contentEquals(another: Message, ignoreCase: Boolean = false, strict: Boolean = false): Boolean

判断内容是否与 another 相等即 this 与 another 的 contentToString 相等.

contentToString

open override fun contentToString(): String

转为接近官方格式的字符串, 即 "内容". 如 At(member) + "test" 将转为 "@QQ test".

equals

open operator override fun equals(other: Any?): Boolean

followedBy

open fun followedBy(tail: Message): MessageChain

将 this 和 tail 连接.

hashCode

open override fun hashCode(): Int

isContentBlank

fun Message.isContentBlank(): Boolean

当消息内容为空白时返回 true.

isContentEmpty

fun Message.isContentEmpty(): Boolean

当消息内容为空时返回 true.

plus

open operator fun plus(another: Array<out Message>): MessageChain

创建一个消息链, 将 another 连接到这个消息的尾部. 这不会改变本 Message, 而是会创建新的 MessageChain 实例. 返回的 MessageChain 实例的第一个元素为本 Message, 随后为按顺序的 another 中的元素.

open operator fun plus(another: CharSequence): MessageChain

open operator fun plus(another: String): MessageChain

@JvmName(name = "plusIterableString")

open operator fun plus(another: Iterable<String>): MessageChain

open operator fun plus(another: Iterable<Message>): MessageChain

open operator fun plus(another: Sequence<Message>): MessageChain

open operator fun plus(another: Message): MessageChain

open operator fun plus(another: MessageChain): MessageChain

open operator fun plus(another: SingleMessage): MessageChain

plus

suspend operator fun Message.plus(another: Flow<Message>): MessageChain

将 another 按顺序连接到这个消息的尾部.

repeat

fun Message.repeat(count: Int): MessageChain

将此消息元素按顺序重复 count 次.

sendTo

inline suspend fun <C : Contact> Message.sendTo(contact: C): MessageReceipt<C>

将 this 发送给指定联系人

serializeToMiraiCode

open fun serializeToMiraiCode(): String

转换为 mirai 码.

serializeToMiraiCode

@JvmStatic

fun CodableMessage.serializeToMiraiCode(): String

转换得到 mirai 码.

times

operator fun Message.times(count: Int): MessageChain

将此消息元素按顺序重复 count 次.

toFace

fun SuperFace.toFace(): Face

将超级表情转换为普通表情

toForwardMessage

@JvmOverloads

fun Message.toForwardMessage(sender: User, time: Int = currentTimeSeconds().toInt(), displayStrategy: ForwardMessage.DisplayStrategy = DisplayStrategy): ForwardMessage

@JvmOverloads

fun Message.toForwardMessage(senderId: Long, senderName: String, time: Int = currentTimeSeconds().toInt(), displayStrategy: ForwardMessage.DisplayStrategy = DisplayStrategy): ForwardMessage

转换为 ForwardMessage

toMessageChain

fun Message.toMessageChain(): MessageChain

toString

open override fun toString(): String

得到包含 mirai 消息元素代码的, 易读的字符串. 如 At(member) + "test" 将转为 "[mirai:at:qqId]test".

Properties

content

val Message.content: String

Message.contentToString 的捷径

face

val face: Int

val id: String

key

open override val key: MessageKey<SuperFace>

用于判断是否为同一种元素的 MessageKey. 使用多态类型 MessageKey 最上层的 MessageKey.

name

val name: String

type

val type: Int

SuperFace

Since

See also

Constructors

Types

Functions

Properties