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-editor/interfaces/LogProperties.md.

Interface: LogProperties

Beta

A properties class for the global instance of the logger object. While the logger object is available through the ExtensionContext - using the global instance allows the creator to use this properties class to perform direct server->client messaging and broadcasts.

Properties

channelMask?

optional channelMask?: LogChannel

Beta

Remarks

Display the log message to a log channel. If no channel is specified, default channel is regular message.


player?

optional player?: any

Beta

Remarks

Direct a log message to a specific player. If no player is specified, then all players will receive the message


subMessage?

optional subMessage?: string | LocalizationEntry

Beta

Remarks

Message to be shown under the message when toast channel is selected.


tags?

optional tags?: string[]

Beta

Remarks

Add additional tags to the log message which can be used by the client session to filter/search in the log window