instant_message
From SmartBots Developers Docs
Revision as of 14:14, 22 September 2025 by Gtaskincentral (Talk | contribs) (Add note about speaker distance appearing NULL when only just appeared.)
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 | ||
| speaker_distance | The distance to the sender in metres (works only for speaker_type of AVATAR) | ||
| speaker_x | The x position in region of the sender (works only for speaker_type of AVATAR) | ||
| speaker_y | The y position in region of the sender (works only for speaker_type of AVATAR) | ||
| speaker_z | The z position in region of the sender (works only for speaker_type of AVATAR) | ||
| message | The text of the message | ||
Speaker distance and coordinates
This event also returns speaker_distance, speaker_x, speaker_y, speaker_z so that you can determine their position. It is important to note that these parameters may return NULL if the bot or speaking avatar has only just appeared in-world.
Example
Bot.on("instant_message", function(event) {
console.log(event.speaker_name + " says: \n" + event.message);
});
console.log("Bot is listening, IM something");
