Home › Overview › MainModule
Registry
Types
SequenceDefinition type
luau
type SequenceDefinition = {
constructor: (...any) -> any,
parse: (...any) -> any,
transform: (string) -> any,
validate: (any) -> boolean,
prefixes: { [string]: string },
}Environment type
luau
type Environment = {} | (_K: any) -> {}ArgumentFunction type
luau
type ArgumentFunction = (value: any, from: Player) -> ...anyArgumentType type
luau
type ArgumentType = {
name: string?,
displayName: string?,
listable: boolean?,
filterLog: boolean?,
freeText: boolean?,
transform: ArgumentFunction?,
validate: ArgumentFunction?,
parse: ArgumentFunction?,
postParse: ArgumentFunction?,
suggestions: ArgumentFunction?,
prefixes: { [string]: string }?,
}ArgumentDefinition type
luau
type ArgumentDefinition = {
type: string,
name: string,
description: string,
optional: boolean?,
permissions: { [string]: boolean }?,
-- player type options
lowerRank: boolean?,
ignoreSelf: boolean?,
shouldRequest: boolean?,
-- lowerRank compares only the roles given in this server, for arguments that can't harm their target
skipOfflineRank: boolean?,
}CommandDefinition type
luau
type CommandDefinition = {
name: string,
aliases: { string }?,
description: string,
group: string,
noLog: boolean?,
args: { ArgumentDefinition }?,
permissions: { [string]: boolean }?,
envClient: Environment?,
env: Environment?,
runClient: (...any) -> ()?,
run: (...any) -> ()?,
_listIndex: number?,
}Properties
types
luau
Registry.types: { [string]: Type.ArgumentType }commands
luau
Registry.commands: { [string]: Type.CommandDefinition }commandsList
luau
Registry.commandsList: { Type.CommandDefinition }commandNames
luau
Registry.commandNames: { string }Functions
makeEnumType
luau
Registry.makeEnumType(typeName: string, enumItems: { EnumItem | string })Makes an Enum argument type definition
suggestCommandAlias
luau
Registry.suggestCommandAlias(alias: string): stringFinds the command alias with the lowest Levenshtein distance to the provided alias.
makeSequenceType
luau
Registry.makeSequenceType(definition: SequenceDefinition?)Makes an sequence argument type definition, useful for Color3, Vector3, etc
registerType
luau
Registry.registerType(name: string, typeObject: Type.ArgumentType, override: Type.Dict?)Registers an argument type
registerCommand
luau
Registry.registerCommand(_K: any, commandObject: Type.CommandDefinition)Registers a command
dashboardWindowEnv
luau
Registry.dashboardWindowEnv(tab: string)registerCommandAlias Client
luau
Registry.registerCommandAlias(_K: any, alias: string, command: string)Registers a local command alias
registerCommandModule
luau
Registry.registerCommandModule(_K: any, commandModule: ModuleScript)Registers a list of commands with the module name as the command group