console.cpp File Reference

#include "console.h"
#include "commands/abort.hpp"
#include "commands/classify.hpp"
#include "commands/cls.hpp"
#include "commands/crash.hpp"
#include "commands/create_cmd_obj.hpp"
#include "commands/dx_render_target_clear.hpp"
#include "commands/generate_plugins.hpp"
#include "commands/h2help.hpp"
#include "commands/h2print.hpp"
#include "commands/help.hpp"
#include "commands/history.hpp"
#include "commands/list_colors.hpp"
#include "commands/list_levels.hpp"
#include "commands/nou.hpp"
#include "commands/print.hpp"
#include "commands/quit.hpp"
#include "commands/regenerate_debug_menu.hpp"
#include "commands/resolution.hpp"
#include "commands/script_doc.hpp"
#include "commands/show_stats.hpp"
#include "commands/win32_dialog_test.hpp"
#include "commands/version.hpp"

Functions
void	DisplayCommandError (CommandStatus error_code, Blam::Console::ConsoleCommand *command)
	Displays an error message to inform the user why a command failed to run. More...
void	DisplayGvarError (BlamScript::Globals::GvarUpdateResult error_code, BlamScript::Globals::ScriptGlobal *global)
	Displays an error message to inform the user why a global variable failed to update. More...

Variables
std::map< std::string, ConsoleCommand * >	command_list
	The list of all loaded console commands. More...

Function Documentation

DisplayCommandError()

void DisplayCommandError	(	CommandStatus	error_code,
		Blam::Console::ConsoleCommand *	command
	)

Displays an error message to inform the user why a command failed to run.

Parameters

error_code	- The command status returned by the onCommand() call.
command	- The console command that was executed.

DisplayGvarError()

void DisplayGvarError	(	BlamScript::Globals::GvarUpdateResult	error_code,
		BlamScript::Globals::ScriptGlobal *	global
	)

Displays an error message to inform the user why a global variable failed to update.

Note

The message shown for BlamScript::Globals::InvalidType will differ based on the useEnhancedGvarMessages configuration setting. When disabled, the user will see the classic message, which resembles the following:

</blockquote>
When the setting is enabled, the output changes to the following to keep it easy to
understand:
<blockquote>
```invalid argument type provided for gvar ui_scale_factor, expected int

The option is enabled by default for added user-friendliness.

Parameters

error_code	- The status of the global update result. See BlamScript::Globals::GvarUpdateResult for details.
global	- A pointer to the global that was attempted to be modified.

Variable Documentation

command_list

std::map<std::string, ConsoleCommand*> command_list

The list of all loaded console commands.

The key is the name of the command. The value is a pointer to the console command object.