Difference between revisions of "Bot Playground/Events/autopilot completed"
From SmartBots Developers Docs
(Created page with "{{DISPLAYTITLE:autopilot_completed}} <onlyinclude>Fires when bot autopilot successfully completes its journey. {{NotAvailableForQB}}</onlyinclude> See Bot Playground/Comman...") |
|||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:autopilot_completed}} | {{DISPLAYTITLE:autopilot_completed}} | ||
<onlyinclude>Fires when bot autopilot successfully completes its journey. {{NotAvailableForQB}}</onlyinclude> | <onlyinclude>Fires when bot autopilot successfully completes its journey. {{NotAvailableForQB}}</onlyinclude> | ||
| − | |||
| − | |||
<syntaxhighlight lang="javascript"> | <syntaxhighlight lang="javascript"> | ||
Bot.on("autopilot_completed", function(event) { ... }); | Bot.on("autopilot_completed", function(event) { ... }); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| + | |||
| + | See [[Bot Playground/Commands/walkTo|Bot.walkTo()]] command for autopilot usage. | ||
{{API Event Table}} | {{API Event Table}} | ||
{{API Variable Group|''event'' object properties}} | {{API Variable Group|''event'' object properties}} | ||
| − | {{API Variable|name}}The name of the event | + | {{API Variable|name}}The name of the event |
{{API Variable|bot_name}}The name of the bot teleporting. | {{API Variable|bot_name}}The name of the bot teleporting. | ||
{{API Variable|endPoint}}Bot destination point, { X, Y, Z } | {{API Variable|endPoint}}Bot destination point, { X, Y, Z } | ||
| Line 27: | Line 27: | ||
/* | /* | ||
| − | Autopilot | + | Autopilot completed: { |
"name": "autopilot_completed", | "name": "autopilot_completed", | ||
"bot_slname": "DakotahRaine Resident", | "bot_slname": "DakotahRaine Resident", | ||
Latest revision as of 10:23, 7 December 2023
Fires when bot autopilot successfully completes its journey. Not available for QubicBot yet (?)
Bot.on("autopilot_completed", function(event) { ... });
See Bot.walkTo() command for autopilot usage.
Reference
This event comes with the following event object:
| Variable | Required | Description | |
|---|---|---|---|
| event object properties: | |||
| name | The name of the event | ||
| bot_name | The name of the bot teleporting. | ||
| endPoint | Bot destination point, { X, Y, Z } | ||
| actualPoint | Bot actual location, { X, Y, Z } | ||
Example
console.log(`${process.name} started`);
Bot.on("autopilot_completed", (event) => {
console.log(`Autopilot started: ${JSON.stringify(event, null, 2)}`);
});
/*
Autopilot completed: {
"name": "autopilot_completed",
"bot_slname": "DakotahRaine Resident",
"bot_uuid": "4f6b8999-14a0-4f50-882d-a764ee913daa",
"endPoint": {
"X": 212,
"Y": 25,
"Z": 93
},
"actualPoint": {
"X": 203.21446,
"Y": 36.776222,
"Z": 93.68485
}
}
*/
