Show raw api
{
"functions": [
{
"name": "makeEnumType",
"desc": "Makes an Enum argument type definition",
"params": [
{
"name": "typeName",
"desc": "",
"lua_type": "string"
},
{
"name": "enumItems",
"desc": "",
"lua_type": "{ EnumItem | string }"
}
],
"returns": [],
"function_type": "static",
"source": {
"line": 25,
"path": "src/Registry.luau"
}
},
{
"name": "makeSequenceType",
"desc": "Makes an sequence argument type definition, useful for Color3, Vector3, etc",
"params": [
{
"name": "definition",
"desc": "",
"lua_type": "SequenceDefinition?"
}
],
"returns": [],
"function_type": "static",
"source": {
"line": 52,
"path": "src/Registry.luau"
}
},
{
"name": "registerType",
"desc": "Registers an argument type",
"params": [
{
"name": "name",
"desc": "",
"lua_type": "string"
},
{
"name": "typeObject",
"desc": "",
"lua_type": "Type.ArgumentType"
},
{
"name": "override",
"desc": "",
"lua_type": "Type.Dict?"
}
],
"returns": [],
"function_type": "static",
"source": {
"line": 89,
"path": "src/Registry.luau"
}
},
{
"name": "registerCommand",
"desc": "Registers a command",
"params": [
{
"name": "_K",
"desc": "",
"lua_type": "any"
},
{
"name": "commandObject",
"desc": "",
"lua_type": "Type.CommandDefinition"
}
],
"returns": [],
"function_type": "static",
"source": {
"line": 105,
"path": "src/Registry.luau"
}
},
{
"name": "registerCommandAlias",
"desc": "Registers a local command alias",
"params": [
{
"name": "_K",
"desc": "",
"lua_type": "any"
},
{
"name": "alias",
"desc": "",
"lua_type": "string"
},
{
"name": "command",
"desc": "",
"lua_type": "string"
}
],
"returns": [],
"function_type": "static",
"source": {
"line": 184,
"path": "src/Registry.luau"
}
},
{
"name": "registerCommandModule",
"desc": "Registers a list of commands with the module name as the command group",
"params": [
{
"name": "_K",
"desc": "",
"lua_type": "any"
},
{
"name": "commandModule",
"desc": "",
"lua_type": "ModuleScript"
}
],
"returns": [],
"function_type": "static",
"source": {
"line": 207,
"path": "src/Registry.luau"
}
}
],
"properties": [
{
"name": "types",
"desc": "",
"lua_type": "{ [string]: ArgumentType }",
"source": {
"line": 10,
"path": "src/Registry.luau"
}
},
{
"name": "commands",
"desc": "",
"lua_type": "{ [string]: CommandDefinition }",
"source": {
"line": 13,
"path": "src/Registry.luau"
}
},
{
"name": "commandsList",
"desc": "",
"lua_type": "{ CommandDefinition }",
"source": {
"line": 16,
"path": "src/Registry.luau"
}
}
],
"types": [
{
"name": "SequenceDefinition",
"desc": "",
"lua_type": "{ constructor: (...any) -> any, parse: (...any) -> any, transform: (string) -> any, validate: (any) -> boolean, prefixes: { [string]: string } }",
"source": {
"line": 43,
"path": "src/Registry.luau"
}
},
{
"name": "ArgumentFunction",
"desc": "",
"lua_type": "(value: any, from: Player) -> ...any",
"source": {
"line": 7,
"path": "src/Type.luau"
}
},
{
"name": "ArgumentType",
"desc": "",
"lua_type": "{name: string, displayName: string?, listable: boolean?, filterLog: boolean?, transform: ArgumentFunction?, validate: ArgumentFunction, parse: ArgumentFunction, preParse: ArgumentFunction?, postParse: ArgumentFunction?, suggestions: ArgumentFunction?, prefixes: { [string]: string }? }",
"source": {
"line": 11,
"path": "src/Type.luau"
}
},
{
"name": "ArgumentDefinition",
"desc": "",
"lua_type": "{type: string, name: string, description: string, optional: boolean?, permissions: { [string]: boolean }?, lowerRank: boolean?, ignoreSelf: boolean?, shouldRequest: boolean? }",
"source": {
"line": 26,
"path": "src/Type.luau"
}
},
{
"name": "CommandDefinition",
"desc": "",
"lua_type": "{name: string, aliases: { string }?, description: string, group: string, noLog: boolean?, args: { ArgumentDefinition }, permissions: { [string]: boolean }?, envClient: {} | () -> {}?, env: {} | () -> {}?, runClient: (...any) -> ()?, run: (...any) -> ()? }",
"source": {
"line": 40,
"path": "src/Type.luau"
}
}
],
"name": "Registry",
"desc": "",
"source": {
"line": 18,
"path": "src/Registry.luau"
}
}