move
From SmartBots Developers Docs
Revision as of 15:46, 29 June 2016 by Phil (Talk | contribs) (Created page with "{{DISPLAYTITLE: move}} <onlyinclude>Start or stop bot movement and rotations.</onlyinclude> {{API Variables Table}} {{API HTTP Required Vars|move}} {{API Variable Group|Inp...")
Start or stop bot movement and rotations.
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 | = move | ||
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: | ||||
instruction | yes | The movement instruction. One of the following:
| ||
param1 | yes | value which controls the "instruction" completion:
(this value is ignored for STOP instruction) | ||
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. |
Examples
Bot starts moving forward:
action=move&instruction=FORWARD¶m1=START
Bot stops moving forward:
action=move&instruction=FORWARD¶m1=STOP
Bot stops all movements and turns:
action=move&instruction=STOP
<< return back to Bot commands
(Miss an API call or parameter? Submit your request in forum)