Skip to main content

DataStoreCmdrUtils

Shared plumbing for the datastore Cmdr commands. Runs on both realms, so nothing here may reach for a store -- those live on the server.

Functions​

parsePath​

</>
DataStoreCmdrUtils.parsePath(text: string) → {string}

Splits a slash-delimited sub-store path into its segments, dropping empty ones so a stray or trailing slash is forgiving rather than an error. An empty path means the root store.

registerSubStoreType​

</>
DataStoreCmdrUtils.registerSubStoreType(cmdr: Cmdr) → ()

Registers the sub-store path type.

Cmdr resolves types against the executor, who cannot see another player's stores, so a path is accepted as typed rather than completed against anything.

Show raw api
{
    "functions": [
        {
            "name": "parsePath",
            "desc": "Splits a slash-delimited sub-store path into its segments, dropping empty ones so a stray or\ntrailing slash is forgiving rather than an error. An empty path means the root store.",
            "params": [
                {
                    "name": "text",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "{ string }"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 18,
                "path": "src/datastore/src/Shared/Cmdr/DataStoreCmdrUtils.lua"
            }
        },
        {
            "name": "registerSubStoreType",
            "desc": "Registers the sub-store path type.\n\nCmdr resolves types against the executor, who cannot see another player's stores, so a path is\naccepted as typed rather than completed against anything.",
            "params": [
                {
                    "name": "cmdr",
                    "desc": "",
                    "lua_type": "Cmdr"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 37,
                "path": "src/datastore/src/Shared/Cmdr/DataStoreCmdrUtils.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "DataStoreCmdrUtils",
    "desc": "Shared plumbing for the datastore Cmdr commands. Runs on both realms, so nothing here may reach\nfor a store -- those live on the server.",
    "source": {
        "line": 8,
        "path": "src/datastore/src/Shared/Cmdr/DataStoreCmdrUtils.lua"
    }
}