Difference between revisions of "HTTP API/Bot Commands/fly"
From SmartBots Developers Docs
| Line 1: | Line 1: | ||
| − | {{DISPLAYTITLE: | + | {{DISPLAYTITLE: fly}} |
<onlyinclude>Commands the bot to fly.</onlyinclude> | <onlyinclude>Commands the bot to fly.</onlyinclude> | ||
<syntaxhighlight lang="lsl"> | <syntaxhighlight lang="lsl"> | ||
| − | + | // See "LSL Helper Functions" page for this function | |
| − | + | smartbotsAPI("fly", [ | |
| − | + | "fly", "on" | |
| − | + | ]); | |
| − | " | + | |
| − | + | ||
| − | + | ||
| − | + | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 26: | Line 22: | ||
== 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)
