From SmartBots Developers Docs
Jump to: navigation, search

Returns objects of the specific resident from the sim.

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


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 = sim_return
apikey yes Your personal developer's API key.
botname yes Your bot's SL login.
secret yes Bot access code of your bot.
dataType no Set to "json" to get JSON reply instead of URL-encoded string
custom no The custom data (string) to be passed back to caller script. This value will be returned back to the caller in HTTP response.
avatar yes the UUID of the avatar
scripted no Set to TRUE (or 1) to return scripted object only
others no Set to TRUE (or 1) to return objects on others land
all_estates no Set to TRUE (or 1) to return on all estates available for bot
result OK - command completed successfully
FAIL - command failed
resulttext Detailed reason for the failure.
custom The value from input "custom" parameter. See above.


  • You have to teleport to the region first.
  • To execute this function your bot needs to be an Estate Manager.
  • You don't need a "Sim Governor" add-on to use this function.


Teleport to DuoLife region and return all objects of BartenderJoe:

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

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(sbBotAccessCode)
  ], "&");
  [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"
  ], "&");
  [HTTP_METHOD,"POST"], params);

<< return back to Bot commands

(Miss an API call or parameter? Submit your request in forum)