Skip to main content

CmdrServiceClient

This item only works when running on the client. Client

Loads cmdr on the client. See CmdrService for the server equivalent.

Functions​

Init​

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

Starts the cmdr service on the client. Should be done via ServiceBag.

Start​

</>
CmdrServiceClient:Start() → ()

Starts the service. Should be done via ServiceBag.

PromiseCmdr​

</>
CmdrServiceClient:PromiseCmdr() → Promise<CmdrClient>

Retrieves the cmdr for the client.

Show raw api
{
    "functions": [
        {
            "name": "Init",
            "desc": "Starts the cmdr service on the client. Should be done via [ServiceBag].",
            "params": [
                {
                    "name": "serviceBag",
                    "desc": "",
                    "lua_type": "ServiceBag"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 28,
                "path": "src/cmdrservice/src/Client/CmdrServiceClient.lua"
            }
        },
        {
            "name": "Start",
            "desc": "Starts the service. Should be done via [ServiceBag].",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 79,
                "path": "src/cmdrservice/src/Client/CmdrServiceClient.lua"
            }
        },
        {
            "name": "PromiseCmdr",
            "desc": "Retrieves the cmdr for the client.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<CmdrClient>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 121,
                "path": "src/cmdrservice/src/Client/CmdrServiceClient.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "CmdrServiceClient",
    "desc": "Loads cmdr on the client. See [CmdrService] for the server equivalent.",
    "realm": [
        "Client"
    ],
    "source": {
        "line": 7,
        "path": "src/cmdrservice/src/Client/CmdrServiceClient.lua"
    }
}