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

From SmartBots Developers Docs
Jump to: navigation, search
 
Line 12: Line 12:
 
{{API Variable|speaker_name}}The name of the sender
 
{{API Variable|speaker_name}}The name of the sender
 
{{API Variable|speaker_uuid}}The UUID of the sender
 
{{API Variable|speaker_uuid}}The UUID of the sender
 +
{{API Variable|object_uuid}}The UUID of the object
 
{{API Variable|message}}The text of the message
 
{{API Variable|message}}The text of the message
  

Latest revision as of 07:44, 5 August 2025

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

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

Reference

This event comes with the following event object:

Variable Required Description
event object properties:
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
object_uuid The UUID of the object
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");