Skip to main content

PermissionProviderUtils

This item only works when running on the server. Server

Utility functions to provide/configure a permission. See BasePermissionProvider and PermissionService.

Functions​

createGroupRankConfig​

</>
PermissionProviderUtils.createGroupRankConfig(config: {
groupId: number,
minAdminRequiredRank: number,
minCreatorRequiredRank: number
}) → table

Creates a group rank config

createSingleUserConfig​

</>
PermissionProviderUtils.createSingleUserConfig(config: {userId: number}) → table

Creates a single user config

createConfigFromGame​

</>
PermissionProviderUtils.createConfigFromGame() → table

Creates an automatic configuration from the game.

Show raw api
{
    "functions": [
        {
            "name": "createGroupRankConfig",
            "desc": "Creates a group rank config",
            "params": [
                {
                    "name": "config",
                    "desc": "",
                    "lua_type": "{ groupId: number, minAdminRequiredRank: number, minCreatorRequiredRank: number }"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "table"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 19,
                "path": "src/permissionprovider/src/Server/PermissionProviderUtils.lua"
            }
        },
        {
            "name": "createSingleUserConfig",
            "desc": "Creates a single user config",
            "params": [
                {
                    "name": "config",
                    "desc": "",
                    "lua_type": "{ userId: number }"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "table"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 38,
                "path": "src/permissionprovider/src/Server/PermissionProviderUtils.lua"
            }
        },
        {
            "name": "createConfigFromGame",
            "desc": "Creates an automatic configuration from the game.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "table"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 52,
                "path": "src/permissionprovider/src/Server/PermissionProviderUtils.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "PermissionProviderUtils",
    "desc": "Utility functions to provide/configure a permission. See [BasePermissionProvider] and [PermissionService].",
    "realm": [
        "Server"
    ],
    "source": {
        "line": 7,
        "path": "src/permissionprovider/src/Server/PermissionProviderUtils.lua"
    }
}