 |
Blamite Game Engine - blam!
00398.09.22.23.2015.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;
void DisplayCommandError(BlamCommandResult error_code, BlamConsoleCommand *command)
Displays an error message to inform the user why a command failed to run.
Definition: console.cpp:56
std::map< std::string, BlamConsoleCommand * > command_list
The list of all loaded console commands.
Definition: console.cpp:48
Class for the version command.
Definition: version.hpp:18
BLAM void UnregisterCommand(std::string name)
Unregisters the console command with the specified name.
Definition: console.cpp:231
BLAM void RegisterBuiltinCommands()
Registers all hard-coded engine commands.
Definition: console.cpp:374
Class for the history command.
Definition: history.hpp:14
@ Builtin
A command that is hard-coded into the engine.
BLAM EngineGlobal * GetGlobal(std::string name)
Retrieves a global with the specified ID.
Definition: globals.cpp:193
Class for the nou command.
Definition: nou.hpp:13
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:59
Class for the screenshot command.
Definition: screenshot.hpp:13
Class for the win32_dialog_test command.
Definition: win32_dialog_test.hpp:13
@ UnknownGlobal
The specified global does not exist.
Definition: globals.h:31
@ GlobalIsProtected
The specified global is protected and cannot be modified during runtime.
Definition: globals.h:35
Class used to represent a console command.
Definition: console.h:56
Class for the cls command.
Definition: cls.hpp:17
BLAM ConfigFile * GetConfig()
Retrieves the engine configuration file.
Definition: compat.cpp:5
Class for the listener_bug_check command.
Definition: listener_bug_check.hpp:17
@ InvalidArgs
The provided arguments were invalid.
Definition: globals.h:33
BLAM GvarUpdateResult UpdateGlobalWrap(std::string name, std::string new_value)
Updates a global's raw value.
Definition: globals.cpp:435
Class for the crash command.
Definition: crash.hpp:14
void display_global_update_message(Blam::Globals::GvarUpdateResult error_code, Blam::Globals::EngineGlobal *global)
Displays an error message to inform the user why a global variable failed to update.
Definition: console.cpp:100
std::string name
The name of the global.
Definition: globals.h:67
Class for the h2print command.
Definition: h2print.hpp:17
Class for the show_stats command.
Definition: show_stats.hpp:16
@ 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:243
Class for the classify command.
Definition: classify.hpp:14
Class for the h2help command.
Definition: h2help.hpp:18
@ String
Represents a std::string.
Definition: globals.h:48
Class for the toggle_imgui_window command.
Definition: toggle_imgui_window.hpp:12
virtual BlamCommandResult onCommand(std::vector< std::string > arguments)
Called upon command execution.
Definition: console.h:72
Class for the quit command.
Definition: quit.hpp:13
Class for the tag_load_force command.
Definition: tag_load_force.hpp:17
Class for the drop command.
Definition: drop.hpp:14
Structure containing data for a game engine global.
Definition: globals.h:64
BlamCommandResult
Indicates the return state of a console command.
Definition: console.h:22
BLAM HRESULT RunCommandLine(std::string command_line)
Executed the provided string as a console command.
Definition: console.cpp:271
Class for the explore command.
Definition: explore.hpp:18
Class for the dx_render_target_clear command.
Definition: dx_render_target_clear.hpp:14
Class for the abort command.
Definition: abort.hpp:12
Class for the tag_field_sizes command.
Definition: tag_field_sizes.hpp:15
Class for the debug_menu_rebuild command.
Definition: debug_menu_rebuild.hpp:15
#define BLAM
Definition: console.h:13
Class for the generate_plugins command.
Definition: generate_plugins.hpp:14
void console_update_global(std::string global_name, std::vector< std::string > arguments)
Definition: console.cpp:179
GvarUpdateResult
Enumerator for the result of a global update attempt.
Definition: globals.h:28
BLAM std::string ParseFolderPlaceholders(std::string string)
Parses any engine/user data folder placeholders within a string.
Definition: paths.cpp:382
std::string name
The name of the console command.
Definition: console.h:58
@ Unsupported
The command is a legacy command from the original ImGUI-based console that is no longer supported.
Class for the map_name command.
Definition: map_name.hpp:18
@ InvalidType
The provided value was of an invalid type.
Definition: globals.h:30
ARPHIC PUBLIC LICENSE Ltd Yung Chi Taiwan All rights reserved except as specified below Everyone is permitted to copy and distribute verbatim copies of this license but changing it is forbidden Preamble The licenses for most software are designed to take away your freedom to share and change it By the ARPHIC PUBLIC LICENSE specifically permits and encourages you to use this provided that you give the recipients all the rights that we gave you and make sure they can get the modifications of this software Legal Terms Font means the TrueType fonts AR PL Mingti2L AR PL KaitiM AR PL KaitiM and the derivatives of those fonts created through any modification including modifying reordering converting changing font or adding deleting some characters in from glyph table PL means Public License Copyright Holder means whoever is named in the copyright or copyrights for the Font You means the or person redistributing or modifying the Font Freely Available means that you have the freedom to copy or modify the Font as well as redistribute copies of the Font under the same conditions you not price If you you can charge for this service Copying &Distribution You may copy and distribute verbatim copies of this Font in any without provided that you retain this license including modifying reordering converting changing font or adding deleting some characters in from glyph and copy and distribute such modifications under the terms of Section provided that the following conditions are such as by offering access to copy the modifications from a designated or distributing the modifications on a medium customarily used for software interchange c If the modified fonts normally reads commands interactively when you must cause it
Definition: ARPHICPL.TXT:36
Class for the list_colors command.
Definition: list_colors.hpp:16
BLAM std::map< std::string, BlamConsoleCommand * > GetCommandList()
Retrieves the list of all loaded console commands.
Definition: console.cpp:237
Class for the script_doc command.
Definition: script_doc.hpp:14
@ OutOfBounds
The provided value was too small or too large for the globals' data type.
Definition: globals.h:34
A command to test Sentry functionality.
Definition: sentry_test.hpp:12
Class for the list_levels command.
Definition: list_levels.hpp:17
Class for the print command.
Definition: print.hpp:18
std::string syntax
The syntax information for the command. Shown to the user when using the help command with an argumen...
Definition: console.h:60
BlamCommandType type
The type of command this is. See #Blam::Resources::Console::BlamCommandType for more information.
Definition: console.h:63
@ Script
A command that originates from a BlamScript.
@ InvalidArguments
Invalid arguments (or argument types) were specified - such as providing a string in place of an int.
#define ENGINE_TEXT(string_id)
Definition: engine_text.h:7
BLAM void LogEventForce(std::string message)
Forcibly logs a message to the log and/or console.
Definition: aliases.cpp:274
Class for the screenres command.
Definition: resolution.hpp:14
std::string value_raw
The raw value of the global as a string.
Definition: globals.h:69
BlamCommandType
Used to indicate the type of command.
Definition: console.h:33
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:61
@ WrongArgumentCount
Too few or too many arguments were provided.
Class for the cls command.
Definition: reload_material_datablocks.hpp:17
Class for the create_cmd_obj command.
Definition: create_cmd_obj.hpp:17
GvarType type
The type of the global.
Definition: globals.h:66
@ Ok
The command was run without error.
Class for the open_web_url command.
Definition: open_web_url.hpp:14
Namespace for things relating to the debug console.
Definition: abort.hpp:5
BLAM void Cleanup()
Cleans up all console command data.
Definition: console.cpp:363
Class for the help command.
Definition: help.hpp:16
ARPHIC PUBLIC LICENSE Ltd Yung Chi Taiwan All rights reserved except as specified below Everyone is permitted to copy and distribute verbatim copies of this license but changing it is forbidden Preamble The licenses for most software are designed to take away your freedom to share and change it By the ARPHIC PUBLIC LICENSE specifically permits and encourages you to use this provided that you give the recipients all the rights that we gave you and make sure they can get the modifications of this software Legal Terms Font means the TrueType fonts AR PL Mingti2L AR PL KaitiM AR PL KaitiM and the derivatives of those fonts created through any modification including modifying reordering converting changing font name
Definition: ARPHICPL.TXT:16
BLAM GvarUpdateResult UpdateGlobal(std::string name, std::string new_value)
Updates the value of a String global.
Definition: globals.cpp:578
BLAM std::string GetGvarTypeLabel(GvarType type)
Retrieves a string representation of a global's type, for use in UI.
Definition: globals.cpp:40
Class for the open_game_dir command.
Definition: open_game_dir.hpp:13
BLAM std::string RegisterCommand(BlamConsoleCommand *command)
Register a new command object.
Definition: console.cpp:223