debug_menu.h File Reference

#include <string>
#include <vector>

Go to the source code of this file.

Classes
class	BlamDebugMenuItem
	Class used to store data and functions relating to an item within the engine's debug menu. More...
struct	BlamDebugMenu
	Structure containing data for the root of the debug menu. More...

Namespaces
	InternalUI
	Namespace containing things for the engine's "internal UI", which is powered through ImGUI.
	Blam
	Namespace surrounding all major engine components.
	Blam::Resources
	Blam::Resources::DebugMenu
	Namespace containing data for the engine's debug menu.

Macros
#define	MENU_ITEM_TYPE_UNKNOWN   BlamDebugMenuItemType::Unknown
	Macro for Unknown. See #Blam::Resources::DebugMenu::Unknown for details. More...
#define	MENU_ITEM_TYPE_EXEC   BlamDebugMenuItemType::Command
	Macro for Executor. See #Blam::Resources::DebugMenu::Executor for details. More...
#define	MENU_ITEM_TYPE_CATEGORY   BlamDebugMenuItemType::Submenu
	Macro for Submenu. See #Blam::Resources::DebugMenu::Submenu for details. More...
#define	MENU_ITEM_TYPE_GLOBAL   BlamDebugMenuItemType::Global
	Macro for Global. See #Blam::Resources::DebugMenu::Global for details. More...
#define	MENU_ITEM_TYPE_MULTIEXEC   BlamDebugMenuItemType::CommandSequence
	Macro for ExecSequence. See #Blam::Resources::DebugMenu::ExecSequence for details. More...
#define	DEBUG_MENU_FILE   "debug_menu_init"
	The file name to load the debug menu contents from - without the extension. More...
#define	BLAM

Enumerations
enum	BlamDebugMenuItemType {   BlamDebugMenuItemType::Command, BlamDebugMenuItemType::CommandSequence, BlamDebugMenuItemType::Global, BlamDebugMenuItemType::Submenu,   BlamDebugMenuItemType::Unknown }
	Menu item type enumerator. More...

Functions
BLAM void	InternalUI::CreateFPSCounter ()
BLAM void	InternalUI::UpdateFPSCounter ()
BLAM void	Blam::Resources::DebugMenu::InitializeDebugMenu ()
	Load debug menu content from debug_menu_init.xml. More...
BLAM void	Blam::Resources::DebugMenu::ReloadDebugMenu ()
	Reloads debug menu content from debug_menu_init.xml. More...
BLAM BlamDebugMenu	Blam::Resources::DebugMenu::GetDebugMenu ()
	Retrieves the debug menu data. More...

Macro Definition Documentation

BLAM

#define BLAM

DEBUG_MENU_FILE

#define DEBUG_MENU_FILE   "debug_menu_init"

The file name to load the debug menu contents from - without the extension.

MENU_ITEM_TYPE_CATEGORY

#define MENU_ITEM_TYPE_CATEGORY   BlamDebugMenuItemType::Submenu

Macro for Submenu. See #Blam::Resources::DebugMenu::Submenu for details.

MENU_ITEM_TYPE_EXEC

#define MENU_ITEM_TYPE_EXEC   BlamDebugMenuItemType::Command

Macro for Executor. See #Blam::Resources::DebugMenu::Executor for details.

MENU_ITEM_TYPE_GLOBAL

#define MENU_ITEM_TYPE_GLOBAL   BlamDebugMenuItemType::Global

Macro for Global. See #Blam::Resources::DebugMenu::Global for details.

MENU_ITEM_TYPE_MULTIEXEC

#define MENU_ITEM_TYPE_MULTIEXEC   BlamDebugMenuItemType::CommandSequence

Macro for ExecSequence. See #Blam::Resources::DebugMenu::ExecSequence for details.

MENU_ITEM_TYPE_UNKNOWN

#define MENU_ITEM_TYPE_UNKNOWN   BlamDebugMenuItemType::Unknown

Macro for Unknown. See #Blam::Resources::DebugMenu::Unknown for details.

Enumeration Type Documentation

BlamDebugMenuItemType

enum BlamDebugMenuItemType

strong

Menu item type enumerator.

Enumerator
Command	Runs a console command upon activation.
CommandSequence	Runs a sequence of console commands upon activation. One command is run per activation. After initial activation, the second activation will run the second command in the sequence. Upon reaching the end of the sequence, the next activation will run the command at the start of the sequence.
Global	Modifies an engine global upon activation.
Submenu	Enters into a submenu/subscreen upon activation.
Unknown	Fallback in the event that debug_menu_init contained an invalid option.