Difference between revisions of "AdminBot for LSL/Commands/SB AVATAR GROUP"

From SmartBots Developers Docs
Jump to: navigation, search
(Examples)
Line 14: Line 14:
 
== Comments ==
 
== Comments ==
  
This command fetches the groups list of a selected avatar and searches for the group name/UUID you've provided. The check result is being sent to your script using [[AdminBot Events|SB_GROUP_CHECKED]] event.
+
This command fetches the groups list of a selected avatar and searches for the group name/UUID you've provided. The check result is being sent to your script using [[AdminBot for Groups/Events|SB_GROUP_CHECKED]] event.
  
 
* You can specify either group name or group UUID.
 
* You can specify either group name or group UUID.

Revision as of 09:57, 30 June 2016

Checks if resident is a member of a specific group and returns result using SB_GROUP_CHECKED event.

You can check any group membership with this command, not only the one in-use by AdminBot.

Variables

The following table shows input values (you send them with the API call) and returned output values.

Variable Required Description


str yes Group name or UUID
id yes Avatar UUID

Comments

This command fetches the groups list of a selected avatar and searches for the group name/UUID you've provided. The check result is being sent to your script using SB_GROUP_CHECKED event.

  • You can specify either group name or group UUID.
  • You can check any group membership with this command, not only the one in-use by AdminBot.

Visibility

Only "show in profile" resident's groups can be seen with this request. It is not possible to see the groups resident intentionally hides from profile.

Delays

The command takes about 1-3 seconds to complete.

Return value

The result of this command will be returned to your script using SB_GROUP_CHECKED event:

link_message(integer sender, integer num, string str, key id) {
  ...
}

Where:

sender link number of a sender prim
num SB_GROUP_CHECKED
str 0 - avatar is not in this group

1 - avatar is in group

id avatar UUID

Examples

See SB_AVATAR_GROUP example for LSL code.