FDerivedData | Unreal Engine 5.7 Documentation

Derived Data Reference

Provides a consistent way to reference derived data:

That has the same API for the editor as for builds with cooked packages.
That has the same API to load from the cache as from a raw buffer, a compressed buffer, or a cooked package.
That supports asynchronous, event-driven, prioritized loading of derived data.
That supports saving to a cooked package without loading from the cache, when using Zen.
That replaces serialized bulk data, such as FByteBulkData, in a cooked package.


Name	FDerivedData
Type	class
Header File	/Engine/Source/Runtime/CoreUObject/Public/Serialization/DerivedData.h
Include Path	#include "Serialization/DerivedData.h"

Syntax

class FDerivedData

Name	Remarks	Include Path
FDerivedData ( const FSharedString& Name, const DerivedData::FCacheKey& Key, const DerivedData::FValueId& ValueId )	References a value in a record that was saved using ICache::Put.	Serialization/DerivedData.h
FDerivedData ( const FSharedString& Name, const FCompressedBuffer& Data )		Serialization/DerivedData.h
FDerivedData ( const FSharedString& Name, const FCompositeBuffer& Data )		Serialization/DerivedData.h
FDerivedData ( const FSharedString& Name, const FSharedBuffer& Data )	References a value that is stored in a buffer.	Serialization/DerivedData.h
FDerivedData ( const DerivedData::Private::FCookedData& CookedData )	Constructs a reference from the private representation of a cooked reference.	Serialization/DerivedData.h
FDerivedData ()	Constructs a null reference.	Serialization/DerivedData.h
FDerivedData ( const FSharedString& Name, const DerivedData::FCacheKey& Key )	References a value that was saved using ICache::PutValue.	Serialization/DerivedData.h

Name	Type	Remarks	Include Path
Null	const FDerivedData	A null reference.	Serialization/DerivedData.h

Name	Type	Remarks	Include Path	Unreal Specifiers
CookedData	DerivedData::Private::FCookedData		Serialization/DerivedData.h
EditorData	TPimplPtr< DerivedData::Private::FEditorData, EPimplPtrMode::DeepCopy >		Serialization/DerivedData.h

Name	Remarks	Include Path
EDerivedDataFlags GetFlags()	Returns the flags, which are mainly relevant for staged references.	Serialization/DerivedData.h
const FSharedString & GetName()	Returns the name of the reference if available.	Serialization/DerivedData.h
bool HasData()	Returns true if this is a non-null reference.	Serialization/DerivedData.h
bool IsCooked()	Returns true if this is a cooked reference.	Serialization/DerivedData.h
bool IsNull()	Returns true if this is a null reference.	Serialization/DerivedData.h
bool ReferenceEquals ( const FDerivedData& Other ) const	Returns true if this and the other are equivalent references.	Serialization/DerivedData.h
uint32 ReferenceHash()	Returns a hash that factors in the same members as ReferenceEquals.	Serialization/DerivedData.h
void Reset()	Resets the reference to null.	Serialization/DerivedData.h
void Serialize ( FArchive& Ar, UObject* Owner )	Serializes this reference to or from a cooked package.	Serialization/DerivedData.h
void SetFlags ( EDerivedDataFlags Flags )	Overwrites the existing flags.	Serialization/DerivedData.h

Name	Remarks	Include Path	Unreal Specifiers
operator bool()	Returns true if this is a non-null reference.	Serialization/DerivedData.h