BlamDebugMenuItem_Global Class Reference

Class representing a global debug menu item. More...

#include <debug_menu.h>

Inheritance diagram for BlamDebugMenuItem_Global:

Collaboration diagram for BlamDebugMenuItem_Global:

Public Member Functions
	BlamDebugMenuItem_Global ()
void	Activate () override
	Called when the menu item is active and the enter key is pressed. More...
void	Decrement () override
	Called when the menu item is active and the left arrow key is pressed. More...
void	Increment () override
	Called when the menu item is active and the right arrow key is pressed. More...
Public Member Functions inherited from BlamDebugMenuItem
	BlamDebugMenuItem (BlamDebugMenuItemType _type)
	Creates a new debug menu item. More...
BlamDebugMenuItemType	GetType ()
	Retrieves the type of the debug menu item. More...

Public Attributes
std::string	global_id = ""
	The ID of the engine global to update. More...
bool	use_bounds = false
	Whether or not the min/max bounds should be used. More...
double	inc = 1
	The amount to increase or decrease the global value by when incrementing or decrementing. More...
double	min = 0
	The minimum value of the global. More...
double	max = 0
	The maximum value of the global. More...
Public Attributes inherited from BlamDebugMenuItem
std::string	title = ""
	The title of the debug menu item as shown in the menu. More...

Detailed Description

Class representing a global debug menu item.

Global items are used to directly modify the value of an engine global.

Constructor & Destructor Documentation

BlamDebugMenuItem_Global()

BlamDebugMenuItem_Global::BlamDebugMenuItem_Global

(

)

Member Function Documentation

Activate()

void BlamDebugMenuItem_Global::Activate ( )

overridevirtual

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

For globals, this will increase the global's value by inc.

Reimplemented from BlamDebugMenuItem.

Here is the call graph for this function:

Decrement()

void BlamDebugMenuItem_Global::Decrement ( )

overridevirtual

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

For globals, this will decrease the global's value by inc.

Reimplemented from BlamDebugMenuItem.

Here is the call graph for this function:

Increment()

void BlamDebugMenuItem_Global::Increment ( )

overridevirtual

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

For globals, this will increase the global's value by inc.

Reimplemented from BlamDebugMenuItem.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

global_id

std::string BlamDebugMenuItem_Global::global_id = ""

The ID of the engine global to update.

inc

double BlamDebugMenuItem_Global::inc = 1

The amount to increase or decrease the global value by when incrementing or decrementing.

max

double BlamDebugMenuItem_Global::max = 0

The maximum value of the global.

min

double BlamDebugMenuItem_Global::min = 0

The minimum value of the global.

use_bounds

bool BlamDebugMenuItem_Global::use_bounds = false

Whether or not the min/max bounds should be used.

---

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

• blam/components/resources/debug_menu/debug_menu.h
• blam/components/resources/debug_menu/types/BlamDebugMenuItem_Global.cpp