ChatMessageBuilder

Methods
4
Fields
None

Getting one

ChatMessageBuilder.new()

Methods

MethodReturnsDescription
append(ChatColorType)ChatMessageBuilder(ChatMessageBuilder, ChatColorType) -> ChatMessageBuilder: <colNORMAL> or <colHIGHLIGHT>: replaced by the chat type's colour when the…
append(string)ChatMessageBuilder
append(Color, string)ChatMessageBuilder
img(number)ChatMessageBuilder<img=imageId>: a chat icon (a mod-icon index).
build()stringThe markup built so far.
new()ChatMessageBuilderAn empty builder.

Returned by

MethodReturnsDescription
ChatMessageBuilderClass.newChatMessageBuilderAn empty builder.

Method details

append

append: ((ChatMessageBuilder, ChatColorType) -> ChatMessageBuilder) & ((ChatMessageBuilder, string) -> ChatMessageBuilder) & ((ChatMessageBuilder, Color, string) -> ChatMessageBuilder)

(ChatMessageBuilder, ChatColorType) -> ChatMessageBuilder: <colNORMAL> or <colHIGHLIGHT>: replaced by the chat type's colour when the message is queued as a clientFormattedMessage.

(ChatMessageBuilder, string) -> ChatMessageBuilder: message, escaped (Text.escapeJagex): it shows as written.

(ChatMessageBuilder, Color, string) -> ChatMessageBuilder: message in color (ColorUtil.wrapWithColorTag), not escaped.