Difference between revisions of "Bot Playground/Commands/statusExt"
From SmartBots Developers Docs
(Created page with "{{DISPLAYTITLE:{{SUBPAGENAME}}}} <onlyinclude>Returns the online status of the bot.</onlyinclude> <syntaxhighlight lang="javascript"> const res = await Bot.statusExt(); conso...") |
|||
| (One intermediate revision by the same user not shown) | |||
| Line 25: | Line 25: | ||
{ | { | ||
// Bot name | // Bot name | ||
| − | " | + | "name": "Fashion Firethorn", |
| + | // Bot UUID | ||
| + | "UUID": "fc417c00-71ae-4427-a9dd-eed32a3e49de" | ||
// = Connection status | // = Connection status | ||
// Is bot online | // Is bot online | ||
| − | " | + | "online": true, |
// Is bot connecting to Second Life right now | // Is bot connecting to Second Life right now | ||
| − | " | + | "connecting": false, |
// In-world status | // In-world status | ||
// Avatar position | // Avatar position | ||
| − | " | + | "position": { |
"Z": 33.377563, | "Z": 33.377563, | ||
"X": 234.81233, | "X": 234.81233, | ||
| Line 41: | Line 43: | ||
}, | }, | ||
// Avatar heading (the view direction), radians | // Avatar heading (the view direction), radians | ||
| − | " | + | "heading": -3.0020456, |
// Current region (sim) name | // Current region (sim) name | ||
| − | " | + | "regionName": "DuoLife", |
// Current region ID | // Current region ID | ||
| − | " | + | "regionHandle": 849922488517376, |
// Current parcel name | // Current parcel name | ||
| − | " | + | "parcelName": "SmartBots: Second Life bots for L$79 / Inviter bot + notices", |
// Current parcel ID | // Current parcel ID | ||
| − | " | + | "parcelID": 150, |
| − | " | + | // Bot OS version |
| + | "version": "91.00.00" | ||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Latest revision as of 14:28, 18 October 2022
Returns the online status of the bot.
const res = await Bot.statusExt();
console.log("Status:", JSON.stringify(res, null, 2));
Reference
This command accepts the following parameters:
| Variable | Required | Description
| |
|---|---|---|---|
| Input: | |||
| Output: | |||
| Function returns a Promise with the following data: | |||
| success | bool | true if command completed successfully | |
| error | string | error string if command has failed | |
| status | An object which contains various information about bot status. See Details below. | ||
Details
The 'status' field of the response provides a lot of information on bot status:
{
// Bot name
"name": "Fashion Firethorn",
// Bot UUID
"UUID": "fc417c00-71ae-4427-a9dd-eed32a3e49de"
// = Connection status
// Is bot online
"online": true,
// Is bot connecting to Second Life right now
"connecting": false,
// In-world status
// Avatar position
"position": {
"Z": 33.377563,
"X": 234.81233,
"Y": 111.23107
},
// Avatar heading (the view direction), radians
"heading": -3.0020456,
// Current region (sim) name
"regionName": "DuoLife",
// Current region ID
"regionHandle": 849922488517376,
// Current parcel name
"parcelName": "SmartBots: Second Life bots for L$79 / Inviter bot + notices",
// Current parcel ID
"parcelID": 150,
// Bot OS version
"version": "91.00.00"
}
