Blamite Game Engine - blam!  00296.01.12.21.0102.blamite
The core library for the Blamite Game Engine.
BlamDebugMenuItem Class Reference

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

#include <debug_menu.h>

Public Member Functions

 BlamDebugMenuItem ()
 Creates a new debug menu item. 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

BlamDebugMenuItemType item_type
 The type of menu item. See BlamDebugMenuItemType 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< 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...
 
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< BlamDebugMenuItemitems
 The contents of the submenu to show upon activation. More...
 

Detailed Description

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

Constructor & Destructor Documentation

◆ BlamDebugMenuItem()

BlamDebugMenuItem::BlamDebugMenuItem ( )

Creates a new debug menu item.

Member Function Documentation

◆ HandleKeyEnter()

void BlamDebugMenuItem::HandleKeyEnter ( )

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

◆ HandleKeyLeft()

void BlamDebugMenuItem::HandleKeyLeft ( )

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

◆ HandleKeyRight()

void BlamDebugMenuItem::HandleKeyRight ( )

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

Member Data Documentation

◆ current_exec_index

int BlamDebugMenuItem::current_exec_index = 0

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

◆ exec_line

std::string BlamDebugMenuItem::exec_line = ""

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

◆ exec_sequence

std::vector<std::string> BlamDebugMenuItem::exec_sequence

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

◆ global_id

std::string BlamDebugMenuItem::global_id = ""

The ID of the engine global to modify upon activation.

◆ inc

double BlamDebugMenuItem::inc = 1

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

◆ item_type

BlamDebugMenuItemType BlamDebugMenuItem::item_type

The type of menu item. See BlamDebugMenuItemType for details.

◆ items

std::vector<BlamDebugMenuItem> BlamDebugMenuItem::items

The contents of the submenu to show upon activation.

◆ max

double BlamDebugMenuItem::max = 0

The maximum value specified in debug_menu_init.

◆ min

double BlamDebugMenuItem::min = 0

The minimum value specified in debug_menu_init.

◆ title

std::string BlamDebugMenuItem::title

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

◆ use_bounds

bool BlamDebugMenuItem::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: