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/debug_menu_how_to.hpp"
#include "commands/debug_menu_rebuild.hpp"
#include "commands/drop.hpp"
#include "commands/explore.hpp"
#include "commands/generate_plugins.hpp"
#include "commands/h2help.hpp"
#include "commands/h2print.hpp"
#include "commands/help.hpp"
#include "commands/history.hpp"
#include "commands/init_world_state.hpp"
#include "commands/list_colors.hpp"
#include "commands/list_levels.hpp"
#include "commands/listener_bug_check.hpp"
#include "commands/log.hpp"
#include "commands/map_name.hpp"
#include "commands/nou.hpp"
#include "commands/open_game_dir.hpp"
#include "commands/open_web_url.hpp"
#include "commands/print.hpp"
#include "commands/quit.hpp"
#include "commands/reload_material_datablocks.hpp"
#include "commands/resolution.hpp"
#include "commands/screenshot.hpp"
#include "commands/script_doc.hpp"
#include "commands/sentry_test.hpp"
#include "commands/set_project_root.hpp"
#include "commands/show_stats.hpp"
#include "commands/tag_field_sizes.hpp"
#include "commands/tag_load_force.hpp"
#include "commands/toggle_imgui_window.hpp"
#include "commands/win32_dialog_test.hpp"
#include "commands/version.hpp"
#include "components/resources/engine_text/engine_text.h"

Include dependency graph for console.cpp:

Functions
void	DisplayCommandError (BlamResult error_code, BlamConsoleCommand *command)
	Displays an error message to inform the user why a command failed to run. More...
void	display_global_update_message (BlamGlobalUpdateResult error_code, BlamEngineGlobal *global)
	Displays an error message to inform the user why a global variable failed to update. More...
void	console_update_global (std::string global_name, std::vector< std::string > arguments)
	Function to handle updating an engine global from the console. More...

Variables
std::map< std::string, BlamConsoleCommand * >	command_list = std::map<std::string, BlamConsoleCommand*>()
	The list of all loaded console commands. More...

Function Documentation

console_update_global()

void console_update_global	(	std::string	global_name,
		std::vector< std::string >	arguments
	)

Function to handle updating an engine global from the console.

Parameters

global_name	- The name of the global being updated.
arguments	- The arguments provided to the command.

Here is the call graph for this function:

Here is the caller graph for this function:

display_global_update_message()

void display_global_update_message	(	BlamGlobalUpdateResult	error_code,
		BlamEngineGlobal *	global
	)

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

Note

The message shown for #Blam::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 #Blam::Globals::GvarUpdateResult for details.
global	- A pointer to the global that was attempted to be modified.

Here is the call graph for this function:

Here is the caller graph for this function:

DisplayCommandError()

void DisplayCommandError	(	BlamResult	error_code,
		BlamConsoleCommand *	command
	)

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

Parameters

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

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

command_list

std::map<std::string, BlamConsoleCommand*> command_list = std::map<std::string, BlamConsoleCommand*>()

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.