1. Epic GamesDeveloper
  3. FRigVMTemplateArgument

FRigVMTemplateArgument

The template argument represents a single parameter in a function call and all of its possible types

API > API/Plugins > API/Plugins/RigVM > API/Plugins/RigVM/RigVMCore

References

   
Module RigVM
Header /Engine/Plugins/Runtime/RigVM/Source/RigVM/Public/RigVMCore/RigVMTemplate.h
Include #include "RigVMCore/RigVMTemplate.h"

Syntax

struct FRigVMTemplateArgument

Remarks

The template argument represents a single parameter in a function call and all of its possible types

Variables

  Type Name Description
Protected variable bool bUseCategories  
Protected variable ERigVMPinDirection Direction  
Protected variable TFunction< bool(const TRigVMTypeIndex &)> FilterType  
Protected variable int32 Index  
Protected variable FName Name  
Protected variable TArray< ETypeCategory > TypeCategories  
Protected variable TArray< TRigVMTypeIndex > TypeIndices  
Protected variable TMap< TRigVMTypeIndex, TArray< int32 > > TypeToPermutations  

Constructors

  Type Name Description
Public function   Default constructor
Protected function  

FRigVMTemplateArgument ( FProperty* InProperty
)

  
Public function  

FRigVMTemplateArgument ( const FName& InName,
ERigVMPinDirection InDirection
)

  
Protected function  

FRigVMTemplateArgument ( FProperty* InProperty,
FRigVMRegistry& InRegistry
)

 Constructor from a property. this forces the type to be created
Public function  

FRigVMTemplateArgument ( const FName& InName,
ERigVMPinDirection InDirection,
TRigVMTypeIndex InType
)

  
Public function  

FRigVMTemplateArgument ( const FName& InName,
ERigVMPinDirection InDirection,
const TArray< TRigVMTypeIndex >& InTypeIndices
)

  
Public function  

FRigVMTemplateArgument ( const FName& InName,
ERigVMPinDirection InDirection,
const TArray< ETypeCategory >& InTypeCategories,
TFunction< bool(const TRigVMTypeIndex&)> InFilterType
)

  

Functions

  Type Name Description
Public function void

AddTypeIndex ( const TRigVMTypeIndex InTypeIndex
)

  
Protected function void  
Public function Const int32

FindTypeIndex ( const TRigVMTypeIndex InTypeIndex
)

  
Public function Const void

ForEachType ( TFunction< bool(const TRigVMTypeIndex InType)>&& InCallback
)

  
Public function Const void Returns the flat list of types (including duplicates) of this argument
Public function Const EArrayType Returns true if the argument uses an array container
Public function Const ERigVMPinDirection Returns the direction of the argument
Public function Const const FName &

GetName ()

 Returns the name of the argument
Public function Const int32  
Public function Const const TArray< int32 > &

GetPermutations ( const TRigVMTypeIndex InType
)

 Get the map of types to permutation indices.
Public function Const TArray< TRigVMTypeIndex >

GetSupportedTypeIndices ( const TArray< int32 >& InPermutationIndices
)

 Returns an array of all of the supported types
Public function Const TArray< FString >

GetSupportedTypeStrings ( const TArray< int32 >& InPermutationIndices
)

 Returns an array of all supported types as strings. this is used for automated testing only.
Public function Const TRigVMTypeIndex

GetTypeIndex ( const int32 InIndex
)

  
Public function Const int32

IndexOfByPredicate ( Predicate Pred
)

  
Public function void  
Public function Const bool Returns true if this argument is an execute
Public function Const bool

IsSingleton ( const TArray< int32 >& InPermutationIndices
)

 Returns true if an argument is singleton (same type for all variants)
Public function void

RemoveType ( const int32 InIndex
)

  
Public function Const bool

SupportsTypeIndex ( TRigVMTypeIndex InTypeIndex,
TRigVMTypeIndex* OutTypeIndex
)

 Returns true if this argument supports a given type across a set of permutations
Protected function void  

Enums

  Type Name Description
Public enum EArrayType    
Public enum ETypeCategory    

Typedefs

Name Description
FTypeFilter  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page