Skip to main content

Auth

Functions​

userRoleAdd​

</>
Auth.userRoleAdd(
userId: number,
role: Role,
persist: boolean?
) → boolean

Adds a role to a user if they don't already have it

userRoleRemove​

</>
Auth.userRoleRemove(
userId: number,
role: Role
) → boolean

Removes a role from a user if it exists

getRank​

</>
Auth.getRank(
userId: number,
permission: string?
) → (
number,
Role
)

Checks the maximum role rank of the user, if permission is given it will fetch the highest rank of the roles with that permission

roleCanUseArgument​

</>
Auth.roleCanUseArgument(
role: Role,
argument: any
) → boolean

Checks if a role has access to a command

hasArgument​

</>
Auth.hasArgument(
userId: number,
argument: any
) → boolean

Checks if a user has access to a command

roleCanUseCommand​

</>
Auth.roleCanUseCommand(
role: Role,
command: any
) → boolean

Checks if a role has access to a command

hasCommand​

</>
Auth.hasCommand(
userId: number,
command: any
) → boolean

Checks if a user has access to a command

hasPermission​

</>
Auth.hasPermission(
userId: number,
permission: string
) → boolean

Checks if a user has access to a permission

rankDiff​

</>
Auth.rankDiff(
userIdFrom: number,
userIdTo: number,
permission: string?
) → ()

Gets the difference of two users' ranks, with an optional permission parameter

Show raw api
{
    "functions": [
        {
            "name": "userRoleAdd",
            "desc": "Adds a role to a user if they don't already have it",
            "params": [
                {
                    "name": "userId",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "role",
                    "desc": "",
                    "lua_type": "Role"
                },
                {
                    "name": "persist",
                    "desc": "",
                    "lua_type": "boolean?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 162,
                "path": "src/Auth.luau"
            }
        },
        {
            "name": "userRoleRemove",
            "desc": "Removes a role from a user if it exists",
            "params": [
                {
                    "name": "userId",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "role",
                    "desc": "",
                    "lua_type": "Role"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 212,
                "path": "src/Auth.luau"
            }
        },
        {
            "name": "getRank",
            "desc": "Checks the maximum role rank of the user, if permission is given it will fetch the highest rank of the roles with that permission",
            "params": [
                {
                    "name": "userId",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "permission",
                    "desc": "",
                    "lua_type": "string?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "desc": "",
                    "lua_type": "Role"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 373,
                "path": "src/Auth.luau"
            }
        },
        {
            "name": "roleCanUseArgument",
            "desc": "Checks if a role has access to a command",
            "params": [
                {
                    "name": "role",
                    "desc": "",
                    "lua_type": "Role"
                },
                {
                    "name": "argument",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 389,
                "path": "src/Auth.luau"
            }
        },
        {
            "name": "hasArgument",
            "desc": "Checks if a user has access to a command",
            "params": [
                {
                    "name": "userId",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "argument",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 414,
                "path": "src/Auth.luau"
            }
        },
        {
            "name": "roleCanUseCommand",
            "desc": "Checks if a role has access to a command",
            "params": [
                {
                    "name": "role",
                    "desc": "",
                    "lua_type": "Role"
                },
                {
                    "name": "command",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 439,
                "path": "src/Auth.luau"
            }
        },
        {
            "name": "hasCommand",
            "desc": "Checks if a user has access to a command",
            "params": [
                {
                    "name": "userId",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "command",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 494,
                "path": "src/Auth.luau"
            }
        },
        {
            "name": "hasPermission",
            "desc": "Checks if a user has access to a permission",
            "params": [
                {
                    "name": "userId",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "permission",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 539,
                "path": "src/Auth.luau"
            }
        },
        {
            "name": "rankDiff",
            "desc": "Gets the difference of two users' ranks, with an optional permission parameter",
            "params": [
                {
                    "name": "userIdFrom",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "userIdTo",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "permission",
                    "desc": "",
                    "lua_type": "string?"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 560,
                "path": "src/Auth.luau"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "Auth",
    "desc": "",
    "source": {
        "line": 14,
        "path": "src/Auth.luau"
    }
}