js:MapTool.chat

From RPTools Wiki
Jump to navigationJump to search

 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

1 MapTool.chat.broadcast(msg);
2 MapTool.chat.broadcast(lstOfPlayers, msg);

Parameters

  • msg String to send
  • lstOfPlayers An array containing the names of the players to include


chat.broadcastToGM;() Function

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

Introduced in version 1.10.0
Like chat.broadcast, but only includes GMs.

Usage

1 Maptool.chat.broadcastToGM(msg)

Parameters

  • msg String to send


See Also

JS: MapTool