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

MessageChainBuilder

class MessageChainBuilder : MutableList<SingleMessage> , Appendable

MessageChain 构建器.

注意: 无并发安全性.

连续 String 优化

多个连续的 String 会被连接为单个 PlainText 以优化性能。

MessageChain chain = new MessageChainBuilder()
    .append("Hello ")
    .append("mirai!")
    .build();

// chain 将会只包含一个 [PlainText], 其内容为 "Hello mirai!".

Kotlin 示例

val chain = buildMessageChain {
    +PlainText("a")
    +AtAll
    +Image("/f8f1ab55-bf8e-4236-b55e-955848d7069f")
    add(At(123456))
}

该示例中 + 是 MessageChainBuilder.unaryPlus. 使用 + 和使用 add 是相等的.

Java 示例

MessageChain chain = new MessageChainBuilder()
    .append(new PlainText("string"))
    .append("string") // 会被构造成 PlainText 再添加, 相当于上一行
    .append(AtAll.INSTANCE)
    .append(Image.fromId("{f8f1ab55-bf8e-4236-b55e-955848d7069f}.png"))
    .build();

See also

buildMessageChain

推荐使用

MessageChainBuilder.asMessageChain

完成构建

Constructors

MessageChainBuilder

constructor()

constructor(initialSize: Int)

Functions

open override fun add(index: Int, element: SingleMessage)

fun add(plain: String)

fun add(element: Message): Boolean

open override fun add(element: SingleMessage): Boolean

open override fun addAll(index: Int, elements: Collection<SingleMessage>): Boolean

open override fun addAll(elements: Collection<SingleMessage>): Boolean

@JvmName(name = "addAllFlatten")

fun addAll(elements: Iterable<Message>): Boolean

fun addAll(elements: Iterable<SingleMessage>): Boolean

open override fun append(value: Char): MessageChainBuilder

open override fun append(value: CharSequence?): MessageChainBuilder

fun append(message: Message): MessageChainBuilder

fun append(message: SingleMessage): MessageChainBuilder

open override fun append(value: CharSequence?, startIndex: Int, endIndex: Int): MessageChainBuilder

fun asMessageChain(): MessageChain

fun build(): MessageChain

同 asMessageChain

open override fun clear()

open operator override fun contains(element: SingleMessage): Boolean

open override fun containsAll(elements: Collection<SingleMessage>): Boolean

fun copy(): MessageChainBuilder

将所有已有元素引用复制到一个新的 MessageChainBuilder

open operator override fun get(index: Int): SingleMessage

open override fun indexOf(element: SingleMessage): Int

open override fun isEmpty(): Boolean

open operator override fun iterator(): MutableIterator<SingleMessage>

open override fun lastIndexOf(element: SingleMessage): Int

open override fun listIterator(): MutableListIterator<SingleMessage>

open override fun listIterator(index: Int): MutableListIterator<SingleMessage>

operator fun plusAssign(charSequence: CharSequence)

operator fun plusAssign(plain: String)

operator fun plusAssign(message: Message)

operator fun plusAssign(message: SingleMessage)

open override fun remove(element: SingleMessage): Boolean

open override fun removeAll(elements: Collection<SingleMessage>): Boolean

open override fun removeAt(index: Int): SingleMessage

open override fun retainAll(elements: Collection<SingleMessage>): Boolean

serializeToMiraiCode

fun Iterable<Message>.serializeToMiraiCode(): String

转换得到 mirai 码.

open operator override fun set(index: Int, element: SingleMessage): SingleMessage

open override fun subList(fromIndex: Int, toIndex: Int): MutableList<SingleMessage>

toForwardMessage

fun Iterable<MessageEvent>.toForwardMessage(displayStrategy: ForwardMessage.DisplayStrategy = DisplayStrategy): ForwardMessage

转换为 ForwardMessage

@JvmName(name = "newChain")

inline fun Iterable<Message>.toMessageChain(): MessageChain

扁平化 this 并创建一个 MessageChain.

operator fun String.unaryPlus()

operator fun Message.unaryPlus()

Properties

open override val size: Int