1. Epic GamesDeveloper
  3. FRigVMRegistry_NoLock

FRigVMRegistry_NoLock

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_NoLock : 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

Variables

  Type Name Description
Protected variable TSet< TObjectPtr< const UClass > > AllowedClasses All allowed classes.
Protected variable TSet< TObjectPtr< const UScriptStruct > > AllowedStructs All allowed structs.
Protected variable bool bEverRefreshedEngineTypes This is true if the engine has ever refreshed the engine types.
Protected variable bool bIsRefreshingEngineTypes If this is true the registry is currently refreshing all types.
Protected variable TMap< FName, int32 > DeprecatedTemplateNotationToIndex Name lookup for deprecated templates
Protected variable TChunkedArray< FRigVMTemplate > DeprecatedTemplates Memory for all deprecated templates
Protected variable TArray< FRigVMDispatchFactory * > Factories Memory for all dispatch factories
Protected variable TMap< FName, int32 > FunctionNameToIndex Name lookup for functions
Protected variable TChunkedArray< FRigVMFunction > Functions Memory for all functions We use TChunkedArray because we need the memory locations to be stable, since we only ever add and never remove.
Protected variable TMap< FName, TArray< FRigVMFunction > > StructNameToPredicates Lookup all the predicate functions of this struct
Protected variable TMap< FName, int32 > TemplateNotationToIndex Name lookup for non-deprecated templates
Protected variable TChunkedArray< FRigVMTemplate > Templates Memory for all non-deprecated templates
Protected variable TMap< FRigVMTemplateArgument::ETypeCategory, TArray< int32 > > TemplatesPerCategory Lookup per type category to know which template to keep in sync.
Protected variable TArray< FTypeInfo > Types Memory for all (known) types
Protected variable TMap< FRigVMTemplateArgument::ETypeCategory, TArray< TRigVMTypeIndex > > TypesPerCategory Maps storing the default types per type category.
Protected variable TMap< FRigVMTemplateArgumentType, TRigVMTypeIndex > TypeToIndex  
Protected variable TMap< FSoftObjectPath, TRigVMTypeIndex > UserDefinedTypeToIndex Name loop up for user defined types since they can be deleted.

Constructors

  Type Name Description
Protected function    
Protected function   Disable copy constructor

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Virtual void

AddReferencedObjects ( FReferenceCollector& Collector
)

  
Public function Virtual const FRigVMTemplate *

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

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

CanMatchTypes_NoLock ( TRigVMTypeIndex InTypeIndexA,
TRigVMTypeIndex InTypeIndexB,
bool bAllowFloatingPointCasts
)

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

FindDispatchFactory_NoLock ( const FName& InFactoryName
)

 Returns a dispatch factory given its name (or nullptr)
Public 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.
Public function Virtual Const const FRigVMFunction *

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

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

FindOrAddDispatchFactory_NoLock ( UScriptStruct* InFactoryStruct
)

 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 Virtual FString

FindOrAddSingletonDispatchFunction_NoLock ( UScriptStruct* InFactoryStruct
)

 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 Virtual TRigVMTypeIndex

FindOrAddType_NoLock ( const FRigVMTemplateArgumentType& InType,
bool bForce
)

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

FindTemplate_NoLock ( const FName& InNotation,
bool bIncludeDeprecated
)

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

FindTypeFromCPPType_NoLock ( const FString& InCPPType
)

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

Get ( ELockType InLockType
)

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

GetHashForEnum_NoLock ( const UEnum* InEnum,
bool bCheckTypeIndex
)

  
Public function Virtual Const uint32

GetHashForProperty_NoLock ( const FProperty* InProperty
)

  
Public function Virtual Const uint32

GetHashForScriptStruct_NoLock ( const UScriptStruct* InScriptStruct,
bool bCheckTypeIndex
)

  
Public function Virtual Const uint32

GetHashForStruct_NoLock ( const UStruct* InStruct
)

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

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

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

GetPredicatesForStruct_NoLock ( const FName& InStructName
)

 Given a struct name, return the predicates.
Public function Virtual Const FString  
Public function Virtual Const const TChunkedArray< FRigVMTemplate > & Returns all current RigVM functions.
Public function Virtual Const const FRigVMTemplateArgumentType & Returns the type given its index.
Public function Const TRigVMTypeIndex

GetTypeIndex_NoLock ( bool bAsArray
)

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

GetTypeIndex_NoLock ( bool bAsArray
)

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

GetTypeIndex_NoLock ( bool bAsArray
)

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

GetTypeIndex_NoLock ( const FName& InCPPType,
UObject* InCPPTypeObject
)

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

GetTypeIndex_NoLock ( bool bAsArray
)

 Returns the type index given a struct.
Public function Virtual Const TRigVMTypeIndex Returns the type index given only its cpp type.
Public function Virtual Const const TArray< TRigVMTypeIndex > & Returns all compatible types given a category.
Protected function void

Initialize ( bool bLockRegistry
)

  
Protected function void Initialize the base types.
Protected function Const bool

IsAllowedType_NoLock ( const FProperty* InProperty
)

  
Protected function Const bool

IsAllowedType_NoLock ( const UEnum* InEnum
)

  
Protected function Const bool

IsAllowedType_NoLock ( const UClass* InClass
)

  
Protected function Const bool

IsAllowedType_NoLock ( const UStruct* InStruct
)

  
Public function Virtual Const bool Returns true if the type is an array.
Public function Virtual Const bool Returns true if the type is an execute type.
Protected function Static bool

IsTypeOfByName ( const UObject* InObject,
const FName& InName
)

  
Public function Virtual Const bool Returns true if the type is a wildcard type.
Protected function Static EObjectFlags  
Public function Virtual Const int32 Returns the number of types.
Public 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
Public function Virtual bool

OnAssetRemoved_NoLock ( const FAssetData& InAssetData
)

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

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

 Update the registry when types are renamed.
Public function Virtual bool

OnPluginUnloaded_NoLock ( IPlugin& InPlugin
)

 Removes all types associated with a plugin that's being unloaded.
Protected function void  
Public function Virtual void  
Public function Virtual void Refreshes the list and finds the function pointers based on the names.
Public function Virtual void Refreshes the list and finds the function pointers based on the names.
Public function Virtual void

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

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

RegisterFactory_NoLock ( UScriptStruct* InFactoryStruct
)

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

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

 Register a set of allowed object types.
Public function Virtual void

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

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

RegisterStructTypes_NoLock ( TConstArrayView< UScriptStruct* > InStructs
)

 Register a set of allowed struct types.
Protected function void  
Public 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
Protected function void  
Public function Virtual void Clear the registry.

Operators

  Type Name Description
Protected function FRigVMRegistry_NoLock &

operator= ( const FRigVMRegistry_NoLock& InOther
)

 Disable assignment operator

Classes

  Type Name Description
Protected struct FTypeInfo    

Enums

  Type Name Description
Public enum ELockType    
Public enum ERegisterObjectOperation How to register an object's class when passed to RegisterObjectTypes.  

Typedefs

Name Description
FOnRigVMRegistryChanged  

Constants

Name Description
TemplateNameMetaName  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page