1. Epic GamesDeveloper
  3. FRigVMRegistry

FRigVMRegistry

The [FRigVMRegistry](API\Plugins\RigVM\RigVMCore\FRigVMRegistry) is used to manage all known function pointers for use in the RigVM.

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

Inheritance Hierarchy

References

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

Syntax

struct FRigVMRegistry : public FGCObject

Remarks

The FRigVMRegistry is used to manage all known function pointers for use in the RigVM. The Register method is called automatically when the static struct is initially constructed for each USTRUCT hosting a RIGVM_METHOD enabled virtual function.

Inheriting from FGCObject to ensure that all type objects cannot be GCed

Constructors

No constructors are accessible with public or protected access.

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function const FRigVMTemplate *

AddTemplateFromArguments ( const FName& InName,
const TArray< FRigVMTemplateArgument >& InArguments,
const FRigVMTemplateDelegates& InDelegates
)

 Adds a new template given its arguments.
Public function Const bool

CanMatchTypes ( TRigVMTypeIndex InTypeIndexA,
TRigVMTypeIndex InTypeIndexB,
bool bAllowFloatingPointCasts
)

 Returns true if the types can be matched.
Public function Const bool Converts the given execute context type to the base execute context type.
Public function Const FRigVMDispatchFactory *

FindDispatchFactory ( const FName& InFactoryName
)

 Returns a dispatch factory given its name (or nullptr)
Public function Const const FRigVMFunction *

FindFunction ( UScriptStruct* InStruct,
const TCHAR* InName
)

 Returns the function given its backing up struct and method name.
Public function Const const FRigVMFunction *

FindFunction ( const TCHAR* InName
)

 Returns the function given its name (or nullptr)
Public function FRigVMDispatchFactory * Returns a dispatch factory given its static struct (or nullptr)
Public function FRigVMDispatchFactory * Returns a dispatch factory given its static struct (or nullptr)
Public function FString Returns a dispatch factory's singleton function name if that exists.
Public function FString Returns a dispatch factory's singleton function name if that exists.
Public function TRigVMTypeIndex Adds a type if it doesn't exist yet and returns its index. This function is not thead-safe
Public function Const const FRigVMTemplate *

FindTemplate ( const FName& InNotation,
bool bIncludeDeprecated
)

 Returns a template pointer given its notation (or nullptr)
Public function Const const FRigVMTemplateArgumentType &

FindTypeFromCPPType ( const FString& InCPPType
)

 Returns the type given only its cpp type.
Public function Static FRigVMRegistry &

Get ()

 Returns the singleton registry.
Public function Const int32 Returns the dimensions of the array.
Public function Const TRigVMTypeIndex Returns the type index of the array matching the given element type index.
Public function Const TRigVMTypeIndex Returns the type index of the element matching the given array type index.
Public function Const const TArray< TRigVMTypeIndex > & Returns the list of compatible types for a given type.
Public function Const const TArray< FRigVMDispatchFactory * > & Returns all dispatch factories.
Public function Const const TChunkedArray< FRigVMFunction > & Returns all current rigvm functions.
Public function Const uint32

GetHashForEnum ( const UEnum* InEnum,
bool bCheckTypeIndex
)

  
Public function Const uint32

GetHashForProperty ( const FProperty* InProperty
)

  
Public function Const uint32

GetHashForScriptStruct ( const UScriptStruct* InScriptStruct,
bool bCheckTypeIndex
)

  
Public function Const uint32

GetHashForStruct ( const UStruct* InStruct
)

  
Public function Const uint32 Returns a unique hash per type index.
Public function Static const TArray< UScriptStruct * > &  
Public function const FRigVMTemplate *

GetOrAddTemplateFromArguments ( const FName& InName,
const TArray< FRigVMTemplateArgument >& InArguments,
const FRigVMTemplateDelegates& InDelegates
)

 Defines and retrieves a template given its arguments.
