1. Epic GamesDeveloper
  3. FRigVMRegistry_RWLock

FRigVMRegistry_RWLock

The 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_RWLock : public FRigVMRegistry_NoLock

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.

Functions

  Type Name Description
Public function const FRigVMTemplate *

AddTemplateFromArguments ( const FName& InName,
const TArray< FRigVMTemplateArgumentInfo >& InInfos,
const FRigVMTemplateDelegates& InDelegates,
bool bLockRegistry
)

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

CanMatchTypes ( TRigVMTypeIndex InTypeIndexA,
TRigVMTypeIndex InTypeIndexB,
bool bAllowFloatingPointCasts,
bool bLockRegistry
)

 Returns true if the types can be matched.
Public function Const bool

ConvertExecuteContextToBaseType ( TRigVMTypeIndex& InOutTypeIndex,
bool bLockRegistry
)

 Converts the given execute context type to the base execute context type.
Public function Const FRigVMDispatchFactory *

FindDispatchFactory ( const FName& InFactoryName,
bool bLockRegistry
)

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

FindFunction ( UScriptStruct* InStruct,
const TCHAR* InName,
const FRigVMUserDefinedTypeResolver& InResolvalInfo,
bool bLockRegistry
)

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

FindFunction ( const TCHAR* InName,
const FRigVMUserDefinedTypeResolver& InTypeResolver,
bool bLockRegistry
)

 Returns the function given its name (or nullptr)
Public function FRigVMDispatchFactory *

FindOrAddDispatchFactory ( UScriptStruct* InFactoryStruct,
bool bLockRegistry
)

 Returns a dispatch factory given its static struct (or nullptr)
Public function FRigVMDispatchFactory *

FindOrAddDispatchFactory ( bool bLockRegistry
)

 Returns a dispatch factory given its static struct (or nullptr)
Public function FString

FindOrAddSingletonDispatchFunction ( UScriptStruct* InFactoryStruct,
bool bLockRegistry
)

 Returns a dispatch factory's singleton function name if that exists.
Public function FString

FindOrAddSingletonDispatchFunction ( bool bLockRegistry
)

 Returns a dispatch factory's singleton function name if that exists.
Public function TRigVMTypeIndex

FindOrAddType ( const FRigVMTemplateArgumentType& InType,
bool bForce,
bool bLockRegistry
)

 Adds a type if it doesn't exist yet and returns its index. This function is thread-safe
Public function Const const FRigVMTemplate *

FindTemplate ( const FName& InNotation,
bool bIncludeDeprecated,
bool bLockRegistry
)

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

FindTypeFromCPPType ( const FString& InCPPType,
bool bLockRegistry
)

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

Get ( ELockType InLockType
)

  
Public function Static FRigVMRegistry_RWLock &

Get ()

 Returns the singleton registry.
Public function Const int32

GetArrayDimensionsForType ( TRigVMTypeIndex InTypeIndex,
bool bLockRegistry
)

 Returns the dimensions of the array.
Public function Const TRigVMTypeIndex

GetArrayTypeFromBaseTypeIndex ( TRigVMTypeIndex InTypeIndex,
bool bLockRegistry
)

 Returns the type index of the array matching the given element type index.
Public function Const TRigVMTypeIndex

GetBaseTypeFromArrayTypeIndex ( TRigVMTypeIndex InTypeIndex,
bool bLockRegistry
)

 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 * > &

GetFactories ( bool bLockRegistry
)

 Returns all dispatch factories.
Public function Static const FRigVMRegistry_NoLock &  
Public function Static FRigVMRegistry_NoLock &  
Public function Const const TChunkedArray< FRigVMFunction > &

GetFunctions ( bool bLockRegistry
)

 Returns all current RigVM functions.
Public function Const uint32

GetHashForEnum ( const UEnum* InEnum,
bool bCheckTypeIndex,
bool bLockRegistry
)

  
Public function Const uint32

GetHashForProperty ( const FProperty* InProperty,
bool bLockRegistry
)

  
Public function Const uint32

GetHashForScriptStruct ( const UScriptStruct* InScriptStruct,
bool bCheckTypeIndex,
bool bLockRegistry
)

  
Public function Const uint32

