Difference between revisions of "Bot Playground/Events/teleport status"

From SmartBots Developers Docs
Jump to: navigation, search
 
Line 1: Line 1:
 
{{DISPLAYTITLE:teleport_status}}
 
{{DISPLAYTITLE:teleport_status}}
<onlyinclude>Fires when bot starts teleporting. {{NotAvailableForQB}}</onlyinclude>
+
<onlyinclude>Fires when bot teleports, indicating various stages of the teleport. {{NotAvailableForQB}}</onlyinclude>
  
 
<syntaxhighlight lang="javascript">
 
<syntaxhighlight lang="javascript">

Latest revision as of 08:30, 12 October 2022

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

Bot.on("teleport_status", 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 teleport_status
bot_name The name of the bot teleporting.
message The status message of the teleport
status The status of the teleport. (Start/Progress/Finished)
bot_uuid The UUID of the bot teleporting.
location The current location of the bot.

Example

console.log(`${process.name} started`);

Bot.on("teleport_status", (event) => {
    console.log(`teleport status event: `, event);
});