10 #ifndef CONSOLE_INTERNAL_H
11 #define CONSOLE_INTERNAL_H
64 typedef std::map<std::string, IConsoleCmd> CommandList;
65 typedef std::map<std::string, IConsoleAlias> AliasList;
69 static AliasList &Aliases();
74 static void AliasRegister(
const std::string &name,
const std::string &cmd);
79 void IConsoleClearBuffer();
82 void IConsoleStdLibRegister();
87 void IConsoleGUIInit();
88 void IConsoleGUIFree();
Commands
List of commands.
bool GetArgumentInteger(uint32_t *value, const char *arg)
Change a string into its number representation.
static const uint ICON_MAX_STREAMSIZE
maximum length of a totally expanded command
ConsoleHookResult
Return values of console hooks (#IConsoleHook).
@ CHR_HIDE
Hide the existence of the command.
@ CHR_DISALLOW
Disallow command execution.
@ CHR_ALLOW
Allow command execution.
void IConsoleGUIPrint(TextColour colour_code, const std::string &string)
Handle the printing of text entered into the console or redirected there by any other means.
static const uint ICON_CMDLN_SIZE
maximum length of a typed in command
bool IConsoleCmdProc(uint8_t argc, char *argv[])
–Commands– Commands are commands, or functions.
Types related to the graphics and/or input devices.
TextColour
Colour of the strings, see _string_colourmap in table/string_colours.h or docs/ottd-colourtext-palett...
–Aliases– Aliases are like shortcuts for complex functions, variable assignments, etc.
std::string cmdline
command(s) that is/are being aliased
std::string name
name of the alias
IConsoleCmdProc * proc
process executed when command is typed
IConsoleHook * hook
any special trigger action that needs executing
std::string name
name of command
static IConsoleAlias * AliasGet(const std::string &name)
Find the alias pointed to by its string.
static void CmdRegister(const std::string &name, IConsoleCmdProc *proc, IConsoleHook *hook=nullptr)
Register a new command to be used in the console.
static IConsoleCmd * CmdGet(const std::string &name)
Find the command pointed to by its string.
static void AliasRegister(const std::string &name, const std::string &cmd)
Register a an alias for an already existing command in the console.