For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt, and this page is available as Markdown at /server-ui/interfaces/UIRawMessage.md.

Interface: UIRawMessage

Beta

可以发送给客户端的消息。这是 RawMessage 类型的子集,用于 UI 消息。

A message that can be sent to the client. This is a subset of the RawMessage type, and is used for UI messages.

Properties

rawtext?

optional rawtext?: UIRawMessage[]

Beta

Remarks

提供当前消息的原始文本等价物。

Provides a raw-text equivalent of the current message.


text?

optional text?: string

Beta

Remarks

提供要使用的字符串字面量值。

Provides a string literal value to use.


translate?

optional translate?: string

Beta

Remarks

提供一个本地化字符串,如果客户端在玩家语言中有与本地化字符串匹配的可用资源,则会在客户端进行翻译。

Provides a localization string where, if the client has an available resource in the players' language which matches the localization string, will get translated on the client.


with?

optional with?: string[] | UIRawMessage

Beta

Remarks

本地化字符串的参数。可以是字符串数组,也可以是包含原始文本对象数组的 UIRawMessage。

Arguments for the localization string. Can be either an array of strings or UIRawMessage containing an array of raw text objects.