Difference between revisions of "HTTP API/Bot Commands/sim restart"
From SmartBots Developers Docs
| (One intermediate revision by the same user not shown) | |||
| Line 15: | Line 15: | ||
* begin - begin restarting current sim (the restart occurs in 120 seconds) | * begin - begin restarting current sim (the restart occurs in 120 seconds) | ||
* cancel - stop restarting sim | * cancel - stop restarting sim | ||
| + | |||
| + | {{API Variable|delay|no}} optional delay before restart, seconds. Default 120, minimum 30, maximum 240. | ||
{{API Variable Group|Output}} | {{API Variable Group|Output}} | ||
| Line 48: | Line 50: | ||
], "&"); | ], "&"); | ||
| − | llHTTPRequest(" | + | llHTTPRequest("https://api.mysmartbots.com/api/bot.html", |
[HTTP_METHOD,"POST"], params); | [HTTP_METHOD,"POST"], params); | ||
| Line 61: | Line 63: | ||
], "&"); | ], "&"); | ||
| − | llHTTPRequest(" | + | llHTTPRequest("https://api.mysmartbots.com/api/bot.html", |
[HTTP_METHOD,"POST"], params); | [HTTP_METHOD,"POST"], params); | ||
Latest revision as of 17:44, 6 October 2022
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:
| ||
| delay | optional | optional delay before restart, seconds. Default 120, minimum 30, maximum 240. | ||
| 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" bot add-on 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("https://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("https://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)
