Difference between revisions of "Bot Playground/Commands/activateGroup"
From SmartBots Developers Docs
(Created page with "{{DISPLAYTITLE:{{SUBPAGENAME}}}} <onlyinclude>Activates a specific group (for example, to get build rights on the parcel).</onlyinclude> <syntaxhighlight lang="javascript"> B...") |
|||
| Line 3: | Line 3: | ||
<syntaxhighlight lang="javascript"> | <syntaxhighlight lang="javascript"> | ||
| − | Bot.activateGroup( | + | Bot.activateGroup(groupuuid); |
</syntaxhighlight> | </syntaxhighlight> | ||
Latest revision as of 19:54, 2 July 2016
Activates a specific group (for example, to get build rights on the parcel).
Bot.activateGroup(groupuuid);
Reference
This command accepts the following parameters:
| Variable | Required | Description
| |
|---|---|---|---|
| Input: | |||
| groupuuid | yes | the UUID of the group to activate
Special values:
Obliviously, the bot has to be a member of the group already to activate it. | |
| Output: | |||
| Function returns a Promise with the following data: | |||
| success | bool | true if command completed successfully | |
| error | string | error string if command has failed | |
Examples
1. Set the active group to match current parcel's group. This can be used to get rights to rez items.
Bot.activateGroup("LAND");
2. Remove active group from the bot (sets the active group to none):
Bot.activateGroup("00000000-0000-0000-0000-000000000000");