region_info

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.

Input basic parameters

Variable

Required

Description

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

Variable

Required

Description

name

optional

The name of the sim

Output

(To be received in http_response LSL event, see docs for details)

Variable

Description

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

Region handle


Examples

Get info for a specific sim

action=region_info&name=DuoLife

Sample response:

{
  "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"
}