GetHashForStruct ( const UStruct* InStruct,
bool bLockRegistry
)

  
Public function Const uint32

GetHashForType ( TRigVMTypeIndex InTypeIndex,
bool bLockRegistry
)

 Returns a unique hash per type index.
Public function const FRigVMTemplate *

GetOrAddTemplateFromArguments ( const FName& InName,
const TArray< FRigVMTemplateArgumentInfo >& InInfos,
const FRigVMTemplateDelegates& InDelegates,
bool bLockRegistry
)

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

GetPredicatesForStruct ( const FName& InStructName,
bool bLockRegistry
)

 Given a struct name, return the predicates.
Public function Const const TChunkedArray< FRigVMTemplate > &

GetTemplates ( bool bLockRegistry
)

 Returns all current RigVM functions.
Public function Const const FRigVMTemplateArgumentType &

GetType ( TRigVMTypeIndex InTypeIndex,
bool bLockRegistry
)

 Returns the type given its index.
Public function Const TRigVMTypeIndex

GetTypeIndex ( const FName& InCPPType,
UObject* InCPPTypeObject,
bool bLockRegistry
)

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

GetTypeIndex ( bool bAsArray,
bool bLockRegistry
)

 Returns the type index given an enum, struct, or object.
Public function Const TRigVMTypeIndex

GetTypeIndex ( const FRigVMTemplateArgumentType& InType,
bool bLockRegistry
)

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

GetTypeIndexFromCPPType ( const FString& InCPPType,
bool bLockRegistry
)

 Returns the type index given only its cpp type.
Public function Const const TArray< TRigVMTypeIndex > &

GetTypesForCategory ( FRigVMTemplateArgument::ETypeCategory InCategory,
bool bLockRegistry
)

 Returns all compatible types given a category.
Public function Const bool

IsArrayType ( TRigVMTypeIndex InTypeIndex,
bool bLockRegistry
)

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

IsExecuteType ( TRigVMTypeIndex InTypeIndex,
bool bLockRegistry
)

 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

NumTypes ( bool bLockRegistry
)

 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 void

OnPluginUnloaded ( IPlugin& InPlugin
)

 Removes all types associated with a plugin that's being unloaded.
Public function FOnRigVMRegistryChanged & Notifies other system that types have been added/removed, and template permutations have been updated.
Public function void

RebuildRegistry ( bool bLockRegistry
)

  
Public function void Refreshes the list and finds the function pointers based on the names.
Public function void

RefreshEngineTypesIfRequired ( bool bLockRegistry
)

 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,
bool bLockRegistry
)

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

RegisterFactory ( UScriptStruct* InFactoryStruct,
bool bLockRegistry
)

 Registers a dispatch factory given its struct.
Public function void

RegisterObjectTypes ( TConstArrayView< TPair< UClass*, ERegisterObjectOperation > > InClasses,
bool bLockRegistry
)

 Register a set of allowed object types.
Public function void

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

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

RegisterStructTypes ( TConstArrayView< UScriptStruct* > InStructs,
bool bLockRegistry
)

 Register a set of allowed struct types.
Public function bool

RemoveType ( const FSoftObjectPath& InObjectPath,
const UClass* InObjectClass,
bool bLockRegistry
)

 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 ( bool bLockRegistry
)

 Clear the registry.

Overridden from FRigVMRegistry_NoLock

  Type Name Description
Protected function Virtual const FRigVMTemplate *

AddTemplateFromArguments_NoLock ( const FName& InName,
const TArray< FRigVMTemplateArgumentInfo >& InInfos,
const FRigVMTemplateDelegates& InDelegates
)

 Adds a new template given its arguments Note: Only call NoLock methods on the FRigVMRegistry_NoLock
Protected function Virtual Const bool

CanMatchTypes_NoLock ( TRigVMTypeIndex InTypeIndexA,
TRigVMTypeIndex InTypeIndexB,
bool bAllowFloatingPointCasts
)

 Returns true if the types can be matched.
Protected function Virtual Const bool Converts the given execute context type to the base execute context type Note: Only call NoLock methods on the FRigVMRegistry_NoLock
Protected function Virtual Const FRigVMDispatchFactory *

