1. Epic GamesDeveloper
  3. FRigVMDispatchFactory

FRigVMDispatchFactory

A factory to generate a template and its dispatch functions

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

Inheritance Hierarchy

References

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

Syntax

USTRUCT ()  
struct FRigVMDispatchFactory

Remarks

A factory to generate a template and its dispatch functions

Variables

  Type Name Description
Protected variable TMap< int32, TSharedPtr< TArray< FName > > > ArgumentNamesMap  
Protected variable FCriticalSection * ArgumentNamesMutex  
Protected variable const FRigVMTemplate * CachedTemplate  
Protected variable UScriptStruct * FactoryScriptStruct  

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Protected function Const TArray< FRigVMTemplateArgumentInfo >

BuildArgumentListFromPrimaryArgument ( const TArray< FRigVMTemplateArgumentInfo >& InInfos,
const FName& InPrimaryArgumentName
)

 For each type defined in the primary argument, this function will call GetPermutationsFromArgumentType to construct an array of arguments with the appropiate permutations
Protected function Const bool

CheckArgumentType ( bool bCondition,
const FName& InArgumentName
)

  
Protected function Static bool

CopyProperty ( const FProperty* InTargetProperty,
uint8* InTargetPtr,
const FProperty* InSourceProperty,
const uint8* InSourcePtr
)

  
Protected function Const FRigVMFunctionPtr  
Protected function Const FRigVMFunctionPtr  
Protected function Const TArray< FRigVMFunction >  
Protected function Const TArray< FRigVMFunction >  
Public function Virtual Const TArray< FName > Returns the names of the input aggregate arguments
Public function Virtual Const TArray< FName > Returns the names of the output aggregate arguments
Public function Virtual Const FString

GetArgumentDefaultValue ( const FName& InArgumentName,
TRigVMTypeIndex InTypeIndex
)

 Returns the default value for an argument
Public function Virtual Const const TArray< FRigVMTemplateArgumentInfo > & Returns the arguments of the template
Public function Virtual Const FString

GetArgumentMetaData ( const FName& InArgumentName,
const FName& InMetaDataKey
)

 Returns meta data on the property of the permutations.
Public function Virtual Const FName

GetArgumentNameForOperandIndex ( int32 InOperandIndex,
int32 InTotalOperands
)

 Returns the name to use for the branch info / argument based on the operand index.
Public function Virtual Const FText

GetArgumentTooltip ( const FName& InArgumentName,
TRigVMTypeIndex InTypeIndex
)

 Returns the tooltip for an argument
Public function Virtual Const FString Returns the category this factory is under.
Public function Const const TArray< FName > & Returns the control flow blocks of this dispatch
Protected function Virtual Const const TArray< FName > &  
Protected function Static FString

GetDefaultValueForStruct ( const T& InValue
)

  
Protected function Static FString

GetDefaultValueForStruct ( const T& InValue
)

  
Protected function Virtual Const FRigVMFunctionPtr  
Protected function Virtual Const TArray< FRigVMFunction >  
Public function Virtual Const FName

GetDisplayNameForArgument ( const FName& InArgumentName
)

 Returns the display name text for an argument.
Public function Const TArray< FRigVMExecuteArgument > Returns the execute arguments of the template
Protected function Virtual Const const TArray< FRigVMExecuteArgument > &  
Public function Virtual Const UScriptStruct * Returns the execute context support for this dispatch factory.
Public function Const FName Returns the name of the factory template
Public function Virtual Const FString Returns the keywords used for looking up this factory.
Public function Virtual Const FName

GetNextAggregateName ( const FName& InLastAggregatePinName
)

 Returns the next name to be used for an aggregate pin
Public function Virtual Const FLinearColor Returns the color of the node for a given type set.
Public function Virtual Const FString

GetNodeTitle ( const FRigVMTemplateTypeMap& InTypes
)

 Returns the title of the node for a given type set.
Public function Virtual Const FText Returns the tooltip for the node
Public function Const FRigVMFunctionPtr Returns the dispatch function for a given type set
Public function Const FString Returns the name of the permutation for a given set of types
Protected function Const FString Returns the name of the permutation for a given set of types
Public function Virtual Const bool

GetPermutationsFromArgumentType ( const FName& InArgumentName,
const TRigVMTypeIndex& InTypeIndex,
TArray< FRigVMTemplateTypeMap, TInlineAllocator< 1 > >& OutPermutations
)

 Returns the new permutations argument types after a new type is defined for one argument
Public function Const UScriptStruct * Returns the struct for this dispatch factory
Public function Const const FRigVMTemplate * Builds and returns the template
Public function Const FName Returns the name of the factory template
Public function Virtual Const FRigVMStructUpgradeInfo

GetUpgradeInfo ( const FRigVMTemplateTypeMap& InTypes,
const FRigVMDispatchContext& InContext
)

 Returns the upgrade info to use for this factory
Public function Const bool

HasArgumentMetaData ( const FName& InArgumentName,
const FName& InMetaDataKey
)

 Returns true if the factory provides metadata for a given argument.
Public function Virtual Const const bool

IsControlFlowBlockSliced ( const FName& InBlockName
)

 Returns true if a given control flow block needs to be sliced
Public function Const bool Returns true if the dispatch is a control flow dispatch
Public function Const bool

IsLazyInputArgument ( const FName& InArgumentName
)

 Returns true if the argument is lazy.
Public function Virtual Const bool Returns true if the dispatch uses the same function ptr for all permutations
Public function Virtual Const FRigVMTemplateTypeMap

OnNewArgumentType ( const FName& InArgumentName,
TRigVMTypeIndex InTypeIndex
)

 This function is deprecated, please use GetPermutationsFromArgumentType returns the new permutation argument types after a new type is defined for one argument this happens if types are being loaded later after this factory has already been deployed (like UUserDefinedStruct)
Public function Virtual Const void Registered needed types during registration of the factory
Public function Const bool

SupportsExecuteContextStruct ( const UScriptStruct* InExecuteContextStruct
)

 Returns truf if this factory supports a given executecontext struct.
Protected function Const const TArray< FName > *

UpdateArgumentNameCache ( int32 InNumberOperands
)

  
Protected function Const const TArray< FName > *

UpdateArgumentNameCache_NoLock ( int32 InNumberOperands
)

  

Constants

Name Description
DispatchPrefix  
GetTemplateMutex  
TrueString  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page