Skip to main content

CmdrClient

This item only works when running on the client. Client

Functions

PromiseCmdr

CmdrClient:PromiseCmdr() → Promise

Returns a promise that resolves with the Cmdr instance. https://eryn.io/Cmdr/api/CmdrClient.html return Promise

HasPermission

CmdrClient:HasPermission(
commandNamestring--

The name of the command to check

) → boolean

Checks if a player has permission to run a command

ExecuteCommand

CmdrClient:ExecuteCommand(...string) → Promise<string>

Executes a command

CmdrService:ExecuteCommand("blink")

GetPermissions

CmdrClient:GetPermissions() → {any}

Gets the permissions for the local player Does not return permissions granted from groups

GetGroupRankPermissions

CmdrClient:GetGroupRankPermissions(
groupIdnumber,--

The Roblox group id to get permissions for

ranknumber--

The rank to get permissions for

) → {string}--

The permissions granted to the rank

Gets the permissions granted to a particular rank in a group

local permissions = CmdrService:GetGroupRankPermissions(15905255, 230)

GetPermissionInheritance

CmdrClient:GetPermissionInheritance(permissionGroupstring) → {string}

Fetches the inherited permission group for a permission group

Show raw api
{
    "functions": [
        {
            "name": "PromiseCmdr",
            "desc": "Returns a promise that resolves with the Cmdr instance.\nhttps://eryn.io/Cmdr/api/CmdrClient.html\nreturn Promise<Cmdr>",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise\r\n"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 47,
                "path": "lib/cmdrhandler/src/Client/init.luau"
            }
        },
        {
            "name": "HasPermission",
            "desc": "Checks if a player has permission to run a command",
            "params": [
                {
                    "name": "commandName",
                    "desc": "The name of the command to check",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean\r\n"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 55,
                "path": "lib/cmdrhandler/src/Client/init.luau"
            }
        },
        {
            "name": "ExecuteCommand",
            "desc": "Executes a command\n```lua\nCmdrService:ExecuteCommand(\"blink\")\n```",
            "params": [
                {
                    "name": "...",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<string>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 80,
                "path": "lib/cmdrhandler/src/Client/init.luau"
            }
        },
        {
            "name": "GetPermissions",
            "desc": "Gets the permissions for the local player\nDoes not return permissions granted from groups",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "{any}\r\n"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 91,
                "path": "lib/cmdrhandler/src/Client/init.luau"
            }
        },
        {
            "name": "GetGroupRankPermissions",
            "desc": "Gets the permissions granted to a particular rank in a group\n```lua\nlocal permissions = CmdrService:GetGroupRankPermissions(15905255, 230)\n```",
            "params": [
                {
                    "name": "groupId",
                    "desc": "The Roblox group id to get permissions for",
                    "lua_type": "number"
                },
                {
                    "name": "rank",
                    "desc": "The rank to get permissions for",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "The permissions granted to the rank",
                    "lua_type": "{string}"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 105,
                "path": "lib/cmdrhandler/src/Client/init.luau"
            }
        },
        {
            "name": "GetPermissionInheritance",
            "desc": "Fetches the inherited permission group for a permission group",
            "params": [
                {
                    "name": "permissionGroup",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "{string}\r\n"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 112,
                "path": "lib/cmdrhandler/src/Client/init.luau"
            }
        },
        {
            "name": "_setBindings",
            "desc": "Sets up the default bindings for Cmdr",
            "params": [
                {
                    "name": "cmdr",
                    "desc": "",
                    "lua_type": "Cmdr"
                }
            ],
            "returns": [],
            "function_type": "method",
            "private": true,
            "source": {
                "line": 121,
                "path": "lib/cmdrhandler/src/Client/init.luau"
            }
        },
        {
            "name": "_getRawGroupPerms",
            "desc": "",
            "params": [
                {
                    "name": "groupId",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "{string}\r\n"
                }
            ],
            "function_type": "method",
            "private": true,
            "source": {
                "line": 144,
                "path": "lib/cmdrhandler/src/Client/init.luau"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "CmdrClient",
    "desc": "",
    "realm": [
        "Client"
    ],
    "source": {
        "line": 7,
        "path": "lib/cmdrhandler/src/Client/init.luau"
    }
}