Difference between revisions of "HTTP API/Bot Commands/fly"

From SmartBots Developers Docs
Jump to: navigation, search
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
{{DISPLAYTITLE: get_fly}}
+
{{DISPLAYTITLE: fly}}
 
<onlyinclude>Commands the bot to fly.</onlyinclude>
 
<onlyinclude>Commands the bot to fly.</onlyinclude>
  
 
<syntaxhighlight lang="lsl">
 
<syntaxhighlight lang="lsl">
−
string params = llDumpList2String([
+
// See "LSL Helper Functions" page for this function
−
  "action=" + "fly",
+
smartbotsAPI("fly", [
−
  "apikey="  + llEscapeURL(sbApiKey),
+
   "fly", "on"
−
  "botname=" + llEscapeURL(sbBotName),
+
]);
−
   "secret=" + llEscapeURL(sbBotAccessCode)
+
−
], "&");
+
−
   
+
−
httpReq = llHTTPRequest("https://api.mysmartbots.com/api/bot.html", [HTTP_METHOD,"POST"], params);
+
 
</syntaxhighlight>
 
</syntaxhighlight>
  
Line 18: Line 14:
  
 
{{API Variable Group|Input}}
 
{{API Variable Group|Input}}
−
{{API Variable||}} command takes no input parameters
+
{{API Variable|fly|yes}} "on" to start flying<br>"off" to stop flying
  
 
{{API Variable Group|Output}}
 
{{API Variable Group|Output}}
 
{{API HTTP Standard Output}}
 
{{API HTTP Standard Output}}
−
{{API Variable|fly|}} Command the bot to fly
 
  
 
{{API Variables Table End}}
 
{{API Variables Table End}}
  
 
== Example ==
 
== Example ==
 +
Commands the bot to start flying:
 +
 +
{{API HTTP Example Boilerplate}}
 +
 +
<syntaxhighlight lang="lsl">
 +
// See "LSL Helper Functions" page for this function
 +
smartbotsAPI("fly", [
 +
  "fly", "on"
 +
]);
 +
</syntaxhighlight>
  
 
{{HTTP API Bot - standard footer}}
 
{{HTTP API Bot - standard footer}}

Latest revision as of 03:46, 5 March 2019

Commands the bot to fly. 

// See "LSL Helper Functions" page for this function
smartbotsAPI("fly", [
  "fly", "on"
]);

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 = fly
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:
fly yes "on" to start flying
"off" to stop flying
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.

Example

Commands the bot to start flying:

(the example uses smartbotsAPI() helper function. Set your "apikey", "botname" and "secret" in that function) 

// See "LSL Helper Functions" page for this function
smartbotsAPI("fly", [
  "fly", "on"
]);


<< 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/fly&oldid=1673"