PcoWSkbVqDnWTu_dm2ix
We use cookies on this site to enhance your user experience
Collapse Sidebar

GroupService

Show deprecated

GroupService

Show deprecated

GroupService is a service that allows developers to fetch information about a Roblox group from within a game.

Basic information on the group, including it’s name, description, owner, roles and emblem can be fetched using GroupService/GetGroupInfoAsync. Lists of a group’s allies and enemies can be fetched using GroupService/GetAlliesAsync and GroupService/GetEnemiesAsync.

GroupService can also be used to fetch a list of group’s a player is a member of, using GroupService/GetGroupsAsync. Note, developers wishing to verify if a player is in a group should use the Player Player/IsInGroup function rather than GroupService/GetGroupsAsync.

The service has a number of useful applications, such as detecting if a player is an ally or enemy upon joining the game.

Properties

Functions

Instance

GetAlliesAsync ( int64 groupId )

[Yields]

Returns a StandardPages object including information on all of the specified group’s allies.

Instance

GetEnemiesAsync ( int64 groupId )

[Yields]

Returns a StandardPages object including information on all of the specified group’s enemies.

Variant

GetGroupInfoAsync ( int64 groupId )

[Yields]

Returns a table containing information about the given group.

Array

GetGroupsAsync ( int64 userId )

[Yields]

Returns a list of tables containing information on all of the groups a given player is a member of

Events