Public function Const const TArray< FRigVMFunction > *

GetPredicatesForStruct ( const FName& InStructName
)

 Given a struct name, return the predicates.
Public function Const const TChunkedArray< FRigVMTemplate > & Returns all current rigvm functions.
Public function Const const FRigVMTemplateArgumentType &

GetType ( TRigVMTypeIndex InTypeIndex
)

 Returns the type given its index.
Public function Const TRigVMTypeIndex

GetTypeIndex ( bool bAsArray
)

 Returns the type index given a struct.
Public function Const TRigVMTypeIndex

GetTypeIndex ( bool bAsArray
)

 Returns the type index given a struct.
Public function Const TRigVMTypeIndex

GetTypeIndex ( bool bAsArray
)

 Returns the type index given an enum.
Public function Const TRigVMTypeIndex Returns the type index given a type.
Public function Const TRigVMTypeIndex

GetTypeIndex ( const FName& InCPPType,
UObject* InCPPTypeObject
)

 Returns the type index given a cpp type and a type object.
Public function Const TRigVMTypeIndex

GetTypeIndex ( bool bAsArray
)

 Returns the type index given an object.
Public function Const TRigVMTypeIndex

GetTypeIndexFromCPPType ( const FString& InCPPType
)

 Returns the type index given only its cpp type.
Public function Const const TArray< TRigVMTypeIndex > & Returns all compatible types given a category.
Public function void Initializes the registry by storing the defaults.
Public function Const bool

IsArrayType ( TRigVMTypeIndex InTypeIndex
)

 Returns true if the type is an array.
Public function Const bool

IsExecuteType ( TRigVMTypeIndex InTypeIndex
)

 Returns true if the type is an execute type.
Public function Const bool Returns true if the type is a wildcard type.
Public function Const int32 Returns the number of types.
Public function void

OnAnimationAttributeTypesChanged ( const UScriptStruct* InStruct,
bool bIsAdded
)

 Update the registry when new types are added to the attribute system so that they can be selected on Attribute Nodes
Public function void

OnAssetRemoved ( const FAssetData& InAssetData
)

 Update the registry when old types are removed.
Public function void

OnAssetRenamed ( const FAssetData& InAssetData,
const FString& InOldObjectPath
)

 Update the registry when types are renamed.
Public function FOnRigVMRegistryChanged & Notifies other system that types have been added/removed, and template permutations have been updated.
Public function void Refreshes the list and finds the function pointers based on the names.
Public function void

Register ( const TCHAR* InName,
FRigVMFunctionPtr InFunctionPtr,
UScriptStruct* InStruct,
const TArray< FRigVMFunctionArgument >& InArguments
)

 Registers a function given its name.
Public function const FRigVMDispatchFactory *

RegisterFactory ( UScriptStruct* InFactoryStruct
)

 Registers a dispatch factory given its struct.
Public function void

RegisterPredicate ( UScriptStruct* InStruct,
const TCHAR* InName,
const TArray< FRigVMFunctionArgument >& InArguments
)

 Register a predicate contained in the input struct.
Public function bool

RemoveType ( const FAssetData& InAssetData
)

 Removes a type from the registry, and updates all dependent templates which also creates invalid permutations in templates that we should ignore
Public function void

Reset ()

 Clear the registry.

Overridden from FGCObject

  Type Name Description
Public function Virtual void Pure virtual that must be overloaded by the inheriting class.
Public function Virtual Const FString Overload this method to report a name for your referencer

Typedefs

Name Description
FOnRigVMRegistryChanged  

Constants

Name Description
FindFactoryMutex  
FindFunctionMutex  
FindTemplateMutex  
GetDispatchFunctionMutex  
GetDispatchPredicatesMutex  
GetPermutationMutex  
RefreshTypesMutex  
RegisterFactoryMutex  
RegisterFunctionMutex  
RegisterTemplateMutex  
TemplateNameMetaName  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page