activate_group

From SmartBots Developers Docs
HTTP APIBot Commands
Revision as of 15:14, 29 June 2016 by Phil (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Activates a specific group (for example, to get build rights on the parcel).

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 = activate_group
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:
groupuuid yes the UUID of the group to activate

Special values:

  • LAND - set the group to the current parcel's group (see examples)
  • 00000000-0000-0000-0000-000000000000 - remove active group

Obliviously, the bot has to be a member of the group already to activate it.

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

1. Set the active group to match current parcel's group. This can be used to get rights to rez items.

action=setgroup&groupuuid=LAND

2. Remove active group from the bot (sets the active group to none):

action=setgroup&groupuuid=00000000-0000-0000-0000-000000000000



<< return back to Bot commands

(Miss an API call or parameter? Submit your request in forum)