parcel_eject
From SmartBots Developers Docs
Revision as of 18:40, 2 September 2020 by Gg (Talk | contribs) (Created page with "{{DISPLAYTITLE: parcel_eject}} <onlyinclude>Ejects avatar from bot's current parcel</onlyinclude> <syntaxhighlight lang="lsl"> // See "LSL Helper Functions" page for this fun...")
Ejects avatar from bot's current parcel
// See "LSL Helper Functions" page for this function
smartbotsAPI("parcel_eject", [
"uuid", "417732f0-a100-4e2d-a9bf-e381cfd12c3a",
"ban", 1
]);
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 | = parcel_eject | ||
| 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: | ||||
| uuid | yes | another avatar's UUID | ||
| ban | yes | set to 1 to ban avatar on current parcel | ||
| 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. | |||
Permissions
The bot has to have an eject permission for current parcel:
- be the owner of the parcel
- be a member of the group with a role with a permission
<< return back to Bot commands
(Miss an API call or parameter? Submit your request in forum)