FindDispatchFactory_NoLock ( const FName& InFactoryName
)

 Returns a dispatch factory given its name (or nullptr) Note: Only call NoLock methods on the FRigVMRegistry_NoLock
Protected function Virtual Const const FRigVMFunction *

FindFunction_NoLock ( UScriptStruct* InStruct,
const TCHAR* InName,
const FRigVMUserDefinedTypeResolver& InResolvalInfo
)

 Returns the function given its backing up struct and method name Note: Only call NoLock methods on the FRigVMRegistry_NoLock
Protected function Virtual Const const FRigVMFunction *

FindFunction_NoLock ( const TCHAR* InName,
const FRigVMUserDefinedTypeResolver& InTypeResolver
)

 Returns the function given its name (or nullptr) Note: Only call NoLock methods on the FRigVMRegistry_NoLock
Protected function Virtual FRigVMDispatchFactory *

FindOrAddDispatchFactory_NoLock ( UScriptStruct* InFactoryStruct
)

 Returns a dispatch factory given its static struct (or nullptr) Note: Only call NoLock methods on the FRigVMRegistry_NoLock
Protected function Virtual FString

FindOrAddSingletonDispatchFunction_NoLock ( UScriptStruct* InFactoryStruct
)

 Returns a dispatch factory's singleton function name if that exists Note: Only call NoLock methods on the FRigVMRegistry_NoLock
Protected function Virtual TRigVMTypeIndex

FindOrAddType_NoLock ( const FRigVMTemplateArgumentType& InType,
bool bForce
)

 Adds a type if it doesn't exist yet and returns its index.
Protected function Virtual Const const FRigVMTemplate *

FindTemplate_NoLock ( const FName& InNotation,
bool bIncludeDeprecated
)

 Returns a template pointer given its notation (or nullptr) Note: Only call NoLock methods on the FRigVMRegistry_NoLock
Protected function Virtual Const const FRigVMTemplateArgumentType &

FindTypeFromCPPType_NoLock ( const FString& InCPPType
)

 Returns the type given only its cpp type Note: Only call NoLock methods on the FRigVMRegistry_NoLock
Protected function Virtual Const int32 Returns the dimensions of the array Note: Only call NoLock methods on the FRigVMRegistry_NoLock
Protected function Virtual Const TRigVMTypeIndex Returns the type index of the array matching the given element type index Note: Only call NoLock methods on the FRigVMRegistry_NoLock
Protected function Virtual Const TRigVMTypeIndex Returns the type index of the element matching the given array type index Note: Only call NoLock methods on the FRigVMRegistry_NoLock
Protected function Virtual Const const TArray< TRigVMTypeIndex > & Returns the list of compatible types for a given type Note: Only call NoLock methods on the FRigVMRegistry_NoLock
Protected function Virtual Const const TArray< FRigVMDispatchFactory * > & Returns all dispatch factories Note: Only call NoLock methods on the FRigVMRegistry_NoLock
Protected function Virtual Const const TChunkedArray< FRigVMFunction > & Returns all current RigVM functions Note: Only call NoLock methods on the FRigVMRegistry_NoLock
Protected function Virtual Const uint32

GetHashForEnum_NoLock ( const UEnum* InEnum,
bool bCheckTypeIndex
)

 Note: Only call NoLock methods on the FRigVMRegistry_NoLock.
Protected function Virtual Const uint32

GetHashForProperty_NoLock ( const FProperty* InProperty
)

 Note: Only call NoLock methods on the FRigVMRegistry_NoLock.
Protected function Virtual Const uint32

GetHashForScriptStruct_NoLock ( const UScriptStruct* InScriptStruct,
bool bCheckTypeIndex
)

 Note: Only call NoLock methods on the FRigVMRegistry_NoLock.
Protected function Virtual Const uint32

GetHashForStruct_NoLock ( const UStruct* InStruct
)

 Note: Only call NoLock methods on the FRigVMRegistry_NoLock.
Protected function Virtual Const uint32 Returns a unique hash per type index Note: Only call NoLock methods on the FRigVMRegistry_NoLock
Protected function Virtual const FRigVMTemplate *

