Navigation
API > API/Plugins > API/Plugins/RigVMDeveloper > API/Plugins/RigVMDeveloper/RigVMModel
Inheritance Hierarchy
- FRigVMBaseAction
- FRigVMAddDecoratorAction
- FRigVMRemoveDecoratorAction
- FRigVMAddExposedPinAction
- FRigVMAddLinkAction
- FRigVMAddLocalVariableAction
- FRigVMBreakLinkAction
- FRigVMChangeLocalVariableDefaultValueAction
- FRigVMChangeLocalVariableTypeAction
- FRigVMChangePinTypeAction
- FRigVMCollapseNodesAction
- FRigVMExpandNodeAction
- FRigVMImportFromTextAction
- FRigVMInjectNodeIntoPinAction
- FRigVMEjectNodeFromPinAction
- FRigVMInsertArrayPinAction
- FRigVMMarkFunctionPublicAction
- FRigVMPromoteNodeAction
- FRigVMRemoveArrayPinAction
- FRigVMRemoveExposedPinAction
- FRigVMRemoveLocalVariableAction
- FRigVMRemoveNodesAction
- FRigVMRenameExposedPinAction
- FRigVMRenameLocalVariableAction
- FRigVMRenameNodeAction
- FRigVMRenameVariableAction
- FRigVMReplaceNodesAction
- FRigVMSetCommentTextAction
- FRigVMSetNodeCategoryAction
- FRigVMSetNodeColorAction
- FRigVMSetNodeDescriptionAction
- FRigVMSetNodeKeywordsAction
- FRigVMSetNodePositionAction
- FRigVMSetNodeSelectionAction
- FRigVMSetNodeSizeAction
- FRigVMSetPinDefaultValueAction
- FRigVMSetPinExpansionAction
- FRigVMSetPinIndexAction
- FRigVMSetPinWatchAction
- FRigVMSetRemappedVariableAction
References
| Module | RigVMDeveloper |
| Header | /Engine/Plugins/Runtime/RigVM/Source/RigVMDeveloper/Public/RigVMModel/RigVMControllerActions.h |
| Include | #include "RigVMModel/RigVMControllerActions.h" |
Syntax
USTRUCT&40;&41;
struct FRigVMBaseAction
Remarks
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.
Variables
| Type | Name | Description | |
|---|---|---|---|
| FSoftObjectPath | ControllerPath | ||
| TMap< FName, FRigVMActionNodeContent > | ExportedNodes | ||
| TArray< FRigVMActionKey > | SubActions | ||
| FString | Title | ||
| TWeakObjectPtr< URigVMController > | WeakController |
Constructors
| Type | Name | Description | |
|---|---|---|---|
| Empty constructor. | |||
FRigVMBaseAction
(
URigVMController* InController |
Default constructor. |
Destructors
| Type | Name | Description | |
|---|---|---|---|
| Default destructor. |
Functions
| Type | Name | Description | |
|---|---|---|---|
| void | AddAction
(
const ActionType& InAction |
Adds a child / sub action to this one. | |
| bool | CanUndoRedo () |
Returns true if this action can undo / redo. | |
| void | |||
| URigVMController * | Returns the controller of this action. | ||
| UScriptStruct * | Access to the actions script struct. this needs to be overloaded. | ||
| FString | GetTitle () |
Returns the title of the action - used for the Edit menu's undo / redo. | |
| bool | IsEmpty () |
Returns true if this action is empty has no effect. | |
| bool | MakesObsolete
(
const FRigVMBaseAction* Other |
Returns true if this action makes the other action obsolete. | |
| bool | Merge
(
const FRigVMBaseAction* Other |
Trys to merge the action with another action and returns true if successfull. | |
| bool | Redo () |
Re-does the action and returns true if successfull. | |
| bool | RestoreNode
(
const FName& InNodeName, |
||
| void | Sets the title of the action - used for the Edit menu's undo / redo. | ||
| bool | StoreNode
(
const URigVMNode* InNode, |
||
| bool | Undo () |
Un-does the action and returns true if successfull. |
Constants
| Name | Description |
|---|---|
| AddActionPrefix | |
| BeginActionPrefix | |
| CancelActionPrefix | |
| EndActionPrefix | |
| RedoPrefix | |
| UndoPrefix |