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

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

   
Name FRigVMTemplateArgument
Type struct
Header File /Engine/Plugins/Runtime/RigVM/Source/RigVM/Public/RigVMCore/RigVMTemplate.h
Include Path #include "RigVMCore/RigVMTemplate.h"

Syntax

struct FRigVMTemplateArgument

Constructors

Name Remarks Include Path Unreal Specifiers
Constructor from a property. this forces the type to be created RigVMCore/RigVMTemplate.h  

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

   RigVMCore/RigVMTemplate.h  

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

   RigVMCore/RigVMTemplate.h  

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

   RigVMCore/RigVMTemplate.h  

FRigVMTemplateArgument ( const FName& InName,
ERigVMPinDirection InDirection
)

   RigVMCore/RigVMTemplate.h  
Default constructor RigVMCore/RigVMTemplate.h  

Structs

Name Remarks
CategoryViews  

Enums

Public

Name Remarks
EArrayType  
ETypeCategory  

Typedefs

Name Type Remarks Include Path
FTypeFilter TBaseDelegate_OneParam< bool, const TRigVMTypeIndex & >   RigVMCore/RigVMTemplate.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddTypeIndex ( const TRigVMTypeIndex InTypeIndex
)

   RigVMCore/RigVMTemplate.h  

int32 FindTypeIndex ( const TRigVMTypeIndex InTypeIndex
) const

   RigVMCore/RigVMTemplate.h  

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

   RigVMCore/RigVMTemplate.h  

void GetAllTypes ( TArray< TRigVMTypeIndex >& OutTypes,
const bool bLockRegistry
) const

 Returns the flat list of types (including duplicates) of this argument RigVMCore/RigVMTemplate.h  

void GetAllTypes_NoLock ( TArray< TRigVMTypeIndex >& OutTypes
) const

   RigVMCore/RigVMTemplate.h  

EArrayType GetArrayType ( const bool bLockRegistry
) const

 Returns true if the argument uses an array container RigVMCore/RigVMTemplate.h  

EArrayType GetArrayType_NoLock()

   RigVMCore/RigVMTemplate.h  

ERigVMPinDirection GetDirection()

 Returns the direction of the argument RigVMCore/RigVMTemplate.h  

const FName & GetName()

 Returns the name of the argument RigVMCore/RigVMTemplate.h  

int32 GetNumTypes()

   RigVMCore/RigVMTemplate.h  

int32 GetNumTypes_NoLock()

   RigVMCore/RigVMTemplate.h  

const TArray< int32 > & GetPermutations ( const TRigVMTypeIndex InType,
bool bLockRegistry
) const

 Get the map of types to permutation indices. RigVMCore/RigVMTemplate.h  

const TArray< int32 > & GetPermutations_NoLock ( const TRigVMTypeIndex InType
) const

   RigVMCore/RigVMTemplate.h  

TArray< TRigVMTypeIndex > GetSupportedTypeIndices ( const TArray< int32 >& InPermutationIndices
) const

 Returns an array of all of the supported types RigVMCore/RigVMTemplate.h  

TArray< FString > GetSupportedTypeStrings ( const TArray< int32 >& InPermutationIndices
) const

 Returns an array of all supported types as strings. this is used for automated testing only. RigVMCore/RigVMTemplate.h  

TRigVMTypeIndex GetTypeIndex ( const int32 InIndex,
const bool bLockRegistry
) const

   RigVMCore/RigVMTemplate.h  

TRigVMTypeIndex GetTypeIndex_NoLock ( const int32 InIndex
) const

   RigVMCore/RigVMTemplate.h  

int32 IndexOfByPredicate ( Predicate Pred
) const

   RigVMCore/RigVMTemplate.h  

void InvalidatePermutations ( const TRigVMTypeIndex InType
)

   RigVMCore/RigVMTemplate.h  

bool IsExecute()

 Returns true if this argument is an execute RigVMCore/RigVMTemplate.h  

bool IsExecute_NoLock ( const FRigVMRegistry_NoLock& InRegistry
) const

   RigVMCore/RigVMTemplate.h  

bool IsSingleton ( const TArray< int32 >& InPermutationIndices,
const bool bLockRegistry
) const

 Returns true if an argument is singleton (same type for all variants) RigVMCore/RigVMTemplate.h  

bool IsSingleton_NoLock ( const TArray< int32 >& InPermutationIndices
) const

   RigVMCore/RigVMTemplate.h  

void RemoveType ( const int32 InIndex
)

   RigVMCore/RigVMTemplate.h  

bool SupportsTypeIndex ( TRigVMTypeIndex InTypeIndex,
TRigVMTypeIndex* OutTypeIndex,
const bool bLockRegistry
) const

 Returns true if this argument supports a given type across a set of permutations RigVMCore/RigVMTemplate.h  

bool SupportsTypeIndex_NoLock ( TRigVMTypeIndex InTypeIndex,
TRigVMTypeIndex* OutTypeIndex
) const

   RigVMCore/RigVMTemplate.h  

TOptional< TRigVMTypeIndex > TryToGetTypeIndex ( const int32 InIndex,
const bool bLockRegistry
) const

   RigVMCore/RigVMTemplate.h  

TOptional< TRigVMTypeIndex > TryToGetTypeIndex_NoLock ( const int32 InIndex
) const

   RigVMCore/RigVMTemplate.h  

Protected

Name Remarks Include Path Unreal Specifiers

void EnsureValidExecuteType_NoLock ( FRigVMRegistry_NoLock& InRegistry
)

   RigVMCore/RigVMTemplate.h  

void UpdateTypeToPermutationsSlow()

   RigVMCore/RigVMTemplate.h  

Static

Name Remarks Include Path Unreal Specifiers

static FRigVMTemplateArgument Make ( FProperty* InProperty
)

 Static make function using a lock to create it RigVMCore/RigVMTemplate.h  
Static make function using a lock to create it RigVMCore/RigVMTemplate.h  
  RigVMCore/RigVMTemplate.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page