js:MapTool.chat: Difference between revisions
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...") |
m (Changed parameter name to the same as the linked function (for clarity)) |
||
| (8 intermediate revisions by 4 users not shown) | |||
| 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. | ||
| Line 4: | Line 5: | ||
|name=chat.broadcast | |name=chat.broadcast | ||
|trusted=true | |trusted=true | ||
|version=1. | |version=1.10.0 | ||
|description= | |description=Like the {{func|broadcast}} macro. | ||
Like the {{func|broadcast}} macro. | |||
|usage= | |usage= | ||
< | <syntaxhighlight lang="javascript" line> | ||
MapTool.chat.broadcast(msg); | MapTool.chat.broadcast(msg); | ||
</syntaxhighlight> | |||
</ | |||
'''Parameters''' | '''Parameters''' | ||
* {{code|msg}} String to send | * {{code|msg}} String to send to all players and GMs. | ||
}} | |||
{{MacroFunction | |||
|name=chat.broadcastTo | |||
|trusted=true | |||
|version=1.10.0 | |||
|description=Like the {{func|broadcast}} macro when used to send just to a particular list of connected machines. | |||
|usage= | |||
<syntaxhighlight lang="javascript" line> | |||
MapTool.chat.broadcastTo(targets, msg); | |||
</syntaxhighlight> | |||
'''Parameters''' | |||
* {{code|targets}} An array containing the names of the players to send the message to. Can include the same list of values as the {{code|targets}} parameter to {{func|broadcast}}. | |||
* {{code|msg}} String to send to the list of users specified by {{code|lstOfPlayers}}. | |||
}} | }} | ||
{{MacroFunction | {{MacroFunction | ||
|name=chat.broadcastToGM | |name=chat.broadcastToGM | ||
|trusted=true | |trusted=true | ||
|version=1. | |version=1.10.0 | ||
|description= | |description=Like the {{func|broadcast}} macro, but only sends to GMs. | ||
Like | |||
|usage= | |usage= | ||
< | <syntaxhighlight lang="javascript" line> | ||
Maptool.chat.broadcastToGM(msg) | Maptool.chat.broadcastToGM(msg) | ||
</ | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
* {{code|msg}} String to send | * {{code|msg}} String to send to all GMs. | ||
}} | }} | ||
== See Also == | |||
{{func|js:MapTool}} | |||
[[Category:Javascript Function]] | [[Category:Javascript Function]] | ||
Latest revision as of 23:59, 11 June 2023
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
msgString 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(targets, msg);
Parameters
targetsAn array containing the names of the players to send the message to. Can include the same list of values as thetargetsparameter to broadcast().msgString to send to the list of users specified bylstOfPlayers.
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
msgString to send to all GMs.