1. Epic GamesDeveloper
  3. UDataRegistrySubsystem

UDataRegistrySubsystem

Singleton manager that provides synchronous and asynchronous access to data registries

Unreal Engine C++ API Reference > Plugins > DataRegistry

Inheritance Hierarchy

  • UEngineSubsystem
  • UDataRegistrySubsystem

References

   
Module DataRegistry
Header /Engine/Plugins/Runtime/DataRegistry/Source/DataRegistry/Public/DataRegistrySubsystem.h
Include #include "DataRegistrySubsystem.h"

Syntax

UCLASS (NotBlueprintType)  
class UDataRegistrySubsystem : public UEngineSubsystem

Remarks

Singleton manager that provides synchronous and asynchronous access to data registries

Variables

  Type Name Description
Protected variable TArray< FString > AssetScanPaths Paths that will be scanned for registries.
Protected variable bool bFullyInitialized True if initialization has finished and registries were scanned, will be false if not config enabled.
Protected variable bool bReadyForInitialization True if initialization is ready to start, will be true even if config disabled.
Protected variable FDataRegistrySubsystemInitializedCallback OnSubsystemInitializedCallback Callback for when the subsystem has finished scanning for and initializing all known data registries
Protected variable TMap< FDataRegistryType, TArray< FPreregisterAsset > > PreregisterAssetMap  
Protected variable TSortedMap< FName, TObjectPtr< UDataRegistry >, FDefaultAllocator, FNameFastLess > RegistryMap  
Protected variable TArray< FSoftObjectPath > RegistryPathsToIgnore Specific registries to avoid registering, may be in memory but will not be registered.
Protected variable TArray< FSoftObjectPath > RegistryPathsToLoad Specific registries to load, will be added to AssetScanPaths at scan time.

Functions

  Type Name Description
Public function Const bool Start an async load of an item, delegate will be called on success or failure of acquire.
Public function Static UFunction BlueprintCallable, Category, Meta bool Starts an asynchronous acquire of a data registry item that may not yet be cached, and then accessed with Get Data Registry Item From Lookup This function will only work properly if the data registry is set up for asynchronous querying.
Protected function Static void

AddReferencedObjects ( UObject* InThis,
FReferenceCollector& Collector
)

  
Protected function Virtual void  
Public function Const bool True if all registries should have been initialized
Public function Static UFunction BlueprintPure, Category, Meta FString Converts a Data Registry Id to a string.
Public function Static UFunction BlueprintPure, Category, Meta FString Converts a Data Registry Type to a string.
Protected function Virtual void  
Public function void De-initializes all loaded registries
Public function Static void

DumpCachedItems ( const TArray< FString >& Args
)

 Dumps out a text representation of every item in the registry
Public function Static void Outputs all registered types and some info
Protected function Virtual void

EndPIE ( bool bStartSimulate
)

  
Public function Static UFunction BlueprintPure, Category, Meta bool Returns true if the values are equal (A == B)
Public function Static UFunction BlueprintPure, Category, Meta bool Returns true if the values are equal (A == B)
Public function Const FDataRegistryCacheGetResult

EvaluateCachedCurve ( float& OutValue,
const FRealCurve*& OutCurve,
FDataRegistryId ItemId,
float InputValue,
float DefaultValue
)

 Computes an evaluated curve value, as well as the actual curve if it is found.
Public function Static UFunction BlueprintCallable, Category, Meta void

EvaluateDataRegistryCurve ( FDataRegistryId ItemId,
float InputValue,
float DefaultValue,
EDataRegistrySubsystemGetItemResult& OutResult,
float& OutValue
)

 Attempts to evaluate a curve stored in a DataRegistry cache using a specific input value
Public function Static UFunction BlueprintCallable, Category, Meta customthunk void

FindCachedItemBP ( FDataRegistryId ItemId,
EDataRegistrySubsystemGetItemResult& OutResult,
FTableRowBase& OutItem
)

 Attempts to get cached structure data stored in a DataRegistry, returning OutItem if the item is available.
Public function Static UFunction BlueprintCallable, Category, Meta customthunk void

FindCachedItemFromLookupBP ( FDataRegistryId ItemId,
const FDataRegistryLookup& ResolvedLookup,
EDataRegistrySubsystemGetItemResult& OutResult,
FTableRowBase& OutItem
)

 Attempts to get structure data stored in a DataRegistry cache after an async acquire, returning OutItem if the item is available.
Public function Static UDataRegistrySubsystem *

Get ()

 Returns the global subsystem instance, this can return null during early engine startup and shutdown
Public function Const void

GetAllRegistries ( TArray< UDataRegistry* >& AllRegistries,
bool bSortByType
)

 Gets list of all registries, useful for iterating in UI or utilities
Public function Const const T *

