URigVMActionStack | Unreal Engine 5.7 Documentation

API > API/Plugins > API/Plugins/RigVMDeveloper

The Action Stack can be used to track actions happening on a Graph. Currently the only owner of the ActionStack is the Controller. Actions can be added to the stack, or they can be understood as scopes / brackets. For this you can use BeginAction / EndAction / CancelAction to open / close a bracket. Open brackets automatically record additional actions occuring during the bracket's lifetime.


Name	URigVMActionStack
Type	class
Header File	/Engine/Plugins/Runtime/RigVM/Source/RigVMDeveloper/Public/RigVMModel/RigVMControllerActions.h
Include Path	#include "RigVMModel/RigVMControllerActions.h"

Syntax

UCLASS (MinimalAPI)  
class URigVMActionStack : public UObject

Inheritance Hierarchy

UObjectBase → UObjectBaseUtility → UObject → URigVMActionStack

Destructors

Name	Remarks	Include Path	Unreal Specifiers
virtual ~URigVMActionStack()		RigVMModel/RigVMControllerActions.h

Variables

Protected

Name	Type	Include Path	Unreal Specifiers
ActionIndex	int32	RigVMModel/RigVMControllerActions.h
BracketActions	TArray< FRigVMBaseAction * >	RigVMModel/RigVMControllerActions.h
CurrentActions	TArray< FRigVMBaseAction * >	RigVMModel/RigVMControllerActions.h
ModifiedEvent	FRigVMGraphModifiedEvent	RigVMModel/RigVMControllerActions.h
RedoActions	TArray< FRigVMActionKey >	RigVMModel/RigVMControllerActions.h	NonTransactional
UndoActions	TArray< FRigVMActionKey >	RigVMModel/RigVMControllerActions.h	NonTransactional

Functions

Public

Name	Remarks	Include Path
void AddAction ( const ActionType& InAction, bool bPerformMerge, bool bMarkDirty )	Adds an action to the stack.	RigVMModel/RigVMControllerActions.h
void BeginAction ( ActionType& InAction )	Begins an action and opens a bracket / scope.	RigVMModel/RigVMControllerActions.h
void CancelAction ( ActionType& InAction )	Cancels an action, closes a bracket / scope and discards all actions to this point.	RigVMModel/RigVMControllerActions.h
bool CancelUndoBracket ( URigVMController* InController )	Cancels an undo bracket / scope. This is primary useful for Python.	RigVMModel/RigVMControllerActions.h
bool CloseUndoBracket ( URigVMController* InController )	Closes an undo bracket / scope. This is primary useful for Python.	RigVMModel/RigVMControllerActions.h
void EndAction ( ActionType& InAction, bool bPerformMerge )	Ends an action and closes a bracket / scope.	RigVMModel/RigVMControllerActions.h
FRigVMGraphModifiedEvent & OnModified()		RigVMModel/RigVMControllerActions.h
bool OpenUndoBracket ( URigVMController* InController, const FString& InTitle )	Opens an undo bracket / scope to record actions into. This is primary useful for Python.	RigVMModel/RigVMControllerActions.h
bool Redo ( URigVMController* InController )	Pops the last action from the redo stack and perform redo on it.	RigVMModel/RigVMControllerActions.h
bool Undo ( URigVMController* InController )	Pops the last action from the undo stack and perform undo on it.	RigVMModel/RigVMControllerActions.h

Overridden from UObject

Name	Remarks	Include Path	Unreal Specifiers
virtual void PostTransacted ( const FTransactionObjectEvent& TransactionEvent )		RigVMModel/RigVMControllerActions.h

Static

Name	Remarks	Include Path	Unreal Specifiers
static URigVMActionStack * GetDisabledActionStack()		RigVMModel/RigVMControllerActions.h

Navigation