Navigation
API > API/Plugins > API/Plugins/RigVMDeveloper
The base action is the base struct for all actions, and provides access to sub actions, merge functionality as well as undo and redo base implementations.
| Name | FRigVMBaseAction |
| Type | struct |
| Header File | /Engine/Plugins/Runtime/RigVM/Source/RigVMDeveloper/Public/RigVMModel/RigVMControllerActions.h |
| Include Path | #include "RigVMModel/RigVMControllerActions.h" |
Syntax
USTRUCT ()
struct FRigVMBaseAction
Derived Classes
FRigVMBaseAction derived class hierarchy
- FRigVMAddExposedPinAction
- FRigVMAddFunctionVariantTagAction
- FRigVMAddLinkAction
- FRigVMAddLocalVariableAction
- FRigVMAddTraitAction
- FRigVMBreakLinkAction
- FRigVMChangeLocalVariableDefaultValueAction
- FRigVMChangeLocalVariableTypeAction
- FRigVMChangeNodePinCategoriesAction
- FRigVMChangePinTypeAction
- FRigVMCollapseNodesAction
- FRigVMCreateFunctionVariantAction
- FRigVMExpandNodeAction
- FRigVMImportFromTextAction
- FRigVMInjectNodeIntoPinAction
- FRigVMInsertArrayPinAction
- FRigVMMarkFunctionPublicAction
- FRigVMPromoteNodeAction
- FRigVMRemoveArrayPinAction
- FRigVMRemoveExposedPinAction
- FRigVMRemoveFunctionVariantTagAction
- FRigVMRemoveLocalVariableAction
- FRigVMRemoveNodesAction
- FRigVMRenameExposedPinAction
- FRigVMRenameLocalVariableAction
- FRigVMRenameNodeAction
- FRigVMRenameVariableAction
- FRigVMReplaceNodesAction
- FRigVMSetCommentTextAction
- FRigVMSetNodeCategoryAction
- FRigVMSetNodeColorAction
- FRigVMSetNodeDescriptionAction
- FRigVMSetNodeKeywordsAction
- FRigVMSetNodePositionAction
- FRigVMSetNodeSelectionAction
- FRigVMSetNodeSizeAction
- FRigVMSetNodeTitleAction
- FRigVMSetPinCategoryAction
- FRigVMSetPinCategoryExpansionAction
- FRigVMSetPinDefaultValueAction
- FRigVMSetPinDisplayNameAction
- FRigVMSetPinExpansionAction
- FRigVMSetPinIndexAction
- FRigVMSetPinIndexInCategoryAction
- FRigVMSetPinWatchAction
- FRigVMSetRemappedVariableAction
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Empty constructor. | RigVMModel/RigVMControllerActions.h | ||
FRigVMBaseAction
(
URigVMController* InController |
Default constructor. | RigVMModel/RigVMControllerActions.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FRigVMBaseAction() |
Default destructor. | RigVMModel/RigVMControllerActions.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| AddActionPrefix | const TCHAR * | RigVMModel/RigVMControllerActions.h | |
| BeginActionPrefix | const TCHAR * | RigVMModel/RigVMControllerActions.h | |
| CancelActionPrefix | const TCHAR * | RigVMModel/RigVMControllerActions.h | |
| EndActionPrefix | const TCHAR * | RigVMModel/RigVMControllerActions.h | |
| RedoPrefix | const TCHAR * | RigVMModel/RigVMControllerActions.h | |
| UndoPrefix | const TCHAR * | RigVMModel/RigVMControllerActions.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddAction
(
const ActionType& InAction |
Adds a child / sub action to this one. | RigVMModel/RigVMControllerActions.h | |
bool CanUndoRedo() |
Returns true if this action can undo / redo. | RigVMModel/RigVMControllerActions.h | |
URigVMController * GetController() |
Returns the controller of this action. | RigVMModel/RigVMControllerActions.h | |
virtual UScriptStruct * GetScriptStruct() |
Access to the actions script struct. this needs to be overloaded. | RigVMModel/RigVMControllerActions.h | |
virtual FString GetTitle() |
Returns the title of the action - used for the Edit menu's undo / redo. | RigVMModel/RigVMControllerActions.h | |
virtual bool IsEmpty() |
Returns true if this action is empty has no effect. | RigVMModel/RigVMControllerActions.h | |
virtual bool MakesObsolete
(
const FRigVMBaseAction* Other |
Returns true if this action makes the other action obsolete. | RigVMModel/RigVMControllerActions.h | |
virtual bool Merge
(
const FRigVMBaseAction* Other |
Trys to merge the action with another action and returns true if successfull. | RigVMModel/RigVMControllerActions.h | |
virtual bool Redo() |
Re-does the action and returns true if successfull. | RigVMModel/RigVMControllerActions.h | |
bool RestoreNode
(
const FName& InNodeName, |
RigVMModel/RigVMControllerActions.h | ||
virtual void SetTitle
(
const FString& InTitle |
Sets the title of the action - used for the Edit menu's undo / redo. | RigVMModel/RigVMControllerActions.h | |
bool StoreNode
(
const URigVMNode* InNode, |
RigVMModel/RigVMControllerActions.h | ||
virtual bool Undo() |
Un-does the action and returns true if successfull. | RigVMModel/RigVMControllerActions.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void EnsureControllerValidity() |
RigVMModel/RigVMControllerActions.h |