command_name
From SmartBots Developers Docs
Gets the region info of a sim.
// See "LSL Helper Functions" page for this function
smartbotsAPI("region_info", ["name", "DuoLife"]);
// or for the current sim
smartbotsAPI("region_info", []);
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 | = region_info | ||
| 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. | ||
| Input: | ||||
| name | optional | The name of the sim | ||
| 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_name | The name of the region. | |||
| region_water_height | The water height of the region. | |||
| region_x | The x co-ordinate of the sim. | |||
| region_y | The y co-ordinate of the sim. | |||
| region_image | The image uuid of the sim. | |||
| region_handle | ||||
Examples
Examples go here:
action=region_info&name=DuoLife
{
"action": "OK",
"region_name": "DuoLife",
"region_water_height": "0",
"region_x": "773",
"region_y": "963",
"region_image": "b4c2f235-8625-0238-203e-15bf3a19dab7",
"region_handle": "849922488517376"
}
<< return back to Bot commands
(Miss an API call or parameter? Submit your request in forum)
