Events

An event is a callback function that is invoked when something happens with your bot or the surrounding world.

Callbacks are set using the on() function:

Bot.on("instant_message", function(data) {
  console.log("bot got a message:", data);
});

Events Reference

Messaging

chat_message

Fires when bot receives a message in the local chat

instant_message

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

start_typing

Fires when another avatar starts typing in IM to the bot

(Not available for QubicBot yet)

stop_typing

Fires when another avatar stops typing in IM to the bot (Not available for QubicBot yet)

teleport_offer

Fires when bot receives a teleport offer from another avatar

Group Messaging

group_offer

Fires when bot receives a group invite

group_im

Fires when bot receives a group chat message

group_notice

Fires when bot receives a group notice

Inventory

inventory_offer

Fires when bot receives an inventory offer

balance_changed

Fires when bot receives or pays money

Friendship

friendship_offer

Fires when bot receives a friendship offer

Movement

autopilot_completed

Fires when bot autopilot successfully completes its journey (Not available for QubicBot yet)

autopilot_started

Fires when bot autopilot starts (Not available for QubicBot yet)

autopilot_stuck

Fires when bot autopilot gets stuck and gives up moving further (Not available for QubicBot yet)

self_position

Fires when bot in-world location, position, or heading changes (Not available for QubicBot yet)

sit

Fires when bot sits on an object

teleport_status

Fires when bot teleports, indicating various stages of the teleport (Not available for QubicBot yet)

World

avatar_tracker_update

Reports position from avatars tracked by trackAvatars command

region_restart

Fires when bot receives a region restart notification (Not available for QubicBot yet)

region_restart_cancelled

Fires when bot receives a region restart cancellation notification (Not available for QubicBot yet)

script_dialog

Fires when bot receives a scripted dialog with menu buttons

Online Status

before_login

Fires when bot is going to log in to Second Life

after_login

Fires when bot successfully logs in to Second Life

before_logout

Fires when bot is going offline

after_logout

Fires after bot goes offline (Not available for QubicBot yet)

login_error

Fires when bot is unable to log in to Second Life (Not available for QubicBot yet)

Webhooks

playground_webhook

Fires when the script’s webhook receives an HTTP request from your server