1. Epic GamesDeveloper
  3. URigVMUnitNode

URigVMUnitNode

The Struct Node represents a Function Invocation of a RIGVM_METHOD declared on a USTRUCT.

API > API/Plugins > API/Plugins/RigVMDeveloper > API/Plugins/RigVMDeveloper/RigVMModel > API/Plugins/RigVMDeveloper/RigVMModel/Nodes

Inheritance Hierarchy

References

   
Module RigVMDeveloper
Header /Engine/Plugins/Runtime/RigVM/Source/RigVMDeveloper/Public/RigVMModel/Nodes/RigVMUnitNode.h
Include #include "RigVMModel/Nodes/RigVMUnitNode.h"

Syntax

UCLASS (BlueprintType)  
class URigVMUnitNode : public URigVMTemplateNode

Remarks

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.

Functions

  Type Name Description
Public function Const void

ComputePinValueDifferences ( TSharedPtr< FStructOnScope > InCurrentInstance,
TSharedPtr< FStructOnScope > InDesiredInstance,
TMap< FString, FString >& OutNewPinDefaultValues
)

 Compares two struct instances and returns differences in pin values.
Public function Const void

ComputePinValueDifferences ( TSharedPtr< FStructOnScope > InDesiredInstance,
TMap< FString, FString >& OutNewPinDefaultValues
)

 Compares a desired struct instance with the node's default and returns differences in pin values.
Public function Const TSharedPtr< FStructOnScope >

ConstructLiveStructInstance ( URigVMHost* InHost,
int32 InSliceIndex
)

 Returns an instance of the struct with values backed by the memory of a currently running host.
Public function Const T Returns a copy of the struct with the current values.
Public function Const TSharedPtr< FStructOnScope >

ConstructStructInstance ( bool bUseDefault
)

 Returns an instance of the struct with the current values.
Protected function Const void

EnumeratePropertiesOnHostAndStructInstance ( URigVMHost* InHost,
TSharedPtr< FStructOnScope > InInstance,
bool bPreferLiterals,
TFunction< void(const URigVMPin*, const FProperty*, uint8*, const FProperty*, ui...,
int32 InSliceIndex
)

  
Public function Const UFunction BlueprintCallable, Category FString Returns the default value for the struct as text.
Public function Const bool Returns true if the node is part of the debugged runtime rig.
Public function Const bool Returns true if the node is part of the debugged runtime rig.
Public function Const bool

UpdateHostFromStructInstance ( URigVMHost* InHost,
TSharedPtr< FStructOnScope > InInstance,
int32 InSliceIndex
)

 Updates the memory of a host to match a specific struct instance.

Overridden from URigVMTemplateNode

  Type Name Description
Public function Virtual Const UFunction BlueprintCallable, Category FName Returns the name of the declared RIGVM_METHOD.
Public function Virtual Const UScriptStruct * Returns the UStruct for this unit node (the struct declaring the RIGVM_METHOD)
Public function Virtual void  

Overridden from URigVMNode

  Type Name Description
Public function Virtual Const bool Returns true if this node can only exist once in a graph.
Public function Virtual Const TArray< URigVMPin * >  
Public function Virtual Const TArray< URigVMPin * >  
Public function Virtual Const const TArray< FName > & Returns the names of the control flow blocks of this node
Public function Virtual Const FString  
Public function Virtual Const FName

GetDisplayNameForPin ( const FString& InPinPath
)

 Returns the display name for a pin
Public function Virtual Const FName Returns the name of the event.
Public function Virtual Const FName

GetNextAggregateName ( const FName& InLastAggregatePinName
)

  
Public function Virtual Const FString Override node functions.
Protected function Virtual Const FString  
Public function Virtual Const uint32  
Public function Virtual Const TArray< FRigVMUserWorkflow >

GetSupportedWorkflows ( ERigVMUserWorkflowType InType,
const UObject* InSubject
)

 Returns all supported workflows of the node
Public function Virtual Const FText Returns the tooltip of this node.
Protected function Virtual Const FText

GetToolTipTextForPin ( const URigVMPin* InPin
)

  
Public function Virtual Const FRigVMStructUpgradeInfo  
Public function Virtual Const const bool

IsControlFlowBlockSliced ( const FName& InBlockName
)

 Returns true if a control flow block requires slicing
Public function Virtual Const bool Returns true if the node is defined as non-varying.
Public function Virtual Const bool Returns true if the node is defined as non-varying.
Public function Virtual Const bool  
Protected function Virtual Const bool  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page