GetOrAddTemplateFromArguments_NoLock ( const FName& InName,
const TArray< FRigVMTemplateArgumentInfo >& InInfos,
const FRigVMTemplateDelegates& InDelegates
)

 Defines and retrieves a template given its arguments Note: Only call NoLock methods on the FRigVMRegistry_NoLock
Protected function Virtual Const const TArray< FRigVMFunction > *

GetPredicatesForStruct_NoLock ( const FName& InStructName
)

 Given a struct name, return the predicates Note: Only call NoLock methods on the FRigVMRegistry_NoLock
Protected function Virtual Const const TChunkedArray< FRigVMTemplate > & Returns all current RigVM functions Note: Only call NoLock methods on the FRigVMRegistry_NoLock
Protected function Virtual Const const FRigVMTemplateArgumentType & Returns the type given its index Note: Only call NoLock methods on the FRigVMRegistry_NoLock
Protected function Virtual Const TRigVMTypeIndex

GetTypeIndex_NoLock ( const FName& InCPPType,
UObject* InCPPTypeObject
)

 Returns the type index given a cpp type and a type object Note: Only call NoLock methods on the FRigVMRegistry_NoLock
Protected function Virtual Const TRigVMTypeIndex Returns the type index given a type Note: Only call NoLock methods on the FRigVMRegistry_NoLock
Protected function Virtual Const TRigVMTypeIndex Returns the type index given only its cpp type Note: Only call NoLock methods on the FRigVMRegistry_NoLock
Protected function Virtual Const const TArray< TRigVMTypeIndex > & Returns all compatible types given a category Note: Only call NoLock methods on the FRigVMRegistry_NoLock
Protected function Virtual Const bool Returns true if the type is an array Note: Only call NoLock methods on the FRigVMRegistry_NoLock
Protected function Virtual Const bool Returns true if the type is an execute type Note: Only call NoLock methods on the FRigVMRegistry_NoLock
Protected function Virtual Const bool Returns true if the type is a wildcard type Note: Only call NoLock methods on the FRigVMRegistry_NoLock
Protected function Virtual Const int32 Returns the number of types Note: Only call NoLock methods on the FRigVMRegistry_NoLock
Protected function Virtual void

OnAnimationAttributeTypesChanged_NoLock ( 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 Note: Only call NoLock methods on the FRigVMRegistry_NoLock
Protected function Virtual bool

OnAssetRemoved_NoLock ( const FAssetData& InAssetData
)

 Update the registry when old types are removed Note: Only call NoLock methods on the FRigVMRegistry_NoLock
Protected function Virtual void

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

 Update the registry when types are renamed Note: Only call NoLock methods on the FRigVMRegistry_NoLock
Protected function Virtual bool

OnPluginUnloaded_NoLock ( IPlugin& InPlugin
)

 Removes all types associated with a plugin that's being unloaded.
Protected function Virtual void Note: Only call NoLock methods on the FRigVMRegistry_NoLock.
Protected function Virtual void Refreshes the list and finds the function pointers based on the names.
Protected function Virtual void Refreshes the list and finds the function pointers based on the names.
Protected function Virtual void

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

 Registers a function given its name.
Protected function Virtual const FRigVMDispatchFactory *

RegisterFactory_NoLock ( UScriptStruct* InFactoryStruct
)

 Registers a dispatch factory given its struct.
Protected function Virtual void

RegisterObjectTypes_NoLock ( TConstArrayView< TPair< UClass*, ERegisterObjectOperation > > InClasses
)

 Register a set of allowed object types Note: Only call NoLock methods on the FRigVMRegistry_NoLock
Protected function Virtual void

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

 Register a predicate contained in the input struct Note: Only call NoLock methods on the FRigVMRegistry_NoLock
Protected function Virtual bool

RemoveType_NoLock ( const FSoftObjectPath& InObjectPath,
const UClass* InObjectClass
)

 Removes a type from the registry, and updates all dependent templates which also creates invalid permutations in templates that we should ignore Note: Only call NoLock methods on the FRigVMRegistry_NoLock
Protected function Virtual void Clear the registry Note: Only call NoLock methods on the FRigVMRegistry_NoLock

Classes

  Type Name Description
Public class FConditionalReadScopeLock    
Protected class FConditionalScopeLock    
Public class FConditionalWriteScopeLock    

Typedefs

Name Description
Super  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page