Navigation
API > API/Plugins > API/Plugins/Niagara
Contains all types currently available for use in Niagara Used by UI to provide selection; new uniforms and variables may be instanced using the types provided here
| Name | FNiagaraTypeRegistry |
| Type | class |
| Header File | /Engine/Plugins/FX/Niagara/Source/Niagara/Public/NiagaraTypeRegistry.h |
| Include Path | #include "NiagaraTypeRegistry.h" |
Syntax
class FNiagaraTypeRegistry : public FGCObject
Inheritance Hierarchy
- FGCObject → FNiagaraTypeRegistry
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FNiagaraTypeRegistry() |
NiagaraTypeRegistry.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FNiagaraTypeRegistry() |
NiagaraTypeRegistry.h |
Structs
| Name | Remarks |
|---|---|
| FQueuedRegistryEntry |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FRegisteredTypesArray | TArray< TUniquePtr< FNiagaraTypeDefinition > > | In order to simplify the requirements for handling access to the type array from various threads (async loading as an example) we ensure that the entries in the array will never be invalidated. | NiagaraTypeRegistry.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bModuleInitialized | bool | NiagaraTypeRegistry.h | ||
| RegisteredEmitterVariableTypes | TArray< FNiagaraTypeDefinition > | NiagaraTypeRegistry.h | ||
| RegisteredIndexTypes | TArray< FNiagaraTypeDefinition > | NiagaraTypeRegistry.h | ||
| RegisteredNumericTypes | TArray< FNiagaraTypeDefinition > | NiagaraTypeRegistry.h | ||
| RegisteredParamTypes | TArray< FNiagaraTypeDefinition > | NiagaraTypeRegistry.h | ||
| RegisteredParticleVariableTypes | TArray< FNiagaraTypeDefinition > | NiagaraTypeRegistry.h | ||
| RegisteredPayloadTypes | TArray< FNiagaraTypeDefinition > | NiagaraTypeRegistry.h | ||
| RegisteredSoftObjectPaths | TArray< FSoftObjectPath > | For each entry in RegisteredTypes we store the SoftObjectPath of the underlying class/struct so that we can handle dynamically unloading plugins | NiagaraTypeRegistry.h | |
| RegisteredStructConversionMap | TMap< uint32, FNiagaraLwcStructConverter > | NiagaraTypeRegistry.h | ||
| RegisteredSystemVariableTypes | TArray< FNiagaraTypeDefinition > | NiagaraTypeRegistry.h | ||
| RegisteredTypeIndexMap | TMap< uint32, int32 > | NiagaraTypeRegistry.h | ||
| RegisteredTypes | FRegisteredTypesArray | NiagaraTypeRegistry.h | ||
| RegisteredTypesGeneration | std::atomic< uint32 > | Atomic index that is incremented each time types may have been invalidated | NiagaraTypeRegistry.h | |
| RegisteredTypesLock | FTransactionallySafeRWLock | NiagaraTypeRegistry.h | ||
| RegisteredUserDefinedTypes | TArray< FNiagaraTypeDefinition > | NiagaraTypeRegistry.h | ||
| RegisteredUserVariableTypes | TArray< FNiagaraTypeDefinition > | NiagaraTypeRegistry.h | ||
| RegistrationLock | FRWLock | Covers manipulation of all of the containers populated during registration (except for RegisteredTypes which is handled by it's own lock so that we can provide a fast path for the common case of reading the array) | NiagaraTypeRegistry.h | |
| RegistryQueue | TQueue< FQueuedRegistryEntry, EQueueMode::Mpsc > | NiagaraTypeRegistry.h |
Functions
Public
Overridden from FGCObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void AddReferencedObjects
(
FReferenceCollector& Collector |
FGCObject interface | NiagaraTypeRegistry.h | |
virtual FString GetReferencerName() |
NiagaraTypeRegistry.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static void CacheRegisteredTypeIndex
(
const FNiagaraTypeDefinition& Type, |
Populates the cache on the TypeDefinition and TLS | NiagaraTypeRegistry.h | |
static void ClearUserDefinedRegistry() |
NiagaraTypeRegistry.h | ||
static void ForEachRegisteredType
(
TAction Func |
NiagaraTypeRegistry.h | ||
static FNiagaraTypeRegistry & Get() |
LazySingleton interface | NiagaraTypeRegistry.h | |
static bool GetCachedRegisteredTypeIndex
(
const FNiagaraTypeDefinition& Type, |
Helper method to go through the various caching methods for finding the index into RegisteredTypes for the provided TypeDefinition | NiagaraTypeRegistry.h | |
static UNiagaraDataInterfaceBase * GetDefaultDataInterfaceByName
(
const FString& DIClassName |
NiagaraTypeRegistry.h | ||
static TArray< FNiagaraTypeDefinition > GetIndexTypes() |
NiagaraTypeRegistry.h | ||
static TArray< FNiagaraTypeDefinition > GetNumericTypes() |
NiagaraTypeRegistry.h | ||
static TArray< FNiagaraTypeDefinition > GetRegisteredEmitterVariableTypes() |
NiagaraTypeRegistry.h | ||
static TArray< FNiagaraTypeDefinition > GetRegisteredParameterTypes() |
NiagaraTypeRegistry.h | ||
static TArray< FNiagaraTypeDefinition > GetRegisteredParticleVariableTypes() |
NiagaraTypeRegistry.h | ||
static TArray< FNiagaraTypeDefinition > GetRegisteredPayloadTypes() |
NiagaraTypeRegistry.h | ||
static TArray< FNiagaraTypeDefinition > GetRegisteredSystemVariableTypes() |
NiagaraTypeRegistry.h | ||
static TOptional< FNiagaraTypeDefinition > GetRegisteredTypeByName
(
FName TypeName |
NiagaraTypeRegistry.h | ||
static TArray< FNiagaraTypeDefinition > GetRegisteredTypes() |
NiagaraTypeRegistry.h | ||
static TArray< FNiagaraTypeDefinition > GetRegisteredUserVariableTypes() |
NiagaraTypeRegistry.h | ||
static FNiagaraLwcStructConverter GetStructConverter
(
const FNiagaraTypeDefinition& SourceType |
NiagaraTypeRegistry.h | ||
static FNiagaraTypeDefinition GetTypeForStruct
(
UScriptStruct* InStruct |
NiagaraTypeRegistry.h | ||
static TArray< FNiagaraTypeDefinition > GetUserDefinedTypes() |
NiagaraTypeRegistry.h | ||
static void Init() |
NiagaraTypeRegistry.h | ||
static void InvalidateTypesByPath
(
const FString& AssetPath |
NiagaraTypeRegistry.h | ||
static bool IsStaticPossible
(
const FNiagaraTypeDefinition& InSrc |
NiagaraTypeRegistry.h | ||
static void ProcessRegistryQueue() |
NiagaraTypeRegistry.h | ||
static void Register
(
const FNiagaraTypeDefinition& NewType, |
NiagaraTypeRegistry.h | ||
static void Register
(
const FNiagaraTypeDefinition& NewType, |
NiagaraTypeRegistry.h | ||
static void RegisterStructConverter
(
const FNiagaraTypeDefinition& SourceType, |
NiagaraTypeRegistry.h | ||
static void TearDown() |
NiagaraTypeRegistry.h |