Difference between revisions of "HTTP API/Bot Commands/sim restart"

From SmartBots Developers Docs
Jump to: navigation, search
Line 1: Line 1:
−
{{DISPLAYTITLE: simrestart}}
+
{{DISPLAYTITLE: sim_restart}}
 
<onlyinclude>Begins the sim restart routine. Also used to cancel the restart routine previously started.</onlyinclude>
 
<onlyinclude>Begins the sim restart routine. Also used to cancel the restart routine previously started.</onlyinclude>
  
 
<syntaxhighlight lang="lsl">
 
<syntaxhighlight lang="lsl">
−
smartbotsAPI("simrestart", ["state", "begin"]); // See "LSL Helper Functions" page for this function
+
smartbotsAPI("sim_restart", ["state", "begin"]); // See "LSL Helper Functions" page for this function
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
{{API Variables Table}}
 
{{API Variables Table}}
  
−
{{API HTTP Required Vars|simrestart}}
+
{{API HTTP Required Vars|sim_restart}}
  
 
{{API Variable Group|Input}}
 
{{API Variable Group|Input}}
Line 53: Line 53:
 
// Then restart it:
 
// Then restart it:
 
params = llDumpList2String([
 
params = llDumpList2String([
−
   "action="  + "simrestart",
+
   "action="  + "sim_restart",
 
   "state=" + "begin",
 
   "state=" + "begin",
 
   "location=" + llEscapeURL(myHome),
 
   "location=" + llEscapeURL(myHome),

Revision as of 14:23, 9 June 2017

Begins the sim restart routine. Also used to cancel the restart routine previously started. 

smartbotsAPI("sim_restart", ["state", "begin"]); // See "LSL Helper Functions" page for this function

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 = sim_restart
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:
state yes The restart state:
  • begin - begin restarting current sim (the restart occurs in 120 seconds)
  • cancel - stop restarting 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.

Comments

  • You have to teleport bot 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 module to use this function.

Examples

Teleport to DuoLife region and restart it (well, at least try!): 

// 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)
  ], "&");
 
llHTTPRequest("http://api.mysmartbots.com/api/bot.html",
  [HTTP_METHOD,"POST"], params);

// Then restart it:
params = llDumpList2String([
  "action="  + "sim_restart",
  "state=" + "begin",
  "location=" + llEscapeURL(myHome),
  "apikey="  + llEscapeURL(sbApiKey),
  "botname=" + llEscapeURL(sbBotName),
  "secret="  + llEscapeURL(sbBotAccessCode)
  ], "&");
 
llHTTPRequest("http://api.mysmartbots.com/api/bot.html",
  [HTTP_METHOD,"POST"], params);


<< return back to Bot commands

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


Retrieved from "https://www.mysmartbots.com/dev/docs/index.php?title=HTTP_API/Bot_Commands/sim_restart&oldid=1354"