Difference between revisions of "Bot Playground/Commands/statusExt"

From SmartBots Developers Docs
Jump to: navigation, search
(Created page with "{{DISPLAYTITLE:{{SUBPAGENAME}}}} <onlyinclude>Returns the online status of the bot.</onlyinclude> <syntaxhighlight lang="javascript"> const res = await Bot.statusExt(); conso...")
 
Line 41: Line 41:
 
},
 
},
 
// Avatar heading (the view direction), radians
 
// Avatar heading (the view direction), radians
"Heading": -3.0020456
+
"Heading": -3.0020456,
  
 
// Current region (sim) name
 
// Current region (sim) name
Line 52: Line 52:
 
"ParcelID": 150,
 
"ParcelID": 150,
  
"Version": "91.00.00",
+
// Bot OS version
 +
"Version": "91.00.00"
 
}
 
}
 
</syntaxhighlight>
 
</syntaxhighlight>

Revision as of 14:04, 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",

	// = 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"
}