URigVMActionStack

The Action Stack can be used to track actions happening on a Graph.

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

RigVMDeveloper

Header

/Engine/Source/Developer/RigVMDeveloper/Public/RigVMModel/RigVMControllerActions.h

Include

#include "RigVMModel/RigVMControllerActions.h"

Syntax

class URigVMActionStack : public UObject

Remarks

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.

Functions

Name Description

Public function

void

 

AddAction

(
    const ActionType& InAction,
    bool bPerformMerge
)

Adds an action to the stack.

Public function

void

 

BeginAction

(
    T& InAction
)

Begins an action and opens a bracket / scope.

Public function

void

 

CancelAction

(
    ActionType& InAction
)

Cancels an action, closes a bracket / scope and discards all actions to this point.

Public function

bool

 

CancelUndoBracket()

Cancels an undo bracket / scope. This is primary useful for Python.

Public function

bool

 

CloseUndoBracket()

Closes an undo bracket / scope. This is primary useful for Python.

Public function

void

 

EndAction

(
    ActionType& InAction,
    bool bPerformMerge
)

Ends an action and closes a bracket / scope.

Public function

FRigVMGraphM...

 

OnModified()

Public function

bool

 

OpenUndoBracket

(
    const FString& InTitle
)

Opens an undo bracket / scope to record actions into. This is primary useful for Python.

Public function

bool

 

Redo

(
    URigVMController* InController
)

Pops the last action from the redo stack and perform redo on it.

Public function

bool

 

Undo

(
    URigVMController* InController
)

Pops the last action from the undo stack and perform undo on it.

Overridden from UObject

Name Description

Public function Virtual

void

 

PostTransacted

(
    const FTransactionObjectEvent& Tra...
)

Called after the object has been transacted in some way.
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss