URigVMUnitNode | Unreal Engine 5.7 Documentation

API > API/Plugins > API/Plugins/RigVMDeveloper

The Struct Node represents a Function Invocation of a RIGVM_METHOD declared on a USTRUCT. Struct Nodes have input / output pins for all struct UPROPERTY members.


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

Syntax

UCLASS (MinimalAPI, BlueprintType)  
class URigVMUnitNode : public URigVMTemplateNode

Inheritance Hierarchy

UObjectBase → UObjectBaseUtility → UObject → URigVMNode → URigVMTemplateNode → URigVMUnitNode

Variables

Protected

Name	Type	Remarks	Include Path	Unreal Specifiers
CachedEventName	TRigVMModelCachedValue< URigVMUnitNode, FName >		RigVMModel/Nodes/RigVMUnitNode.h

Functions

Public

Name	Remarks	Include Path	Unreal Specifiers
void ComputePinValueDifferences ( TSharedPtr< FStructOnScope > InCurrentInstance, TSharedPtr< FStructOnScope > InDesiredInstance, TMap< FString, FString >& OutNewPinDefaultValues ) const	Compares two struct instances and returns differences in pin values.	RigVMModel/Nodes/RigVMUnitNode.h
void ComputePinValueDifferences ( TSharedPtr< FStructOnScope > InDesiredInstance, TMap< FString, FString >& OutNewPinDefaultValues ) const	Compares a desired struct instance with the node's default and returns differences in pin values.	RigVMModel/Nodes/RigVMUnitNode.h
TSharedPtr< FStructOnScope > ConstructLiveStructInstance ( URigVMHost* InHost, int32 InSliceIndex ) const	Returns an instance of the struct with values backed by the memory of a currently running host.	RigVMModel/Nodes/RigVMUnitNode.h
T ConstructStructInstance ()	Returns a copy of the struct with the current values.	RigVMModel/Nodes/RigVMUnitNode.h
TSharedPtr< FStructOnScope > ConstructStructInstance ( bool bUseDefault ) const	Returns an instance of the struct with the current values.	RigVMModel/Nodes/RigVMUnitNode.h
FString GetStructDefaultValue()	Returns the default value for the struct as text.	RigVMModel/Nodes/RigVMUnitNode.h	BlueprintCallable Category=RigVMUnitNode
bool IsPartOfRuntime ()	Returns true if the node is part of the debugged runtime rig.	RigVMModel/Nodes/RigVMUnitNode.h
bool IsPartOfRuntime ( URigVMHost* InHost ) const	Returns true if the node is part of the debugged runtime rig.	RigVMModel/Nodes/RigVMUnitNode.h
bool UpdateHostFromStructInstance ( URigVMHost* InHost, TSharedPtr< FStructOnScope > InInstance, int32 InSliceIndex ) const	Updates the memory of a host to match a specific struct instance.	RigVMModel/Nodes/RigVMUnitNode.h

Overridden from URigVMTemplateNode

Name	Remarks	Include Path	Unreal Specifiers
virtual FName GetMethodName()	Returns the name of the declared RIGVM_METHOD.	RigVMModel/Nodes/RigVMUnitNode.h	BlueprintCallable Category=RigVMUnitNode
virtual UScriptStruct * GetScriptStruct()	Returns the UStruct for this unit node (the struct declaring the RIGVM_METHOD)	RigVMModel/Nodes/RigVMUnitNode.h

Overridden from URigVMNode

Name	Remarks	Include Path
virtual bool CanOnlyExistOnce()	Returns true if this node can only exist once in a graph.	RigVMModel/Nodes/RigVMUnitNode.h
virtual TArray< URigVMPin * > GetAggregateInputs()		RigVMModel/Nodes/RigVMUnitNode.h
virtual TArray< URigVMPin * > GetAggregateOutputs()		RigVMModel/Nodes/RigVMUnitNode.h
virtual const TArray< FName > & GetControlFlowBlocks()	Returns the names of the control flow blocks of this node	RigVMModel/Nodes/RigVMUnitNode.h
virtual FString GetDeprecatedMetadata()		RigVMModel/Nodes/RigVMUnitNode.h
virtual FName GetDisplayNameForPin ( const URigVMPin* InPin ) const	Returns the display name for a pin	RigVMModel/Nodes/RigVMUnitNode.h
virtual FName GetEventName()	Returns the name of the event.	RigVMModel/Nodes/RigVMUnitNode.h
virtual FName GetNextAggregateName ( const FName& InLastAggregatePinName ) const		RigVMModel/Nodes/RigVMUnitNode.h
virtual FString GetNodeSubTitle()	Get the subtitle of the node.	RigVMModel/Nodes/RigVMUnitNode.h
virtual FString GetNodeTitle()	Override node functions.	RigVMModel/Nodes/RigVMUnitNode.h
virtual uint32 GetStructureHash()		RigVMModel/Nodes/RigVMUnitNode.h
virtual TArray< FRigVMUserWorkflow > GetSupportedWorkflows ( ERigVMUserWorkflowType InType, const UObject* InSubject ) const	Returns all supported workflows of the node	RigVMModel/Nodes/RigVMUnitNode.h
virtual FText GetToolTipText()	Returns the tooltip of this node.	RigVMModel/Nodes/RigVMUnitNode.h
virtual FRigVMStructUpgradeInfo GetUpgradeInfo()		RigVMModel/Nodes/RigVMUnitNode.h
virtual const bool IsControlFlowBlockSliced ( const FName& InBlockName ) const	Returns true if a control flow block requires slicing	RigVMModel/Nodes/RigVMUnitNode.h
virtual bool IsDefinedAsConstant()	Returns true if the node is defined as non-varying.	RigVMModel/Nodes/RigVMUnitNode.h
virtual bool IsDefinedAsVarying()	Returns true if the node is defined as non-varying.	RigVMModel/Nodes/RigVMUnitNode.h
virtual bool IsOutDated()		RigVMModel/Nodes/RigVMUnitNode.h

Overridden from UObject

Name	Remarks	Include Path	Unreal Specifiers
virtual void PostLoad()		RigVMModel/Nodes/RigVMUnitNode.h

Protected

Name	Remarks	Include Path	Unreal Specifiers
void EnumeratePropertiesOnHostAndStructInstance ( URigVMHost* InHost, TSharedPtr< FStructOnScope > InInstance, bool bPreferLiterals, TFunction< void(const URigVMPin, const FProperty, uint8, const FProperty, ui..., int32 InSliceIndex ) const		RigVMModel/Nodes/RigVMUnitNode.h

Overridden from URigVMNode

Name	Remarks	Include Path	Unreal Specifiers
virtual FString GetOriginalDefaultValueForRootPin ( const URigVMPin* InRootPin ) const		RigVMModel/Nodes/RigVMUnitNode.h
virtual FText GetToolTipTextForPin ( const URigVMPin* InPin ) const		RigVMModel/Nodes/RigVMUnitNode.h
virtual bool ShouldInputPinComputeLazily ( const URigVMPin* InPin ) const		RigVMModel/Nodes/RigVMUnitNode.h

Navigation

Syntax

Inheritance Hierarchy

Variables

Protected

Functions

Public

Overridden from URigVMTemplateNode

Overridden from URigVMNode

Overridden from UObject

Protected

Overridden from URigVMNode