Elaztek Developer Hub
Blamite Game Engine - blam!  00423.10.27.24.0533.blamite
The core library for the Blamite Game Engine.
BlamDebugMenuItem_CommandSequence Class Reference

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

#include <debug_menu.h>

+ Inheritance diagram for BlamDebugMenuItem_CommandSequence:
+ Collaboration diagram for BlamDebugMenuItem_CommandSequence:

Public Member Functions

 BlamDebugMenuItem_CommandSequence ()
 
void Activate () override
 Called when the menu item is active and the enter 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...
 
virtual void Decrement ()
 Called when the menu item is active and the left arrow key is pressed. More...
 
virtual void Increment ()
 Called when the menu item is active and the right arrow key is pressed. More...
 

Public Attributes

std::vector< std::string > commands = std::vector<std::string>()
 The command sequence to run upon activation. More...
 
int current_exec_index = 0
 The index of the next item to run within the command sequence. 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 command debug menu item.

Command items are used to execute a sequence of commands upon activation (ie, pressing Enter). When activated, one command within the list at a time is executed. This can be used to cycle through a series of different command parameters, for instance.

Constructor & Destructor Documentation

◆ BlamDebugMenuItem_CommandSequence()

BlamDebugMenuItem_CommandSequence::BlamDebugMenuItem_CommandSequence ( )

Member Function Documentation

◆ Activate()

void BlamDebugMenuItem_CommandSequence::Activate ( )
overridevirtual

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

For command sequences, this will activate the current command specified by current_exec_index, and prepare the next command to be executed.

Reimplemented from BlamDebugMenuItem.

+ Here is the call graph for this function:

Member Data Documentation

◆ commands

std::vector<std::string> BlamDebugMenuItem_CommandSequence::commands = std::vector<std::string>()

The command sequence to run upon activation.

◆ current_exec_index

int BlamDebugMenuItem_CommandSequence::current_exec_index = 0

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


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