Skip to content

Chat

The Chat namespace provides helpers for sending, printing, and querying chat channel messages.


Functions

Roll(min: number, max: number, ally: boolean)void

Sends a roll message to a team or global chat.

  • minnumber - The minimum number that can be rolled.
  • maxnumber - The maximum number that can be rolled.
  • allyboolean - Whether the roll should be sent to the team chat or global chat.

GetChannels()string[]

Returns an array of chat channel names.

Returned:

  • string[] - An array of strings representing the names of the chat channels.

Say(channel: string, msg: string)void

Sends a message to a specified chat channel. The message will be visible to all players in the channel.

  • channelstring - The name of the chat channel.
  • msgstring - The message to be sent.

IMPORTANT

Can be used to send chat commands like "-lvlmax", "-refresh", etc.


Print(channel: string, msg: string)void

Prints a message from the specified chat channel, visible only to the local player.

  • channelstring - The name of the chat channel.
  • msgstring - The message to be printed.