# sim_return

Returns objects of the specific resident from the sim.

```csharp
// See "LSL Helper Functions" page for this function
smartbotsAPI("sim_return", ["avatar", UUID, "scripted", TRUE]);
```

```snippet http-api-variables-OmJyUigTgO
```

```snippet http-api-input-basic-parameters-5FcVlaJbq0 action="sim_return"
```

```snippet http-api-input-q5yvAagqsZ
avatar      | yes      | the UUID of the avatar
scripted    | optional | Set to TRUE (or 1) to return scripted object only
others      | optional | Set to TRUE (or 1) to return objects on others land
all_estates | optional | Set to TRUE (or 1) to return on all estates available for bot
```

```snippet http-api-output-JAwUcmg7i7
```

# Comments

* You have to teleport to the region first.
* To execute this function your bot needs to be an [Estate Manager](http://wiki.secondlife.com/wiki/Estate_Manager).
* You **don't** need a "Sim Governor" add-on to use this function.

# Examples

Teleport to DuoLife region and return all objects of BartenderJoe:

```csharp
// You need to adjust the vars below:
string sbApiKey = "...";
string sbBotName = "...";
string sbBotApiToken = "...";

string myHome = "DuoLife/128/128/20";

// First, teleport to the desired region

string params = llDumpList2String([
  "action="  + "teleport",
  "location=" + llEscapeURL(myHome),
  "apikey="  + llEscapeURL(sbApiKey),
  "botname=" + llEscapeURL(sbBotName),
  "secret="  + llEscapeURL(sbBotApiToken)
  ], "&");
 
llHTTPRequest("https://api.mysmartbots.com/api/bot.html",
  [HTTP_METHOD,"POST"], params);

// Now return avatar's objects, only the scripted ones

params = llDumpList2String([
  "action="  + "sim_return",
  "avatar=" + "bc3af7d6-f089-4b57-b78e-473334af01cb",
  "scripted=" + "1"
  ], "&");
 
llHTTPRequest("https://api.mysmartbots.com/api/bot.html",
  [HTTP_METHOD,"POST"], params);
```