Character Vault
Any Concept / Any System
Compendium
Your System Come To Life
Roll20 for Android
Streamlined for your Tablet
Roll20 for iPad
Streamlined for your Tablet

Personal tools

Script:Interpreted sendChat

From Roll20 Wiki

Revision as of 04:50, 13 April 2016 by Brian (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
API ScriptAuthor: Brian
Version: 2.2
Last Modified: 2016-03-09
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.

Contents

Syntax

bshields.sendChat(msgObj, message)

Parameters

msgObj
The original message object given as a parameter to a chat:message event'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
    }
});

Changelog

v2.2 (2016-03-09)

  • Update for one-click install


v2.1 (2015-01-13)

  • [bugfix] Fixed syntax & logical bug


v2.0 (2015-01-08)

  • Release