GetCachedItem ( const FDataRegistryId& ItemId
)

 Returns a cached item of specified struct type.
Public function Static UFunction BlueprintCallable, Category, Meta customthunk bool

GetCachedItemBP ( FDataRegistryId ItemId,
UPARAM(ref) FTableRowBase& OutItem
)

 Attempts to get cached structure data stored in a DataRegistry, modifying OutItem if the item is available.
Public function Static UFunction BlueprintCallable, Category, Meta customthunk bool

GetCachedItemFromLookupBP ( FDataRegistryId ItemId,
const FDataRegistryLookup& ResolvedLookup,
FTableRowBase& OutItem
)

 Deprecated in favor of FindCachedItemFromLookupBP, but does still work properly
Public function Const FDataRegistryCacheGetResult

GetCachedItemRaw ( const uint8*& OutItemMemory,
const UScriptStruct*& OutItemStruct,
const FDataRegistryId& ItemId
)

 Gets the cached or precached data and struct type.
Public function Const FDataRegistryCacheGetResult

GetCachedItemRawFromLookup ( const uint8*& OutItemMemory,
const UScriptStruct*& OutItemStruct,
const FDataRegistryId& ItemId,
const FDataRegistryLookup& Lookup
)

 Gets the cached or precached data and struct type using an async acquire result.
Public function Const FText Returns proper display text for an id, using the correct id format
Public function Static UFunction BlueprintCallable, BlueprintPure, Category, Meta void

GetPossibleDataRegistryIdList ( FDataRegistryType RegistryType,
TArray< FDataRegistryId >& OutIdList
)

 Returns the list of known identifiers for an active data registry so they can be iterated with Find or Acquire.
Public function Const UDataRegistry *

GetRegistryForType ( FName RegistryType
)

 Finds the right registry for a type name
Public function bool

IgnoreRegistryPath ( const FSoftObjectPath& RegistryAssetPath
)

 Removes specific data registry asset from the registration map, can be undone with LoadRegistryPath
Protected function Virtual void

Initialize ( FSubsystemCollectionBase& Collection
)

  
Public function void

InitializeAllRegistries ( bool bResetIfInitialized
)

 Initializes all loaded registries and prepares them for queries
Public function Const bool

IsConfigEnabled ( bool bWarnIfNotEnabled
)

 Returns true if the system is enabled via any config scan settings, will optionally warn if not enabled
Public function Static UFunction BlueprintPure, Category, Meta bool Returns true if this is a non-empty item identifier, does not check if it is currently registered
Public function Static UFunction BlueprintPure, Category, Meta bool Returns true if this is a non-empty type, does not check if it is currently registered
Public function void Loads all registry assets and initializes them, this is called early in startup
Public function bool

LoadRegistryPath ( const FSoftObjectPath& RegistryAssetPath
)

 Load and initialize a specific registry, useful for plugins.
Public function Static UFunction BlueprintPure, Category, Meta bool Returns true if the values are not equal (A != B)
Public function Static UFunction BlueprintPure, Category, Meta bool Returns true if the values are not equal (A != B)
Public function FDataRegistrySubsystemInitializedCallback & Accesses the delegate called when the subsystem has finished scanning for and initializing all known data registries
Protected function Virtual void  
Protected function Virtual void Initialization order, need to wait for other early-load systems to initialize.
Protected function Virtual void  
Protected function Virtual void

PreBeginPIE ( bool bStartSimulate
)

  
Public function void

PreregisterSpecificAssets ( const TMap< FDataRegistryType, TArray< FSoftObjectPath > >& AssetMap,
int32 AssetPriority
)

 Schedules registration of assets by path, this will happen immediately or will be queued if the data registries don't exist yet
Public function void Refreshes the active registry map based on what's in memory
Public function bool

RegisterSpecificAsset ( FDataRegistryType RegistryType,
FAssetData& AssetData,
int32 AssetPriority
)

 Attempt to register a specified asset with all active sources that allow dynamic registration, returning true if anything changed.
Public function void Handles changes to DataRegistrySettings while engine is running
Public function void Resets state for all registries, call when gameplay has concluded to destroy caches
Public function int32

UnregisterAssetsWithPriority ( FDataRegistryType RegistryType,
int32 AssetPriority
)

 Unregisters all previously registered assets in a specific registry with a specific priority, can be used as a batch reset.
Public function bool

UnregisterSpecificAsset ( FDataRegistryType RegistryType,
const FSoftObjectPath& AssetPath
)

 Removes references to a specific asset, returns bool if it was removed

Typedefs

Name Description
FPreregisterAsset List of assets to attempt to register when data registries come online.
FRegistryMapPair  

Constants

Name Description
SingletonSubSystem Singleton object for the DataRegistrySubsystem::Get function to use, populated in Initialize and cleared out in Deinitialize

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page