Difference between revisions of "Bot Playground/Commands/setGroupRole"

Revision as of 14:31, 31 October 2016

Puts member of a group in a specific role.

Bot.setGroupRole(avatar_uuid, group_uuid, role_uuid);

This command accepts the following parameters:

Variable		Required	Description
Input:
	avatar_uuid	yes	The UUID of the avatar which should be moved to the specific role
	group_uuid	yes	The UUID of the group
	role_uuid	yes	The UUID of the group role. "Everyone" role is 00000000-0000-0000-0000-000000000000
Output:
	Function returns a Promise with the following data:
	success	bool	true if command completed successfully
	error	string	error string if command has failed

@@ Line 3: / Line 3: @@
 <syntaxhighlight lang="javascript">
-Bot.setGroupRole(location);
+Bot.setGroupRole(avatar_uuid, group_uuid, role_uuid);
 </syntaxhighlight>
@@ Line 10: / Line 10: @@
 {{API Variable Group|Input}}
-{{API Variable|groupuuid|yes}} The UUID of the group
+{{API Variable|avatar_uuid|yes}} The UUID of the avatar which should be moved to the specific role
-{{API Variable|roleuuid|yes}} The UUID of the group role. "Everyone" role is 00000000-0000-0000-0000-000000000000
+{{API Variable|group_uuid|yes}} The UUID of the group
-{{API Variable|member|yes}} The UUID of the avatar which should be moved to the specific role
+{{API Variable|role_uuid|yes}} The UUID of the group role. "Everyone" role is 00000000-0000-0000-0000-000000000000
 {{API Variable Group|Output}}