Skip to main content

PermissionServiceClient

This item only works when running on the client. Client

Provides permissions on the client. See PermissionService for more details.

tip

Be sure to initialize the PermissionService on the server.

Functions​

Init​

</>
PermissionServiceClient:Init(serviceBag: ServiceBag) → ()

Initializes the permission service on the client. Should be done via ServiceBag.

PromiseIsAdmin​

</>
PermissionServiceClient:PromiseIsAdmin(player: Player | nil) → Promise<boolean>

Returns whether the player is an admin.

PromisePermissionProvider​

</>
PermissionServiceClient:PromisePermissionProvider() → Promise<PermissionProviderClient>

Returns the permission provider

Show raw api
{
    "functions": [
        {
            "name": "Init",
            "desc": "Initializes the permission service on the client. Should be done via [ServiceBag].",
            "params": [
                {
                    "name": "serviceBag",
                    "desc": "",
                    "lua_type": "ServiceBag"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 26,
                "path": "src/permissionprovider/src/Client/PermissionServiceClient.lua"
            }
        },
        {
            "name": "PromiseIsAdmin",
            "desc": "Returns whether the player is an admin.",
            "params": [
                {
                    "name": "player",
                    "desc": "",
                    "lua_type": "Player | nil"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<boolean>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 40,
                "path": "src/permissionprovider/src/Client/PermissionServiceClient.lua"
            }
        },
        {
            "name": "PromisePermissionProvider",
            "desc": "Returns the permission provider",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<PermissionProviderClient>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 53,
                "path": "src/permissionprovider/src/Client/PermissionServiceClient.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "PermissionServiceClient",
    "desc": "Provides permissions on the client. See [PermissionService] for more details.\n\n:::tip\nBe sure to initialize the [PermissionService] on the server.\n:::",
    "realm": [
        "Client"
    ],
    "source": {
        "line": 11,
        "path": "src/permissionprovider/src/Client/PermissionServiceClient.lua"
    }
}