Open 3D Engine EMotionFX Gem API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
MCore::CommandManager::CommandHistoryEntry Struct Reference

#include <MCoreCommandManager.h>

Public Member Functions

 CommandHistoryEntry (CommandGroup *group, Command *command, const CommandLine &parameters, size_t historyItemNr)
 
AZStd::string ToString () const
 

Static Public Member Functions

static AZStd::string ToString (CommandGroup *group, Command *command, size_t historyItemNr)
 

Public Attributes

CommandGroupm_commandGroup
 
Commandm_executedCommand
 
CommandLine m_parameters
 
size_t m_historyItemNr
 

Detailed Description

The command history entry stores all information which is relevant for a called command. This information is needed for the undo/redo usage.

Constructor & Destructor Documentation

◆ CommandHistoryEntry()

MCore::CommandManager::CommandHistoryEntry::CommandHistoryEntry ( CommandGroup group,
Command command,
const CommandLine parameters,
size_t  historyItemNr 
)

Extended Constructor.

Parameters
groupThe command group pointer. When set to nullptr it will use the single command object instead of the group.
commandThe command instance that has been created at execution time. When set to nullptr it will assume it is a group, and it will use the group you specified.
parametersThe command arguments.

Member Data Documentation

◆ m_commandGroup

CommandGroup* MCore::CommandManager::CommandHistoryEntry::m_commandGroup

A pointer to the command group, or nullptr when no group is used (in that case it uses a single command).

◆ m_executedCommand

Command* MCore::CommandManager::CommandHistoryEntry::m_executedCommand

A pointer to the command object, or nullptr when no command is used (in that case it uses a group).

◆ m_historyItemNr

size_t MCore::CommandManager::CommandHistoryEntry::m_historyItemNr

The global history item number. This number will neither change depending on the size of the history queue nor with undo/redo.

◆ m_parameters

CommandLine MCore::CommandManager::CommandHistoryEntry::m_parameters

The used command arguments, unused in case no command is used (in that case it uses a group).


The documentation for this struct was generated from the following file: