js:MapTool.chat: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(Created page with "Within the javascript environment used by {{code|js.eval}}, {{code|MapTool.chat}} is the entry point for sending chat messages. This page details the attributes and functions...")
 
No edit summary
Line 1: Line 1:
{{Experimental}}
Within the javascript environment used by {{code|js.eval}}, {{code|MapTool.chat}} is the entry point for sending chat messages.  This page details the attributes and functions available on the {{code|MapTool.chat}} object.
Within the javascript environment used by {{code|js.eval}}, {{code|MapTool.chat}} is the entry point for sending chat messages.  This page details the attributes and functions available on the {{code|MapTool.chat}} object.



Revision as of 08:06, 4 August 2021

 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.9.4
Like the broadcast() macro.

Usage

MapTool.chat.broadcast(msg);
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.9.4
Like chat.broadcast, but only includes GMs.

Usage

Maptool.chat.broadcastToGM(msg)

Parameters

  • msg String to send


See Also

JS: MapTool