1. Epic GamesDeveloper
  3. UDataRegistry

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

Unreal Engine C++ API Reference > Plugins > DataRegistry

Inheritance Hierarchy

  • UObject
  • UDataRegistry

References

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

Syntax

UCLASS ()  
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

  Type Name Description
Protected variable UProperty Category, EditDefaultsOnly instanced TArray< TObjectPtr< UDataRegistrySource > > DataSources List of data sources to search for items
Protected variable UProperty Category, EditDefaultsOnly FDataRegistryCachePolicy DefaultCachePolicy Editor-set cache policy
Protected variable UProperty Category, EditDefaultsOnly FDataRegistryIdFormat IdFormat Rules for specifying valid item Ids, if default than any name can be used
Protected variable UProperty Category, EditDefaultsOnly, Meta assetregistrysearchable TObjectPtr< const UScriptStruct > ItemStruct Structure type of all for items in this registry
Protected variable FDataRegistryCacheVersionCallback OnCacheVersionInvalidatedCallback Callback for when cache version changes, might be moved later
Protected variable UProperty Category, EditDefaultsOnly assetregistrysearchable FName RegistryType Globally unique name used to identify this registry
Protected variable FDataRegistryCachePolicy RuntimeCachePolicy Runtime override
Protected variable UProperty Category Transient instanced, visibledefaultsonly TArray< TObjectPtr< UDataRegistrySource > > RuntimeSources TODO remove VisibleDefaultsOnly or figure out how to stop it from letting you edit the instance properties.
Protected variable UProperty Category, EditDefaultsOnly float TimerUpdateFrequency How often to check for cache updates

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Virtual bool Start an async request for a single item
Protected function Virtual bool

AcquireItemInternal ( const FDataRegistryId& ItemId,
const FDataRegistryLookup& Lookup,
FDataRegistryItemAcquiredCallback DelegateToCall,
const FDataRegistryRequestId& BatchRequestId
)

 Start an async request
Protected function Virtual Const void

AddAllIdsForResolvedName ( TSet< FDataRegistryId >& PossibleIds,
const FName& ResolvedName,
const UDataRegistrySource* RegistrySource
)

 Adds all possible source ids for resolved name to set, regardless of request context, default just uses the name
Protected function Static void

AddReferencedObjects ( UObject* InThis,
FReferenceCollector& Collector
)

  
Public function Virtual void Applies the cache policy, is called regularly but can be manually executed
Public function Virtual bool

BatchAcquireItems ( const TArray< FDataRegistryId >& ItemIds,
FDataRegistryBatchAcquireCallback DelegateToCall
)

 Start an async request for multiple items
Public function Virtual bool Request a list of source items
Protected function Virtual void  
Public function Virtual void Disable access and restore to state before initialization, won't do anything if not initialized
Protected function Virtual void Frame-delayed callback to call success for already loaded items
Public function Virtual Const bool Use this to confirm that a DataRegistryRegisterAssetResult caused a change to the Data Registry.
Public function Const bool

DoesItemStructMatchFilter ( FName FilterStructName
)

 Returns true if this registry struct inherits from a particular named struct
Public function Virtual void Validate and refresh registration
Protected function Const const FCachedDataRegistryItem *

FindCachedData ( const FDataRegistryId& ItemId,
const uint8** PrecachedDataPtr
)

 Returns internal cached data or raw memory ptr for precached data
Public function Const void

ForEachCachedItem ( const FString& ContextString,
TFunctionRef< void(const FName&Name, const T&Item)> Predicate
)

 Method to run the given predicate on all items
Public function Virtual Const FDataRegistryCacheGetResult

GetAllCachedItems ( TMap< FDataRegistryId, const uint8* >& OutItemMap,
const UScriptStruct*& OutItemStruct
)

 Fills in a map with all cached (and precached) ids and items for fast iteration.
Public function Const void

GetAllItems ( const TCHAR* ContextString,
TArray< const T* >& Items
)

 Method to get all items in the registry
Public function Virtual Const void

GetAllSourceItems ( TArray< FDataRegistrySourceItemId >& OutSourceItems
)

 Returns all source ids for editor display
Public function Virtual Const FDataRegistryCacheGetResult

GetCachedCurveRaw ( const FRealCurve*& OutCurve,
const FDataRegistryId& ItemId
)

 Curve wrapper for get function
Public function Const const T *

GetCachedItem ( const FDataRegistryId& ItemId
)

 Finds the cached item, using the request context to handle remapping
