1. Epic GamesDeveloper
  3. FRigVMTemplate

FRigVMTemplate

The template is used to group multiple rigvm functions that share the same notation.

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 FRigVMTemplate

Remarks

The template is used to group multiple rigvm functions that share the same notation. Templates can then be used to build polymorphic nodes (RigVMTemplateNode) that can take on any of the permutations supported by the template.

Constructors

  Type Name Description
Public function   Default constructor.

Functions

  Type Name Description
Public function bool

AddTypeForArgument ( const FName& InArgumentName,
TRigVMTypeIndex InTypeIndex
)

 Adds a new argument to the template.
Public function Const bool

ArgumentSupportsTypeIndex ( const FName& InArgumentName,
TRigVMTypeIndex InTypeIndex,
TRigVMTypeIndex* OutTypeIndex
)

 Returns true if a given arg supports a type
Public function void

ComputeNotationFromArguments ( const FString& InTemplateName
)

 Recomputes the notation from its arguments
Public function Const bool

ContainsPermutation ( const FTypeMap& InTypes
)

 Returns true if the template was able to resolve to at least one permutation
Public function Const bool

ContainsPermutation ( const FRigVMFunction* InPermutation
)

 Returns true if a given function is a permutation of this template
Public function Const const FRigVMTemplateArgument *

FindArgument ( const FName& InArgumentName
)

 Returns an argument given a name (or nullptr)
Public function Const const FRigVMExecuteArgument *

FindExecuteArgument ( const FName& InArgumentName,
const FRigVMDispatchContext& InContext
)

 Returns an argument given a name (or nullptr)
Public function Const int32

FindPermutation ( const FRigVMFunction* InPermutation
)

 Returns the index of the permutation within the template of a given function (or INDEX_NONE)
Public function Const int32

FindPermutation ( const FTypeMap& InTypes
)

 Returns the index of the permutation within the template of a given set of types
Public function Const bool

FullyResolve ( FTypeMap& InOutTypes,
int32& OutPermutationIndex
)

 Returns true if the template was able to resolve to single permutation
Public function Const const FRigVMTemplateArgument *

GetArgument ( int32 InIndex
)

 Returns an argument for a given index
Public function Const FString

GetArgumentMetaData ( const FName& InArgumentName,
const FName& InMetaDataKey,
const TArray< int32 >& InPermutationIndices
)

 Returns meta data on the property of the permutations.
Public function Static FString Returns the notation of an argument
Public function Static const FString & Returns the prefix for an argument in the notation
Public function Const FTypeMap

GetArgumentTypesFromString ( const FString& InTypeString
)

 Converts the types provided by a string (like "A:float,B:int32") into a type map
Public function Const FString  
Public function Const FLinearColor

GetColor ( const TArray< int32 >& InPermutationIndices
)

 Returns the color based on the permutation's metadata.
Public function Const const FRigVMDispatchFactory * Returns the factory this template was created by.
Public function Const FText

GetDisplayNameForArgument ( const FName& InArgumentName,
const TArray< int32 >& InPermutationIndices
)

 Returns the display name text for an argument.
Public function Const const FRigVMExecuteArgument *

GetExecuteArgument ( int32 InIndex,
const FRigVMDispatchContext& InContext
)

 Returns an argument for a given index
Public function Const const UScriptStruct * Returns the top level execute context struct this template uses
Public function Const FString  
Public function Const FName

GetName ()

 Returns the name of the template.
Public function Const const FName & Returns the notation of this template.
Public function const FRigVMFunction *

GetOrCreatePermutation ( int32 InIndex
)

 Returns a permutation given an index and creates it using the backing factory if needed
Public function Const const FRigVMFunction *

GetPermutation ( int32 InIndex
)

 Returns a permutation given an index
Public function Const const FRigVMFunction * Returns the first / primary permutation of the template
Public function Static FString Converts the types provided to a string (like "A:float,B:int32")
Public function Static TArray< UStruct * >

GetSuperStructs ( UStruct* InStruct,
bool bIncludeLeaf
)

 Returns an array of structs in the inheritance order of a given struct
Public function Const FText

GetTooltipText ( const TArray< int32 >& InPermutationIndices
)

 Returns the tooltip based on the permutation's metadata.
Public function Const FRigVMTemplateTypeMap

GetTypesForPermutation ( const int32 InPermutationIndex
)

 Returns the types for a specific permutation
Public function Const uint32

GetTypesHashFromTypes ( const FTypeMap& InTypes
)

 Will return the hash of the input type map, if it is a valid type map.
Public function void Invalidates template permutations whenever a type such as a user defined struct is removed.
Public function Const bool

IsValid ()

 Returns true if this is a valid template
Public function Static bool Returns true if a given argument is valid for a template
Public function bool

Merge ( const FRigVMTemplate& InOther
)

 Returns true if this template can merge another one
Public function Const int32 Returns the number of args of this template
Public function Const int32 Returns the number of args of this template
Public function Const int32 Returns the number of permutations supported by this template
Public function FRigVMTemplate_NewArgumentTypeDelegate & Returns the delegate to be able to react to type changes dynamically.
Public function void  
Public function Const bool

Resolve ( FTypeMap& InOutTypes,
TArray< int32 >& OutPermutationIndices,
bool bAllowFloatingPointCasts
)

 Returns true if the template was able to resolve to at least one permutation
Public function Const bool

ResolveArgument ( const FName& InArgumentName,
const TRigVMTypeIndex InTypeIndex,
FTypeMap& InOutTypes
)

 Returns true if the template can resolve an argument to a new type
Public function void Serialize.
Public function Const bool

SupportsExecuteContextStruct ( const UScriptStruct* InExecuteContextStruct
)

 Returns true if this template supports a given execute context struct
Public function void

UpdateTypesHashToPermutation ( const int32& InPermutation
)

  
Public function Const bool Returns true if this template is backed by a dispatch factory.

Typedefs

Name Description
FTypeMap  
FTypePair  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page