Skip to main content

GroupUtils

Helpful functions involving Roblox groups.

Functions​

promiseRankInGroup​

</>
GroupUtils.promiseRankInGroup(
player: Player,
groupId: number
) → Promise<number>--

Generally from 0 to 255

Retrieves the rank of the player in the group.

promiseRoleInGroup​

</>
GroupUtils.promiseRoleInGroup(
player: Player,
groupId: number
) → Promise<string>

Retrieves the role of the player in the group.

promiseGroupInfo​

</>
GroupUtils.promiseGroupInfo(groupId: number) → Promise<table>

Retrieves groupInfo about a group.

promiseGroupRoleInfo​

</>
GroupUtils.promiseGroupRoleInfo(
groupId: number,
rankId: number
) → Promise<table>

Retrieves group role info for a given rankId

Show raw api
{
    "functions": [
        {
            "name": "promiseRankInGroup",
            "desc": "Retrieves the rank of the player in the group.",
            "params": [
                {
                    "name": "player",
                    "desc": "",
                    "lua_type": "Player"
                },
                {
                    "name": "groupId",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "Generally from 0 to 255",
                    "lua_type": "Promise<number>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 21,
                "path": "src/grouputils/src/Shared/GroupUtils.lua"
            }
        },
        {
            "name": "promiseRoleInGroup",
            "desc": "Retrieves the role of the player in the group.",
            "params": [
                {
                    "name": "player",
                    "desc": "",
                    "lua_type": "Player"
                },
                {
                    "name": "groupId",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<string>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 50,
                "path": "src/grouputils/src/Shared/GroupUtils.lua"
            }
        },
        {
            "name": "promiseGroupInfo",
            "desc": "Retrieves groupInfo about a group.",
            "params": [
                {
                    "name": "groupId",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<table>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 78,
                "path": "src/grouputils/src/Shared/GroupUtils.lua"
            }
        },
        {
            "name": "promiseGroupRoleInfo",
            "desc": "Retrieves group role info for a given rankId",
            "params": [
                {
                    "name": "groupId",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "rankId",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<table>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 106,
                "path": "src/grouputils/src/Shared/GroupUtils.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "GroupUtils",
    "desc": "Helpful functions involving Roblox groups.",
    "source": {
        "line": 5,
        "path": "src/grouputils/src/Shared/GroupUtils.lua"
    }
}