View source for Bot Playground/Events/autopilot started

{{DISPLAYTITLE:autopilot_started}}
<onlyinclude>Fires when bot autopilot starts. {{NotAvailableForQB}}</onlyinclude>

<syntaxhighlight lang="javascript">
Bot.on("autopilot_started", function(event) { ... });
</syntaxhighlight>

See [[Bot Playground/Commands/walkTo|Bot.walkTo()]] command for autopilot usage.

{{API Event Table}}
{{API Variable Group|''event'' object properties}}
{{API Variable|name}}The name of the event
{{API Variable|bot_name}}The name of the bot teleporting.
{{API Variable|currentPoint}}Bot current location, { X, Y, Z }
{{API Variable|endPoint}}Bot destination point, { X, Y, Z }

{{API Variables Table End}}

== Example ==

<syntaxhighlight lang="javascript">
console.log(`${process.name} started`);

Bot.on("autopilot_started", (event) => {
	console.log(`Autopilot started: ${JSON.stringify(event, null, 2)}`);
});

/*
Autopilot started: {
  "name": "autopilot_started",
  "bot_slname": "DakotahRaine Resident",
  "bot_uuid": "4f6b8999-14a0-4f50-882d-a764ee913daa",
  "endPoint": {
    "X": 212,
    "Y": 25,
    "Z": 93
  },
  "currentPoint": {
    "X": 203.21446,
    "Y": 36.776222,
    "Z": 93.68485
  }
}
*/

</syntaxhighlight>

{{NavMenu}}