 |
Blamite Game Engine - blam!
00272.10.26.20.0001.blamite
The core library for the Blamite Game Engine.
|
Go to the documentation of this file.
9 #define CMD_OK Blam::Console::CommandStatus::Ok;
10 #define CMD_ERR_INVALID_ARGS Blam::Console::CommandStatus::InvalidArguments;
11 #define CMD_ERR_WRONG_ARGS_COUNT Blam::Console::CommandStatus::WrongArgumentCount;
std::vector< std::string > aliases
A list of aliases for the command. Executing any of these instead of the command name will behave the...
Definition: console.h:75
BLAM HRESULT RunCommandLine(std::string command_line)
Executed the provided string as a console command.
Definition: console.cpp:184
BLAM std::map< std::string, ConsoleCommand * > GetCommandList()
Retrieves the list of all loaded console commands.
Definition: console.cpp:150
std::string description
An optional description of the command. Shown when using the classify command.
Definition: console.h:73
BLAM CommandStatus BooleanHandler(bool *value, std::vector< std::string > arguments, ConsoleCommand *command)
Handler for boolean commands.
Definition: command_handlers.cpp:9
CommandType type
The type of command this is. See Blam::Console::CommandType for more information.
Definition: console.h:77
CommandStatus
Indicates the return state of a console command.
Definition: console.h:28
@ Other
Currently unused.
Definition: console.h:44
@ Global
A command that is used to modify a global. No longer serves any use as globals can be modified in con...
Definition: console.h:43
BLAM std::string RegisterCommand(Blam::Console::ConsoleCommand *command)
Register a new command object.
Definition: console.cpp:136
~ConsoleCommand()
Unused destructor.
Definition: console.h:61
@ Builtin
A command that is hard-coded into the engine.
Definition: console.h:41
std::string name
The name of the console command.
Definition: console.h:70
BLAM ConsoleCommand * GetCommand(std::string name)
Retrieves a command with the specified name.
Definition: console.cpp:156
BLAM void UnregisterCommand(std::string name)
Unregisters the console command with the specified name.
Definition: console.cpp:144
@ WrongArgumentCount
Too few or too many arguments were provided.
Definition: console.h:32
CommandType
Used to indicate the type of command.
Definition: console.h:39
@ Script
A command that originates from a BlamScript.
Definition: console.h:42
ConsoleCommand()
Unused constructor.
Definition: console.h:56
#define BLAM
Definition: console.h:14
Namespace for things relating to the debug console.
Definition: abort.hpp:5
BLAM void RegisterBuiltinCommands()
Registers all hard-coded engine commands.
Definition: console.cpp:324
@ Unsupported
The command is a legacy command from the original ImGUI-based console that is no longer supported.
Definition: console.h:33
virtual CommandStatus onCommand(std::vector< std::string > arguments)
Called upon command execution.
Definition: console.h:70
@ Ok
The command was run without error.
Definition: console.h:30
Class used to represent a console command.
Definition: console.h:50
BLAM void Cleanup()
Cleans up all console command data.
Definition: console.cpp:313
@ InvalidArguments
Invalid arguments (or argument types) were specified - such as providing a string in place of an int.
Definition: console.h:31
std::string syntax
The syntax information for the command. Shown to the user when using the help command with an argumen...
Definition: console.h:74