parcel_eject

Ejects an avatar from the 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.

Input basic parameters

Variable

Required

Description

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

Variable

Required

Description

uuid

yes

Another avatar's UUID

ban

yes

Set to 1 to ban the avatar on the current parcel

Output

(To be received in *http_response* LSL event, see docs for details)

Variable

Description

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 must have eject permission for the current parcel. The bot must either:

  • Be the owner of the parcel, or

  • Be a member of the group with a role that includes the eject permission.