1. Epic GamesDeveloper
  3. URigVMTemplateNode

URigVMTemplateNode

The Template Node represents an unresolved function.

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/RigVMTemplateNode.h
Include #include "RigVMModel/Nodes/RigVMTemplateNode.h"

Syntax

UCLASS&40;BlueprintType&41;  
class URigVMTemplateNode : public URigVMNode

Remarks

The Template Node represents an unresolved function. Template nodes can morph into all functions implementing the template's template.

Variables

  Type Name Description
Protected variable const FRigVMFunction * CachedFunction  
Protected variable const FRigVMTemplate * CachedTemplate  
Protected variable UProperty FString ResolvedFunctionName  
Protected variable int32 ResolvedPermutation  
Protected variable UProperty FName TemplateNotation  

Constructors

  Type Name Description
Public function   Default constructor

Functions

  Type Name Description
Protected function Const TArray< int32 >

FindPermutationsForTypes ( const TArray< FRigVMTemplatePreferredType >& ArgumentTypes,
bool bAllowCasting
)

  
Public function Const TArray< URigVMPin * >

GetAggregatePins ( const ERigVMPinDirection& InDirection
)

  
Public function Const FName

GetDisplayNameForPin ( const FName& InRootPinName,
const TArray< int32 >& InPermutationIndices
)

 Returns the display name for a pin
Public function Const FString

GetInitialDefaultValueForPin ( const FName& InRootPinName,
const TArray< int32 >& InPermutationIndices
)

 Returns a default value for pin if it is known
Public function Virtual Const FName  
Public function Virtual Const UFunction BlueprintPure, Category FName Returns the notation of the node.
Public function Const const FRigVMFunction * Returns the resolved function or nullptr if there are still unresolved pins left
Public function Const TArray< int32 >

GetResolvedPermutationIndices ( bool bAllowFloatingPointCasts
)

 Returns the resolved permutation indices for the template
Public function Const TArray< const FRigVMFunction * > Returns the resolved functions for the template
Public function Virtual Const UFunction BlueprintCallable, Category UScriptStruct * Returns the UStruct for this unit node (the struct declaring the RIGVM_METHOD)
Public function Virtual Const const FRigVMTemplate * Returns the template used for this node
Public function Const FRigVMTemplateTypeMap

GetTemplatePinTypeMap ( bool bIncludeHiddenPins,
bool bIncludeExecutePins
)

 Returns a map of the resolved pin types.
Protected function Const FRigVMTemplateTypeMap

GetTypesForPermutation ( const int32 InPermutationIndex
)

  
Public function Const UFunction BlueprintPure, Category bool Returns true if the template is fully unresolved
Public function Const UFunction BlueprintPure, Category bool Returns true if the template node is resolved
Public function Virtual Const UFunction BlueprintCallable, Category bool  
Public function bool

SupportsType ( const URigVMPin* InPin,
TRigVMTypeIndex InTypeIndex,
TRigVMTypeIndex* OutTypeIndex
)

 Returns true if a pin supports a given type
Public function Const TRigVMTypeIndex

TryReduceTypesToSingle ( const TArray< TRigVMTypeIndex >& InTypes,
const TRigVMTypeIndex PreferredType
)

 Tries to reduce the input types to a single type, if all are compatible Will prioritize the InPreferredType if available

Overridden from URigVMNode

  Type Name Description
Public function Virtual Const TArray< URigVMPin * >  
Public function Virtual Const TArray< URigVMPin * >  
Public function Virtual Const FName

GetNextAggregateName ( const FName& InLastAggregatePinName
)

  
Public function Virtual Const FString Returns the title of this Node - used for UI.
Public function Virtual Const uint32  
Public function Virtual Const FText Returns the tooltip of this node.
Public function Virtual Const FText

GetToolTipTextForPin ( const URigVMPin* InPin
)

  
Protected function Virtual void  

Overridden from UObject

  Type Name Description
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void

PreSave ( FObjectPreSaveContext SaveContext
)

 Presave function.

Deprecated Variables

  Type Name Description
Protected variable UProperty TArray< FRigVMTemplatePreferredType > PreferredPermutationPairs_DEPRECATED  
Protected variable UProperty TArray< FString > PreferredPermutationTypes_DEPRECATED Indicates a preferred permutation using the types of the arguments Each element is in the format "ArgumentName:CPPType"

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page