Edit

UIRawMessage Interface

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

rawtext?: UIRawMessage[];

Provides a raw-text equivalent of the current message.

Type: UIRawMessage[]

text

text?: string;

Provides a string literal value to use.

Type: string

translate

translate?: string;

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.

Type: string

with

with?: string[] | UIRawMessage;

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

Type: string[] | UIRawMessage