Skip to main content

PermissionService

This item only works when running on the server. Server

Provides permissions for the game. See BasePermissionProvider.

TIP

Be sure to initialize the PermissionServiceClient on the client.

Functions​

Init​

</>
PermissionService.Init(
_serviceBag: ServiceBag
) → ()

Initializes the service. Should be done via ServiceBag.

SetProviderFromConfig​

</>
PermissionService.SetProviderFromConfig(
config: {type: string}
) → ()

Start​

</>
PermissionService.Start(self: PermissionService) → ()

Starts the permission service. Should be done via ServiceBag.

PromisePermissionProvider​

</>
PermissionService.PromisePermissionProvider(self: PermissionService) → Promise<BasePermissionProvider>

Returns the permission provider

PromiseIsAdmin​

</>
PermissionService.PromiseIsAdmin(
player: Player
) → Promise<boolean>

Returns whether the player is an admin.

PromiseIsCreator​

</>
PermissionService.PromiseIsCreator(
player: Player
) → Promise<boolean>

Returns whether the player is a creator.

PromiseIsPermissionLevel​

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

Returns whether the player is a creator.

ObservePermissionedPlayersBrio​

</>
PermissionService.ObservePermissionedPlayersBrio(
permissionLevel: PermissionLevel
) → Observable<Brio<Player>>

Observe all creators in the game

Show raw api
{
    "functions": [
        {
            "name": "Init",
            "desc": "Initializes the service. Should be done via [ServiceBag].",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "PermissionService"
                },
                {
                    "name": "_serviceBag",
                    "desc": "",
                    "lua_type": "ServiceBag"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 47,
                "path": "src/permissionprovider/src/Server/PermissionService.lua"
            }
        },
        {
            "name": "SetProviderFromConfig",
            "desc": "Sets the provider from a config. See [PermissionProviderUtils.createGroupRankConfig]\nand [PermissionProviderUtils.createSingleUserConfig].",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "PermissionService"
                },
                {
                    "name": "config",
                    "desc": "",
                    "lua_type": "{ type: string }"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 62,
                "path": "src/permissionprovider/src/Server/PermissionService.lua"
            }
        },
        {
            "name": "Start",
            "desc": "Starts the permission service. Should be done via [ServiceBag].",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "PermissionService"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 81,
                "path": "src/permissionprovider/src/Server/PermissionService.lua"
            }
        },
        {
            "name": "PromisePermissionProvider",
            "desc": "Returns the permission provider",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "PermissionService\n"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<BasePermissionProvider>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 95,
                "path": "src/permissionprovider/src/Server/PermissionService.lua"
            }
        },
        {
            "name": "PromiseIsAdmin",
            "desc": "Returns whether the player is an admin.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "PermissionService"
                },
                {
                    "name": "player",
                    "desc": "",
                    "lua_type": "Player"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<boolean>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 108,
                "path": "src/permissionprovider/src/Server/PermissionService.lua"
            }
        },
        {
            "name": "PromiseIsCreator",
            "desc": "Returns whether the player is a creator.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "PermissionService"
                },
                {
                    "name": "player",
                    "desc": "",
                    "lua_type": "Player"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<boolean>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 119,
                "path": "src/permissionprovider/src/Server/PermissionService.lua"
            }
        },
        {
            "name": "PromiseIsPermissionLevel",
            "desc": "Returns whether the player is a creator.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "PermissionService"
                },
                {
                    "name": "player",
                    "desc": "",
                    "lua_type": "Player"
                },
                {
                    "name": "permissionLevel",
                    "desc": "",
                    "lua_type": "PermissionLevel"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<boolean>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 131,
                "path": "src/permissionprovider/src/Server/PermissionService.lua"
            }
        },
        {
            "name": "ObservePermissionedPlayersBrio",
            "desc": "Observe all creators in the game",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "PermissionService"
                },
                {
                    "name": "permissionLevel",
                    "desc": "",
                    "lua_type": "PermissionLevel"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<Brio<Player>>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 150,
                "path": "src/permissionprovider/src/Server/PermissionService.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "PermissionService",
    "desc": "Provides permissions for the game. See [BasePermissionProvider].\n\n:::tip\nBe sure to initialize the [PermissionServiceClient] on the client.\n:::",
    "realm": [
        "Server"
    ],
    "source": {
        "line": 12,
        "path": "src/permissionprovider/src/Server/PermissionService.lua"
    }
}