Blam::DebugMenu::MenuItem Class Reference

Class used to store data and functions relating to an item within the engine's debug menu. More...

#include <blam_ui.h>

Public Member Functions
	MenuItem ()
	Empty and unused constructor. More...
	~MenuItem ()
	Empty and unused destructor. More...
void	SetupMenuItem (MenuItemType _type, std::string _title)
	Prepares the menu item for use. More...
void	HandleKeyEnter ()
	Called when the menu item is active and the enter key is pressed. More...
void	HandleKeyLeft ()
	Called when the menu item is active and the left arrow key is pressed. More...
void	HandleKeyRight ()
	Called when the menu item is active and the right arrow key is pressed. More...

Public Attributes
MenuItemType	item_type
	The type of menu item. See Blam::DebugMenu::MenuItemType for details. More...
std::string	title
	The title of the debug menu item as shown in the menu. More...
std::string	exec_line = ""
	The command to run upon activation for an Executor menu item type. More...
std::vector< MenuItem >	items
	The contents of the submenu to show upon activation. More...
std::string	global_id = ""
	The ID of the engine global to modify upon activation. More...
bool	use_bounds = false
	Whether or not arbitrary bounds are specified in debug_menu_init. More...
double	inc = 1
	How much to add or remove from the value at a time upon activation. More...
double	min = 0
	The minimum value specified in debug_menu_init. More...
double	max = 0
	The maximum value specified in debug_menu_init. More...
std::vector< std::string >	exec_sequence
	The command sequence to run upon activation for an ExecSequence menu item type. More...
int	current_exec_index = 0
	The index of the next item to run within the execution sequence. More...

Detailed Description

Class used to store data and functions relating to an item within the engine's debug menu.

Constructor & Destructor Documentation

MenuItem()

Blam::DebugMenu::MenuItem::MenuItem ( )

inline

Empty and unused constructor.

~MenuItem()

Blam::DebugMenu::MenuItem::~MenuItem ( )

inline

Empty and unused destructor.

Member Function Documentation

HandleKeyEnter()

void Blam::DebugMenu::MenuItem::HandleKeyEnter

(

)

Called when the menu item is active and the enter key is pressed.

HandleKeyLeft()

void Blam::DebugMenu::MenuItem::HandleKeyLeft

(

)

Called when the menu item is active and the left arrow key is pressed.

HandleKeyRight()

void Blam::DebugMenu::MenuItem::HandleKeyRight

(

)

Called when the menu item is active and the right arrow key is pressed.

SetupMenuItem()

void Blam::DebugMenu::MenuItem::SetupMenuItem ( MenuItemType  _type, std::string  _title  )

inline

Prepares the menu item for use.

Parameters

_type	- The type of menu item to treat this item as.
_title	- The title of this menu item.

Member Data Documentation

current_exec_index

int Blam::DebugMenu::MenuItem::current_exec_index = 0

The index of the next item to run within the execution sequence.

exec_line

std::string Blam::DebugMenu::MenuItem::exec_line = ""

The command to run upon activation for an Executor menu item type.

exec_sequence

std::vector<std::string> Blam::DebugMenu::MenuItem::exec_sequence

The command sequence to run upon activation for an ExecSequence menu item type.

global_id

std::string Blam::DebugMenu::MenuItem::global_id = ""

The ID of the engine global to modify upon activation.

inc

double Blam::DebugMenu::MenuItem::inc = 1

How much to add or remove from the value at a time upon activation.

item_type

MenuItemType Blam::DebugMenu::MenuItem::item_type

The type of menu item. See Blam::DebugMenu::MenuItemType for details.

items

std::vector<MenuItem> Blam::DebugMenu::MenuItem::items

The contents of the submenu to show upon activation.

max

double Blam::DebugMenu::MenuItem::max = 0

The maximum value specified in debug_menu_init.

min

double Blam::DebugMenu::MenuItem::min = 0

The minimum value specified in debug_menu_init.

title

std::string Blam::DebugMenu::MenuItem::title

The title of the debug menu item as shown in the menu.

use_bounds

bool Blam::DebugMenu::MenuItem::use_bounds = false

Whether or not arbitrary bounds are specified in debug_menu_init.

---

The documentation for this class was generated from the following files:

• blam/components/ui/blam_old/blam_ui.h
• blam/components/ui/blam_old/debug_menu.cpp