Class ConsoleManager

Handles the set of currently active CVar instances.

Index

Constructors

Accessors

Methods

executeCommand getCommandsMatchingAutoCompleteEntry getCommandWithName getCVarsMatchingAutoCompleteEntry getCVarWithName loadConfigurationFromFile saveConfigurationToFile tryLoadConfigurationFromFile

Constructors

constructor

new ConsoleManager(): ConsoleManager
Returns ConsoleManager

Accessors

`Static`variables

get variables(): Iterable<CVar>
Gets a list of defined variables.

Returns Iterable<CVar>

Methods

`Static`executeCommand

executeCommand(command): boolean
Executes a console command.
Parameters
- command: string
  The command to execute.
Returns boolean
true upon sucess

Note
The method tokenizes the string into arguments that are then passed to the ConsoleCommand that matches the name of the first argument. If no ConsoleCommand has been found, the system tries to locate a CVar that matches the name of the first argument. If a CVar has been found it's value will be written to the console if no furhter argument is present. If another argument is available, it will be used to set the value of the CVar. Arguments can be escapted using quotes. Quotes themselve can be escaped using a backslash.

`Static`getCommandsMatchingAutoCompleteEntry

getCommandsMatchingAutoCompleteEntry(entry): string[]
Gets a list of commands that match the autocompletion.
Parameters
- entry: string
Returns string[]

`Static`getCommandWithName

getCommandWithName(name): ConsoleCommand
Gets the command with the specified name.
Parameters
- name: string
Returns ConsoleCommand

`Static`getCVarsMatchingAutoCompleteEntry

getCVarsMatchingAutoCompleteEntry(entry): string[]
Gets a list of cvars that match the autocompletion.
Parameters
- entry: string
Returns string[]

`Static`getCVarWithName

getCVarWithName(name): CVar
Tries to find a CVar by the given name. If no such CVar exists, returns nullptr.
Parameters
- name: string
Returns CVar

`Static`loadConfigurationFromFile

loadConfigurationFromFile(path): void
Loads variable definitions from a configuration file.
Parameters
- path: FilePath
  The path to the configuration file to be loaded.
Returns void

`Static`saveConfigurationToFile

saveConfigurationToFile(path): void
Saves variable definitions to a configuration file.
Parameters
- path: FilePath
  The path to the configuration file to be written with the current configuration.
Returns void

`Static`tryLoadConfigurationFromFile

tryLoadConfigurationFromFile(path): boolean
Tries to load the configuration from a file. Unlike loadConfigurationFromFile(), this method checks if the file exists before loading it.
Parameters
- path: FilePath
Returns boolean