Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > DataRegistry > UDataRegistry

Light Theme

Dark Theme

UDataRegistry

Defines a place to efficiently store and retrieve structure data, can be used as a wrapper around Data/Curve Tables or extended with other sources

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UDataRegistry

References

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

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)()
class UDataRegistry : public UObject

Remarks

Defines a place to efficiently store and retrieve structure data, can be used as a wrapper around Data/Curve Tables or extended with other sources

Variables

	Name	Description
TArray< UDataRe...	DataSources	List of data sources to search for items
FDataRegistryCa...	DefaultCachePolicy	Editor-set cache policy
FDataRegistryId...	IdFormat	Rules for specifying valid item Ids, if default than any name can be used
const UScriptSt...	ItemStruct	Structure type of all for items in this registry
FDataRegistryCa...	OnCacheVersionInvalidatedCallback	Callback for when cache version changes, might be moved later
FName	RegistryType	Globally unique name used to identify this registry
FDataRegistryCa...	RuntimeCachePolicy	Runtime override
TArray< UDataRe...	RuntimeSources	TODO remove VisibleDefaultsOnly or figure out how to stop it from letting you edit the instance properties.
float	TimerUpdateFrequency	How often to check for cache updates

Constructors

	Name	Description
	UDataRegistry()

Destructors

	Name	Description
	~UDataRegistry()

Functions

	Name	Description
