Console

Summary

Console global table.

Functions

MethodReturns
GetSettings(category: string)DataContainer
Execute(command: string)void
Register(group: string, name: string, description: string, inst: table, callback: function)void

Functions

GetSettings

Console.GetSettings(category: string): DataContainer

Gets the settings for a specific category.

Parameters

NameTypeDescription
categorystringThe category to get the settings for.

Returns

TypeDescription
DataContainerSettings object

Execute

Console.Execute(command: string): void

Execute a console command.

Parameters

NameTypeDescription
commandstringThe command to be executed.

Register

Console.Register(group: string, name: string, description: string, inst: table, callback: function): void

Register a new command.

Parameters

NameTypeDescription
groupstringThe category to get the settings for.
namestringThe name for the command.
descriptionstringThe description for the command.
insttableThe instance you want to have the callback be the instance function of. Like: inst:callback(args)
callbackfunctionA callback in the form function(args: string).