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 > UDataRegistrySource

Light Theme

Dark Theme

UDataRegistrySource

Specifies a source for DataRegistry items, which is an interface that provides asynchronous access to individual structs

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UDataRegistrySource

UDataRegistrySource_CurveTable

UDataRegistrySource_DataTable

UMetaDataRegistrySource

	UMetaDataRegistrySource_CurveTable
	UMetaDataRegistrySource_DataTable

References

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

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Abstract, EditInlineNew, DefaultToInstanced, Within=DataRegistry, CollapseCategories)
class UDataRegistrySource : public UObject

Remarks

Specifies a source for DataRegistry items, which is an interface that provides asynchronous access to individual structs

Variables

		Name	Description
	bool	bIsInitialized	True if this is currently considered to be initialized
	UDataRegistrySo...	ParentSource	What data source we were created from, if this is a transient source

Functions

	Name	Description
bool	AcquireItem ( FDataRegistrySourceAcquireRequest&... )	Call to start an acquire request
void	AddRuntimeSources ( TArray< UDataRegistrySource* >... )	Gets the list of runtime sources that should be registered for this source, will either be itself or a list of children
UDataRegistr...	CreateTransientSource ( TSubclassOf< UDataRegistrySource > ... )	Creates a new runtime source, but does not register it yet
void	Deinitialize()	Called on editor-defined sources to disable access and restore to state before initialization, won't do anything if not initialized
void	EditorRefreshSource()	Called on editor-defined states to check to check a source is still valid after major changes
FString	GetDebugString()	Return a useful debug name for this source
EDataRegistr...	GetItemAvailability ( const FName& ResolvedName, const uint8** PrecachedDat... )	Returns availability of individual item, also get raw memory address if available
const UScrip...	GetItemStruct()	Gets structure from parent registry
UDataRegistr...	GetOriginalSource()	Returns the editor-defined source, which is either this or the parent source
const UDataR...	GetRegistry()	The outer for this should always be a Registry
UDataRegistr...	GetRegistry()	The outer for this should always be a Registry
void	GetResolvedNames ( TArray< FName >& Names )	Fills in set of all names provided by this source
EDataRegistr...	GetSourceAvailability()	Returns how available this data is generally
void	HandleAcquireResult ( const FDataRegistrySourceAcquireReq..., EDataRegistryAcquireStatus Status, uint8* ItemMemory )	Call to indicate that a item is available, will insert into cache
bool	Initialize()	Called on editor-defined sources to initialize this source so it is ready to take requests
bool	IsInitialized()	Returns true if this state has been initialized for use
bool	IsSpecificAssetRegistered ( const FSoftObjectPath& AssetPath )	Returns true if this asset is already registered with this source
bool	IsTransientSource()	Returns true if this is a runtime-only source
void	RefreshRuntimeSources()	Called to regenerate runtime sources if needed, won't do anything for simple sources
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()	Called on runtime sources to reset caches and related state because game has ended or registry settings have changed
void	TimerUpdate ( float CurrentTime, float TimerUpdateFrequency )	Called by owning source as periodic update, can release resources or refresh connections
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

Overridden from UObject

		Name	Description
	void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally

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

Take our survey

Dismiss