View source for Bot Playground/Events/chat message

{{DISPLAYTITLE:chat_message}}
<onlyinclude>Fires when bot receives a message in the local chat</onlyinclude>

<syntaxhighlight lang="javascript">
Bot.on("chat_message", function(event) { ... });
</syntaxhighlight>

{{API Event Table}}
{{API Variable Group|''event'' object properties}}
{{API Variable|name}}The name of the event in this case chat_message
{{API Variable|speaker_type}}The sender of the message. Can be AGENT or OBJECT
{{API Variable|speaker_name}}The name of the sender
{{API Variable|speaker_uuid}}The UUID of the sender
{{API Variable|speaker_owner}}The UUID of the owner of the sender object.
{{API Variable|message}}The text of the message
{{API Variable|chat_type}}One of the following: Normal, Whisper, Shout, OwnerSay
{{API Variable|own_message}}If this message has been said by bot itself.

{{API Variables Table End}}

== 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 ==

<syntaxhighlight lang="javascript">
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, local chat");
</syntaxhighlight>

{{NavMenu}}