1. Epic GamesDeveloper
  3. URigVMTemplateNode

URigVMTemplateNode

The Template Node represents an unresolved function.

API > API/Plugins > API/Plugins/RigVMDeveloper

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

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

Syntax

UCLASS (MinimalAPI, BlueprintType)  
class URigVMTemplateNode : public URigVMNode

Inheritance Hierarchy

Derived Classes

URigVMTemplateNode derived class hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

URigVMTemplateNode()

 Default constructor RigVMModel/Nodes/RigVMTemplateNode.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

TArray< URigVMPin * > GetAggregatePins ( const ERigVMPinDirection& InDirection
) const

   RigVMModel/Nodes/RigVMTemplateNode.h  

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

 Returns a default value for pin if it is known RigVMModel/Nodes/RigVMTemplateNode.h  

virtual FName GetMethodName()

   RigVMModel/Nodes/RigVMTemplateNode.h  

virtual FName GetNotation()

 Returns the notation of the node. RigVMModel/Nodes/RigVMTemplateNode.h
  • BlueprintPure
  • Category=Template

const FRigVMFunction * GetResolvedFunction()

 Returns the resolved function or nullptr if there are still unresolved pins left RigVMModel/Nodes/RigVMTemplateNode.h  

TArray< int32 > GetResolvedPermutationIndices ( bool bAllowFloatingPointCasts
) const

 Returns the resolved permutation indices for the template RigVMModel/Nodes/RigVMTemplateNode.h  

TArray< const FRigVMFunction * > GetResolvedPermutations()

 Returns the resolved functions for the template RigVMModel/Nodes/RigVMTemplateNode.h  

virtual UScriptStruct * GetScriptStruct()

 Returns the UStruct for this unit node (the struct declaring the RIGVM_METHOD) RigVMModel/Nodes/RigVMTemplateNode.h
  • BlueprintCallable
  • Category=RigVMUnitNode

virtual const FRigVMTemplate * GetTemplate()

 Returns the template used for this node RigVMModel/Nodes/RigVMTemplateNode.h  

FRigVMTemplateTypeMap GetTemplatePinTypeMap ( bool bIncludeHiddenPins,
bool bIncludeExecutePins
) const

 Returns a map of the resolved pin types. RigVMModel/Nodes/RigVMTemplateNode.h  

bool IsFullyUnresolved()

 Returns true if the template is fully unresolved RigVMModel/Nodes/RigVMTemplateNode.h
  • BlueprintPure
  • Category=Template

bool IsResolved()

 Returns true if the template node is resolved RigVMModel/Nodes/RigVMTemplateNode.h
  • BlueprintPure
  • Category=Template

virtual bool IsSingleton()

   RigVMModel/Nodes/RigVMTemplateNode.h
  • BlueprintCallable
  • Category=Template

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

 Returns true if a pin supports a given type RigVMModel/Nodes/RigVMTemplateNode.h  

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

 Tries to reduce the input types to a single type, if all are compatible Will prioritize the InPreferredType if available RigVMModel/Nodes/RigVMTemplateNode.h  

Overridden from URigVMNode

Name Remarks Include Path Unreal Specifiers

virtual TArray< URigVMPin * > GetAggregateInputs()

   RigVMModel/Nodes/RigVMTemplateNode.h  

virtual TArray< URigVMPin * > GetAggregateOutputs()

   RigVMModel/Nodes/RigVMTemplateNode.h  

virtual FName GetDisplayNameForPin ( const URigVMPin* InPin
) const

 Returns the display name for a pin RigVMModel/Nodes/RigVMTemplateNode.h  

virtual FName GetNextAggregateName ( const FName& InLastAggregatePinName
) const

   RigVMModel/Nodes/RigVMTemplateNode.h  

virtual FString GetNodeTitle()

 Returns the title of this Node - used for UI. RigVMModel/Nodes/RigVMTemplateNode.h  

virtual uint32 GetStructureHash()

   RigVMModel/Nodes/RigVMTemplateNode.h  

virtual FText GetToolTipText()

 Returns the tooltip of this node. RigVMModel/Nodes/RigVMTemplateNode.h  

virtual FText GetToolTipTextForPin ( const URigVMPin* InPin
) const

   RigVMModel/Nodes/RigVMTemplateNode.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostLoad()

   RigVMModel/Nodes/RigVMTemplateNode.h  

virtual void PreSave ( FObjectPreSaveContext SaveContext
)

   RigVMModel/Nodes/RigVMTemplateNode.h  

Protected

Name Remarks Include Path Unreal Specifiers

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

   RigVMModel/Nodes/RigVMTemplateNode.h  

FRigVMTemplateTypeMap GetTypesForPermutation ( const int32 InPermutationIndex
) const

   RigVMModel/Nodes/RigVMTemplateNode.h  

Overridden from URigVMNode

Name Remarks Include Path Unreal Specifiers

virtual void InvalidateCache()

   RigVMModel/Nodes/RigVMTemplateNode.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
PreferredPermutationPairs_DEPRECATED TArray< FRigVMTemplatePreferredType >   RigVMModel/Nodes/RigVMTemplateNode.h  
PreferredPermutationTypes_DEPRECATED TArray< FString > Indicates a preferred permutation using the types of the arguments Each element is in the format "ArgumentName:CPPType" RigVMModel/Nodes/RigVMTemplateNode.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page