Revision as of 16:54, 13 January 2015

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: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
    }
});