Skip to main content

CmdrClient

This item only works when running on the client. Client

This is a wrapper client for Evaera's Cmdr module (https://eryn.io/Cmdr/). It provides an easier way to interact with Cmdr and autoboots with Roam's systems.

Properties​

PermissionsHandler​

</>
CmdrClient.PermissionsHandler: PermissionsHandler

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(
commandName: string--

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

CmdrClient:ExecuteCommand("blink")

CommandExists​

</>
CmdrClient:CommandExists(
commandName: string--

The name of the command to check

) → boolean--

Whether the command exists

Checks if a command exists in the registry

GetCommandInfo​

</>
CmdrClient:GetCommandInfo(
commandName: string--

The name of the command to get info for

) → CommandDefinition?--

The command data, or nil if not found

Gets information about a specific command

GetAvailableCommands​

</>
CmdrClient:GetAvailableCommands() → {string}--

Array of command names the player can use

Gets all commands available to the local player

GetAllCommands​

</>
CmdrClient:GetAllCommands() → {CommandDefinition}--

Array of all registered commands

Gets all registered commands

Init​

</>
CmdrClient:Init() → ()

Initializes the Cmdr Client

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\n"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 62,
                "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\n"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 70,
                "path": "lib/cmdrhandler/src/Client/init.luau"
            }
        },
        {
            "name": "ExecuteCommand",
            "desc": "Executes a command\n```lua\nCmdrClient:ExecuteCommand(\"blink\")\n```",
            "params": [
                {
                    "name": "...",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<string>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 81,
                "path": "lib/cmdrhandler/src/Client/init.luau"
            }
        },
        {
            "name": "CommandExists",
            "desc": "Checks if a command exists in the registry",
            "params": [
                {
                    "name": "commandName",
                    "desc": "The name of the command to check",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "Whether the command exists",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 93,
                "path": "lib/cmdrhandler/src/Client/init.luau"
            }
        },
        {
            "name": "GetCommandInfo",
            "desc": "Gets information about a specific command",
            "params": [
                {
                    "name": "commandName",
                    "desc": "The name of the command to get info for",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "The command data, or nil if not found",
                    "lua_type": "CommandDefinition?"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 107,
                "path": "lib/cmdrhandler/src/Client/init.luau"
            }
        },
        {
            "name": "GetAvailableCommands",
            "desc": "Gets all commands available to the local player",
            "params": [],
            "returns": [
                {
                    "desc": "Array of command names the player can use",
                    "lua_type": "{string}"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 119,
                "path": "lib/cmdrhandler/src/Client/init.luau"
            }
        },
        {
            "name": "GetAllCommands",
            "desc": "Gets all registered commands",
            "params": [],
            "returns": [
                {
                    "desc": "Array of all registered commands",
                    "lua_type": "{CommandDefinition}"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 140,
                "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": 156,
                "path": "lib/cmdrhandler/src/Client/init.luau"
            }
        },
        {
            "name": "Init",
            "desc": "Initializes the Cmdr Client",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 183,
                "path": "lib/cmdrhandler/src/Client/init.luau"
            }
        }
    ],
    "properties": [
        {
            "name": "PermissionsHandler",
            "desc": "",
            "lua_type": "PermissionsHandler",
            "source": {
                "line": 55,
                "path": "lib/cmdrhandler/src/Client/init.luau"
            }
        }
    ],
    "types": [],
    "name": "CmdrClient",
    "desc": "This is a wrapper client for Evaera's Cmdr module (https://eryn.io/Cmdr/).\nIt provides an easier way to interact with Cmdr and autoboots with Roam's\nsystems.",
    "realm": [
        "Client"
    ],
    "source": {
        "line": 11,
        "path": "lib/cmdrhandler/src/Client/init.luau"
    }
}