js:MapTool.chat

 This article describes a feature or macro function that is experimental and may be subject to change.

Within the javascript environment used by js.eval, MapTool.chat is the entry point for sending chat messages. This page details the attributes and functions available on the MapTool.chat object.

chat.broadcast() Function

 Note: This function can only be used in a Trusted Macro

• Introduced in version 1.10.0

Like the broadcast() macro.

Usage

MapTool.chat.broadcast(msg);

Parameters

• msg String to send to all players and GMs.

chat.broadcastTo() Function

 Note: This function can only be used in a Trusted Macro

• Introduced in version 1.10.0

Like the broadcast() macro when used to send just to a particular list of connected machines.

Usage

MapTool.chat.broadcastTo(lstOfPlayers, msg);

Parameters

• msg String to send to all players and GMs.
• lstOfPlayers An array containing the names of the players to send the message to.

chat.broadcastToGM() Function

 Note: This function can only be used in a Trusted Macro

• Introduced in version 1.10.0

Like the broadcast() macro, but only sends to GMs.

Usage

Maptool.chat.broadcastToGM(msg)

Parameters

• msg String to send to all GMs.

See Also

js:MapTool()