Difference between revisions of "Bot Playground/Events/instant message"

From SmartBots Developers Docs
Jump to: navigation, search
Line 4: Line 4:
 
{{API Event Table}}
 
{{API Event Table}}
 
{{API Variable Group|Output}}
 
{{API Variable Group|Output}}
 +
{{API Variable|name}}The name of the event in this case instant_message
 +
{{API Variable|speaker_type}}The sender of the message. Can be AVATAR or OBJECT
 +
{{API Variable|speaker_name}}The name of the sender
 +
{{API Variable|speaker_uuid}}The UUID of the sender
 
{{API Variable|message}}The text of the message
 
{{API Variable|message}}The text of the message
  

Revision as of 02:31, 1 July 2016

Fires when bot receives a message from another avatar or in-world object.

Reference

This event comes with the following event object:

Variable Required Description
Output:
name The name of the event in this case instant_message
speaker_type The sender of the message. Can be AVATAR or OBJECT
speaker_name The name of the sender
speaker_uuid The UUID of the sender
message The text of the message

Example

Bot.on("instant_message", function(event) {
	console.log(event.speaker_name + " says: \n" + event.message);
});

console.log("Bot is listening, IM something");