Public function Virtual Const FDataRegistryCacheGetResult

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

 Returns the raw cached data and struct type, useful for generic C++ calls
Public function Virtual Const FDataRegistryCacheGetResult

GetCachedItemRawFromLookup ( const uint8*& OutItemMemory,
const UScriptStruct*& OutItemStruct,
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
Public function Virtual Const FDataRegistryCacheGetResult Returns the current cache version for a successful get, may change depending on stack-specific resolve settings
Public function Virtual Const void

GetChildRuntimeSources ( UDataRegistrySource* ParentSource,
TArray< UDataRegistrySource* >& ChildSources
)

 Gets list of child runtime sources created by passed in source, in order registered
Public function Static float Gets the current time
Public function Const const FDataRegistryIdFormat & Gets the formatting for this Id
Public function Const void

GetItemNames ( TArray< FName >& ItemNames
)

 Method to get all item names in teh registry
Public function Const const UScriptStruct * Returns the struct used by this registry, everything returned will be this or a subclass
Public function Virtual Const EDataRegistryAvailability Returns the worst availability for anything stored in this registry, if this is Precached then this registry is a wrapper around already loaded data
Public function Virtual Const void

GetPossibleRegistryIds ( TArray< FDataRegistryId >& OutRegistryIds,
bool bSortForDisplay
)

 Fills in a list of all item ids provided by this registry, sorted for display
Public function Virtual Const FText Gets a human readable summary of registry, for UI usage
Public function Const const FName Returns the name for type exposed by this registry
Public function Const const FDataRegistryCachePolicy & Gets the current general cache policy
Public function Const int32

GetSourceIndex ( const UDataRegistrySource* Source,
bool bUseRuntimeSources
)

 Returns the index of a source in the source list
Public function Static FTimerManager * Returns a timer manager that is safe to use for asset loading actions.
Protected function Virtual void

HandleAcquireCallbacks ( const FDataRegistryLookup& Lookup,
FCachedDataRegistryItem& CachedEntry
)

 Handle sending completion/error callbacks
Public function Virtual void Call to indicate that a item is available, will insert into cache
Protected function Virtual void

HandleCacheEntryState ( const FDataRegistryLookup& Lookup,
FCachedDataRegistryItem& CachedEntry
)

 Advances state machine for a cached entry
Public function Virtual bool Initialize for requests, called when subsystem starts up and should return true on success
Public function Virtual void Bump the cache version from some external event like game-specific file loading
Public function Virtual Const bool Checks if a previous cached get is still valid
Public function Virtual Const bool Returns true if this state has been initialized for use
Public function Virtual Const UDataRegistrySource *

LookupSource ( FName& OutResolvedName,
const FDataRegistryLookup& Lookup,
int32 LookupIndex
)

 Find the source associated with a lookup index
Protected function Virtual Const FName

MapIdToResolvedName ( const FDataRegistryId& ItemId,
const UDataRegistrySource* RegistrySource
)

 Maps from a type:name pair to a per-source resolved name, default just returns the name
Public function Virtual void Marks this registry for needing a runtime refresh at next opportunity
Public function Virtual FDataRegistryCacheVersionCallback & Accesses the delegate called when cache version changes
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

  
Public function Virtual void

PostRename ( UObject* OldOuter,
const FName OldName
)

  
Protected function Virtual void Refresh the RuntimeSources list
Public function Virtual EDataRegistryRegisterAssetResult

RegisterSpecificAsset ( const FAssetData& AssetData,
int32 AssetPriority
)

 Attempt to register a specified asset with a source, returns an EDataRegistryRegisterAssetResult, indicating whether the asset was registered or not.
Public function Virtual void 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
Public function Virtual Const bool

ResolveDataRegistryId ( FDataRegistryLookup& OutLookup,
const FDataRegistryId& ItemId,
const uint8** PrecachedDataPtr
)

 Resolves an item id into a specific source and unique id, this can remap the names using game-specific rules.
Public function Virtual void Conditionally refresh the runtime state if needed
Public function void Sets the current cache policy, could cause items to get released
Protected function Virtual void Called on timer tick when initialized
Public function Virtual int32

UnregisterAssetsWithPriority ( int32 AssetPriority
)

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

UnregisterSpecificAsset ( const FSoftObjectPath& AssetPath
)

 Removes references to a specific asset, returns bool if it was removed
Protected function Virtual void Check on any batch requests that need processing, if filter is empty will process all

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page