Difference between revisions of "Script:Interpreted sendChat"
From Roll20 Wiki
(Created page with "{{stub}}") |
|||
| Line 1: | Line 1: | ||
| − | {{ | + | {{script overview |
| + | |name=Interpreted sendChat | ||
| + | |author={{user profile|235259|Brian}} | ||
| + | |version=2.0 | ||
| + | |lastmodified=2015-01-08 | ||
| + | |dependencies={{api repository link|levenshteinDistance}} | ||
| + | }} | ||
| + | |||
| + | '''Interpreted sendChat''' is designed to assist other scripts in handling message output. When a script needs to send a message to chat (normally handled with the native <code>sendChat</code> function) as though the message is being sent by the same player or character who triggered the chat message event, Interpreted sendChat may be used. | ||
| + | <br clear="all"> | ||
| + | |||
| + | === Syntax === | ||
| + | {{syntaxbox top|nocat=true}} | ||
| + | bshields.sendChat(''msgObj'', ''message'') | ||
| + | {{syntaxbox end}} | ||
| + | |||
| + | ==== Parameters ==== | ||
| + | ;msgObj | ||
| + | :The original message object given as a parameter to a <code>chat:message</code> event's callback. | ||
| + | ;message | ||
| + | :The message to send to the chat. This can be any message you could normally send to <code>sendChat</code>, including using commands such as <code>/direct</code> | ||
| + | |||
| + | === Example === | ||
| + | <pre data-language="javascript"> | ||
| + | on('chat:message', function(msg) { | ||
| + | if (msg.type === 'api') { | ||
| + | bshields.sendChat(msg, 'I used an api command!'); | ||
| + | // If player Brian is speaking out of character, the message will be sent as Brian | ||
| + | // If player Brian is speaking as the character Barases, the message will be sent as Barases | ||
| + | } | ||
| + | }); | ||
Revision as of 16:25, 13 January 2015
API ScriptAuthor: Brian
Version: 2.0
Last Modified: 2015-01-08
Code: Interpreted sendChat
Dependencies: levenshteinDistance
Conflicts: None
Version: 2.0
Last Modified: 2015-01-08
Code: Interpreted sendChat
Dependencies: levenshteinDistance
Conflicts: None
Interpreted sendChat is designed to assist other scripts in handling message output. When a script needs to send a message to chat (normally handled with the native sendChat function) as though the message is being sent by the same player or character who triggered the chat message event, Interpreted sendChat may be used.
Syntax
bshields.sendChat(msgObj, message)
Parameters
- msgObj
- The original message object given as a parameter to a
chat:messageevent's callback. - message
- The message to send to the chat. This can be any message you could normally send to
sendChat, including using commands such as/direct
Example
on('chat:message', function(msg) {
if (msg.type === 'api') {
bshields.sendChat(msg, 'I used an api command!');
// If player Brian is speaking out of character, the message will be sent as Brian
// If player Brian is speaking as the character Barases, the message will be sent as Barases
}
});
