console.h File Reference

#include <string>
#include <map>
#include <vector>
#include <Windows.h>

Go to the source code of this file.

Classes
class	Blam::Console::ConsoleCommand
	Class used to represent a console command. More...

Namespaces
	Blam
	Namespace surrounding all major engine components.
	Blam::Console
	Namespace for things relating to the debug console.
	Blam::Console::Handlers
	Functions used to handle multiple commands that have similar behavior.

Macros
#define	CMD_OK   Blam::Console::CommandStatus::Ok;
	Macro for OK command status. See Blam::Console::Ok for more details. More...
#define	CMD_ERR_INVALID_ARGS   Blam::Console::CommandStatus::InvalidArguments;
	Macro for Invalid Args command status. See Blam::Console::InvalidArguments for more details. More...
#define	CMD_ERR_WRONG_ARGS_COUNT   Blam::Console::CommandStatus::WrongArgumentCount;
	Macro for Wrong Arg Count command status. See Blam::Console::WrongArgumentCount for more details. More...
#define	BLAM

Enumerations
enum	Blam::Console::CommandStatus { Blam::Console::Ok, Blam::Console::InvalidArguments, Blam::Console::WrongArgumentCount, Blam::Console::Unsupported }
	Indicates the return state of a console command. More...
enum	Blam::Console::CommandType { Blam::Console::Builtin, Blam::Console::Script, Blam::Console::Global, Blam::Console::Other }
	Used to indicate the type of command. More...

Functions
BLAM CommandStatus	Blam::Console::Handlers::BooleanHandler (bool *value, std::vector< std::string > arguments, ConsoleCommand *command)
	Handler for boolean commands. More...
BLAM std::string	Blam::Console::RegisterCommand (Blam::Console::ConsoleCommand *command)
	Register a new command object. More...
BLAM void	Blam::Console::UnregisterCommand (std::string name)
	Unregisters the console command with the specified name. More...
BLAM ConsoleCommand *	Blam::Console::GetCommand (std::string name)
	Retrieves a command with the specified name. More...
BLAM HRESULT	Blam::Console::RunCommandLine (std::string command_line)
	Executed the provided string as a console command. More...
BLAM std::map< std::string, ConsoleCommand * >	Blam::Console::GetCommandList ()
	Retrieves the list of all loaded console commands. More...
BLAM void	Blam::Console::RegisterBuiltinCommands ()
	Registers all hard-coded engine commands. More...
BLAM void	Blam::Console::Cleanup ()
	Cleans up all console command data. More...

Macro Definition Documentation

BLAM

#define BLAM

CMD_ERR_INVALID_ARGS

#define CMD_ERR_INVALID_ARGS   Blam::Console::CommandStatus::InvalidArguments;

Macro for Invalid Args command status. See Blam::Console::InvalidArguments for more details.

CMD_ERR_WRONG_ARGS_COUNT

#define CMD_ERR_WRONG_ARGS_COUNT   Blam::Console::CommandStatus::WrongArgumentCount;

Macro for Wrong Arg Count command status. See Blam::Console::WrongArgumentCount for more details.

CMD_OK

#define CMD_OK   Blam::Console::CommandStatus::Ok;

Macro for OK command status. See Blam::Console::Ok for more details.