bool	AcquireItem ( const FDataRegistryId& ItemId, FDataRegistryItemAcquiredCallback D... )	Start an async request for a single item
bool	AcquireItemInternal ( const FDataRegistryId& ItemId, const FDataRegistryLookup& Lookup, FDataRegistryItemAcquiredCallback D..., const FDataRegistryRequestId& Batc... )	Start an async request
void	AddAllIdsForResolvedName ( TSet< FDataRegistryId >& PossibleI..., const FName& ResolvedName, const UDataRegistrySource* Reg... )	Adds all possible source ids for resolved name to set, regardless of request context, default just uses the name
void	AddReferencedObjects ( UObject* InThis, FReferenceCollector& Collector )
void	ApplyCachePolicy()	Applies the cache policy, is called regularly but can be manually executed
bool	BatchAcquireItems ( const TArray< FDataRegistryId >& I..., FDataRegistryBatchAcquireCallback D... )	Start an async request for multiple items
bool	BatchAcquireSourceItems ( TArray< FDataRegistrySourceItemId >..., FDataRegistryBatchAcquireCallback D... )	Request a list of source items
void	Deinitialize()	Disable access and restore to state before initialization, won't do anything if not initialized
void	DelayedHandleSuccessCallbacks ( FDataRegistryLookup Lookup )	Frame-delayed callback to call success for already loaded items
bool	DoesItemStructMatchFilter ( FName FilterStructName )	Returns true if this registry struct inherits from a particular named struct
void	EditorRefreshRegistry()	Validate and refresh registration
const FCache...	FindCachedData ( const FDataRegistryId& ItemId, const uint8** PrecachedDat... )	Returns internal cached data or raw memory ptr for precached data
FDataRegistr...	GetAllCachedItems ( TMap< FDataRegistryId, const uint8 ..., const UScriptStruct*& OutItemS... )	Fills in a map with all cached (and precached) ids and items for fast iteration.
void	GetAllSourceItems ( TArray< FDataRegistrySourceItemId >... )	Returns all source ids for editor display
FDataRegistr...	GetCachedCurveRaw ( const FRealCurve*& OutCurve, const FDataRegistryId& ItemId )	Curve wrapper for get function
const T *...	GetCachedItem ( const FDataRegistryId& ItemId )	Finds the cached item, using the request context to handle remapping
FDataRegistr...	GetCachedItemRaw ( const uint8& OutItemMemory, const UScriptStruct& OutItemS..., const FDataRegistryId& ItemId )	Returns the raw cached data and struct type, useful for generic C++ calls
FDataRegistr...	GetCachedItemRawFromLookup ( const uint8& OutItemMemory, const UScriptStruct& OutItemS..., const FDataRegistryId& ItemId, const FDataRegistryLookup& Lookup )	Finds the cached item using a resolved lookup, this can be useful after a load has happened to ensure you get the exact item requested
FDataRegistr...	GetCacheResultVersion()	Returns the current cache version for a successful get, may change depending on stack-specific resolve settings
void	GetChildRuntimeSources ( UDataRegistrySource* ParentSou..., TArray< UDataRegistrySource* >... )	Gets list of child runtime sources created by passed in source, in order registered
float	GetCurrentTime()	Gets the current time
const FDataR...	GetIdFormat()	Gets the formatting for this Id
const UScrip...	GetItemStruct()	Returns the struct used by this registry, everything returned will be this or a subclass
EDataRegistr...	GetLowestAvailability()	Returns the worst availability for anything stored in this registry, if this is Precached then this registry is a wrapper around already loaded data
void	GetPossibleRegistryIds ( TArray< FDataRegistryId >& OutRegi..., bool bSortForDisplay )	Fills in a list of all item ids provided by this registry, sorted for display
FText	GetRegistryDescription()	Gets a human readable summary of registry, for UI usage
const FName	GetRegistryType()	Returns the name for type exposed by this registry
const FDataR...	GetRuntimeCachePolicy()	Gets the current general cache policy
int32	GetSourceIndex ( const UDataRegistrySource* Sou..., bool bUseRuntimeSources )	Returns the index of a source in the source list
FTimerManage...	GetTimerManager()	Returns a timer manager that is safe to use for asset loading actions.
void	HandleAcquireCallbacks ( const FDataRegistryLookup& Lookup, FCachedDataRegistryItem& CachedEnt... )	Handle sending completion/error callbacks
void	HandleAcquireResult ( const FDataRegistrySourceAcquireReq..., EDataRegistryAcquireStatus Status, uint8* ItemMemory, UDataRegistrySource* Source )	Call to indicate that a item is available, will insert into cache
void	HandleCacheEntryState ( const FDataRegistryLookup& Lookup, FCachedDataRegistryItem& CachedEnt... )	Advances state machine for a cached entry
bool	Initialize()	Initialize for requests, called when subsystem starts up and should return true on success
void	InvalidateCacheVersion()	Bump the cache version from some external event like game-specific file loading
bool	IsCacheGetResultValid ( FDataRegistryCacheGetResult Result )	Checks if a previous cached get is still valid
bool	IsInitialized()	Returns true if this state has been initialized for use
UDataRegistr...	LookupSource ( FName& OutResolvedName, const FDataRegistryLookup& Lookup, int32 LookupIndex )	Find the source associated with a lookup index
FName	MapIdToResolvedName ( const FDataRegistryId& ItemId, const UDataRegistrySource* Reg... )	Maps from a type:name pair to a per-source resolved name, default just returns the name
void	MarkRuntimeDirty()	Marks this registry for needing a runtime refresh at next opportunity
FDataRegistr...	OnCacheVersionInvalidated()	Accesses the delegate called when cache version changes
void	RefreshRuntimeSources()	Refresh the RuntimeSources list
bool	RegisterSpecificAsset ( const FAssetData& AssetData, int32 AssetPriority )	Attempt to register a specified asset with a source, returns true if any changes were made.
void	ResetRuntimeState()	Reset caches and state because gameplay finished due to PIE shutting down or the game registering a return to main menu, but stay initialized for future use
bool	ResolveDataRegistryId ( FDataRegistryLookup& OutLookup, const FDataRegistryId& ItemId, const uint8** PrecachedDat... )	Resolves an item id into a specific source and unique id, this can remap the names using game-specific rules.
void	RuntimeRefreshIfNeeded()	Conditionally refresh the runtime state if needed
void	SetRuntimeCachePolicy ( const FDataRegistryCachePolicy& Ne... )	Sets the current cache policy, could cause items to get released
void	TimerUpdate()	Called on timer tick when initialized
int32	UnregisterAssetsWithPriority ( int32 AssetPriority )	Unregisters all previously registered assets in a specific registry with a specific priority, can be used as a batch reset.
bool	UnregisterSpecificAsset ( const FSoftObjectPath& AssetPath )	Removes references to a specific asset, returns bool if it was removed
void	UpdateBatchRequest ( const FDataRegistryRequestId& Requ..., const FDataRegistryAcquireResult& ... )	Check on any batch requests that need processing, if filter is empty will process all

Overridden from UObject

	Name	Description
void	BeginDestroy()	Called before destroying the object.
void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
void	PostRename ( UObject* OldOuter, const FName OldName )	Called at the end of Rename(), but only if the rename was actually carried out

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss