 |
Blamite Game Engine - blam!
00296.01.12.21.0102.blamite
The core library for the Blamite Game Engine.
|
Go to the documentation of this file.
8 #define CMD_OK BlamCommandResult::Ok;
9 #define CMD_ERR_INVALID_ARGS BlamCommandResult::InvalidArguments;
10 #define CMD_ERR_WRONG_ARGS_COUNT BlamCommandResult::WrongArgumentCount;
BLAM void UnregisterCommand(std::string name)
Unregisters the console command with the specified name.
Definition: console.cpp:164
BLAM void RegisterBuiltinCommands()
Registers all hard-coded engine commands.
Definition: console.cpp:353
BLAM BlamCommandResult BooleanHandler(bool *value, std::vector< std::string > arguments, BlamConsoleCommand *command)
Handler for boolean commands.
Definition: command_handlers.cpp:11
std::string description
An optional description of the command. Shown when using the classify command.
Definition: console.h:57
BlamCommandType
Used to indicate the type of command.
Definition: console.h:33
@ Ok
The command was run without error.
Class used to represent a console command.
Definition: console.h:54
@ Script
A command that originates from a BlamScript.
@ Global
A command that is used to modify a global.
BLAM BlamConsoleCommand * GetCommand(std::string name)
Retrieves a command with the specified name.
Definition: console.cpp:176
virtual BlamCommandResult onCommand(std::vector< std::string > arguments)
Called upon command execution.
Definition: console.h:70
BLAM HRESULT RunCommandLine(std::string command_line)
Executed the provided string as a console command.
Definition: console.cpp:204
@ WrongArgumentCount
Too few or too many arguments were provided.
std::string name
The name of the console command.
Definition: console.h:56
@ InvalidArguments
Invalid arguments (or argument types) were specified - such as providing a string in place of an int.
BLAM std::map< std::string, BlamConsoleCommand * > GetCommandList()
Retrieves the list of all loaded console commands.
Definition: console.cpp:170
#define BLAM
Definition: console.h:13
std::string syntax
The syntax information for the command. Shown to the user when using the help command with an argumen...
Definition: console.h:58
BlamCommandType type
The type of command this is. See #Blam::Resources::Console::BlamCommandType for more information.
Definition: console.h:61
@ Builtin
A command that is hard-coded into the engine.
@ Unsupported
The command is a legacy command from the original ImGUI-based console that is no longer supported.
BlamCommandResult
Indicates the return state of a console command.
Definition: console.h:22
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:59
Namespace for things relating to the debug console.
Definition: abort.hpp:5
BLAM void Cleanup()
Cleans up all console command data.
Definition: console.cpp:342
BLAM std::string RegisterCommand(BlamConsoleCommand *command)
Register a new command object.
Definition: console.cpp:156