Difference between revisions of "HTTP API/Bot Commands/bot location"
From SmartBots Developers Docs
(Created page with "{{DISPLAYTITLE: bot_location}} <onlyinclude>Returns the current location of the bot.</onlyinclude> <syntaxhighlight lang="lsl"> // See "LSL Helper Functions" page for this fu...") |
|||
| Line 12: | Line 12: | ||
{{API Variable Group|Output}} | {{API Variable Group|Output}} | ||
{{API HTTP Standard Output}} | {{API HTTP Standard Output}} | ||
| + | {{API Variable|region|}} current region | ||
| + | {{API Variable|x|}} x position within the region | ||
| + | {{API Variable|y|}} y position within the region | ||
| + | {{API Variable|z|}} z position within the region | ||
{{API Variables Table End}} | {{API Variables Table End}} | ||
Latest revision as of 11:04, 5 March 2019
Returns the current location of the bot.
// See "LSL Helper Functions" page for this function
smartbotsAPI("bot_location", []);
Variables
The following table shows input values (you send them with the API call) and returned output values.
| Variable | Required | Description | ||
|---|---|---|---|---|
| Input basic parameters: | ||||
| action | yes | = bot_location | ||
| apikey | yes | Your personal developer's API key. | ||
| botname | yes | Your bot's SL login. | ||
| secret | yes | Bot access code of your bot. | ||
| dataType | optional | Set to "json" to get JSON reply instead of URL-encoded string | ||
| custom | optional | The custom data (string) to be passed back to caller script. This value will be returned back to the caller in HTTP response. | ||
| Output: | ||||
| (to be received in http_response LSL event, see docs for details) | ||||
| result | OK - command completed successfully FAIL - command failed | |||
| resulttext | Detailed reason for the failure. | |||
| custom | The value from input "custom" parameter. See above. | |||
| region | current region | |||
| x | x position within the region | |||
| y | y position within the region | |||
| z | z position within the region | |||
Example
Returns the bot's current location:
(the example uses smartbotsAPI() helper function. Set your "apikey", "botname" and "secret" in that function)
smartbotsAPI("bot_location", []);
<< return back to Bot commands
(Miss an API call or parameter? Submit your request in forum)
