Skip to main content

GroupPermissionProvider

This item only works when running on the server. Server

Provides permissions from a group

Functions​

new​

</>
GroupPermissionProvider.new(config: table) → GroupPermissionProvider

Start​

</>
GroupPermissionProvider:Start() → ()

Starts the permission provider. Should be done via ServiceBag.

PromiseIsPermissionLevel​

</>
GroupPermissionProvider:PromiseIsPermissionLevel(
player: Player,
permissionLevel: PermissionLevel
) → Promise<boolean>

Returns whether the player is at a specific permission level

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "",
            "params": [
                {
                    "name": "config",
                    "desc": "",
                    "lua_type": "table"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "GroupPermissionProvider"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 27,
                "path": "src/permissionprovider/src/Server/Providers/GroupPermissionProvider.lua"
            }
        },
        {
            "name": "Start",
            "desc": "Starts the permission provider. Should be done via ServiceBag.",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 43,
                "path": "src/permissionprovider/src/Server/Providers/GroupPermissionProvider.lua"
            }
        },
        {
            "name": "PromiseIsPermissionLevel",
            "desc": "Returns whether the player is at a specific permission level",
            "params": [
                {
                    "name": "player",
                    "desc": "",
                    "lua_type": "Player"
                },
                {
                    "name": "permissionLevel",
                    "desc": "",
                    "lua_type": "PermissionLevel"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<boolean>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 79,
                "path": "src/permissionprovider/src/Server/Providers/GroupPermissionProvider.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "GroupPermissionProvider",
    "desc": "Provides permissions from a group",
    "realm": [
        "Server"
    ],
    "source": {
        "line": 7,
        "path": "src/permissionprovider/src/Server/Providers/GroupPermissionProvider.lua"
    }
}