Elaztek Developer Hub
Blamite Game Engine - blam!  00453.06.08.26.0624.blamite
The core library for the Blamite Game Engine.
debug_menu_how_to.hpp
Go to the documentation of this file.
1 #include "../console.h"
2 
6 
8 {
15  {
16  public:
18  {
19  name = "debug_menu_how_to";
20  description = "Displays information on how to use the debug menu in the console.";
21 
23  }
24 
25  BlamResult Execute(std::vector<std::string> arguments)
26  {
27  Blam::Logger::LogEvent("### USING THE DEBUG MENU ###", BlamColor(0, 128, 255));
29  Blam::Logger::LogEvent("Use the up and down arrow keys to navigate through the menu", BlamColor(255, 255, 0));
30  Blam::Logger::LogEvent("Use the left and right arrow keys to increase/decrease an item's value", BlamColor(255, 255, 0));
31  Blam::Logger::LogEvent("Use the Enter key to activate an item", BlamColor(255, 255, 0));
32  Blam::Logger::LogEvent("- For console commands, this will execute the command for the item", BlamColor(255, 191, 0));
33  Blam::Logger::LogEvent("- For variables/globals, this will increase the value (identical to pressing the right arrow key)", BlamColor(255, 191, 0));
34  Blam::Logger::LogEvent("- For submenus, this will open the submenu and display its child items within the menu", BlamColor(255, 191, 0));
35  Blam::Logger::LogEvent("Use the End key to return to the main page", BlamColor(255, 255, 0));
36  Blam::Logger::LogEvent("Use the Page Up key to open and close the debug menu", BlamColor(255, 255, 0));
37 
38  return BlamResult::Success_OK;
39  }
40  };
41 }
ui.h
Blam::Logger::LogEvent
BLAM void LogEvent(std::string message)
Logs a message to the log and/or console.
Definition: aliases.cpp:130
BlamConsoleCommand::description
std::string description
An optional description of the command. Shown when using the classify command.
Definition: console.h:36
Blam::Resources::Console::DebugMenuHowToCommand::DebugMenuHowToCommand
DebugMenuHowToCommand()
Definition: debug_menu_how_to.hpp:17
logger.h
BlamConsoleCommand
Class used to represent a console command.
Definition: console.h:33
Blam::Resources::Console::DebugMenuHowToCommand::Execute
BlamResult Execute(std::vector< std::string > arguments)
Called upon command execution.
Definition: debug_menu_how_to.hpp:25
Blam::Resources::Console::DebugMenuHowToCommand
Class for the debug_menu_how_to command.
Definition: debug_menu_how_to.hpp:14
debug_menu.h
BlamConsoleCommand::name
std::string name
The name of the console command.
Definition: console.h:35
BlamConsoleCommand::type
BlamCommandType type
The type of command this is. See #Blam::Resources::Console::BlamCommandType for more information.
Definition: console.h:40
Blam::Resources::Console
Namespace for things relating to the debug console.
Definition: abort.hpp:5
BlamCommandType::Builtin
@ Builtin
A command that is hard-coded into the engine.