chat_message

From SmartBots Developers Docs
Jump to: navigation, search

Fires when bot receives a message in the local chat

Bot.on("chat_message", function(event) { ... });

Reference

This event comes with the following event object:

Variable Required Description
event object properties:
name The name of the event
speaker_type The sender of the message. Can be AGENT or OBJECT
speaker_name The name of the sender
speaker_uuid The UUID of the sender
speaker_owner The UUID of the owner of the sender object.
message The text of the message
chat_type One of the following: Normal, Whisper, Shout, OwnerSay
own_message If this message has been said by the bot itself

Important note

Bot DOES hear what it says, so you will get a chat_message event when bot says something in local chat.

Make sure to ignore bot's own messages (especially for auto-responders)! See the example below.

Example

Bot.on("chat_message", function(event) {
	// Ignore own messages
	if(event.own_message) { return; }

	console.log(event.speaker_name + " says: \n" + event.message);
});

console.log("Bot is listening for local chat");