UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Static Public Member Functions | Public Attributes | Friends | List of all members
FAssetIdentifier Struct Reference

#include <AssetIdentifier.h>

Public Member Functions

 FAssetIdentifier (FName InPackageName, FName InObjectName=FName(), FName InValueName=FName())
 
 FAssetIdentifier (const FPrimaryAssetId &PrimaryAssetId, FName InValueName=FName())
 
COREUOBJECT_API FAssetIdentifier (UObject *SourceObject, FName InValueName)
 
 FAssetIdentifier ()
 
FPrimaryAssetId GetPrimaryAssetId () const
 
bool IsPackage () const
 
bool IsObject () const
 
bool IsValue () const
 
bool IsValid () const
 
FString ToString () const
 
void AppendString (FStringBuilderBase &Builder) const
 
bool LexicalLess (const FAssetIdentifier &Other) const
 
bool FastLess (const FAssetIdentifier &Other) const
 
COREUOBJECT_API void WriteCompactBinary (FCbWriter &Writer) const
 

Static Public Member Functions

static FAssetIdentifier FromString (const FString &String)
 

Public Attributes

FName PackageName
 
FPrimaryAssetType PrimaryAssetType
 
FName ObjectName
 
FName ValueName
 

Friends

bool operator== (const FAssetIdentifier &A, const FAssetIdentifier &B)
 
uint32 GetTypeHash (const FAssetIdentifier &Key)
 
FArchive & operator<< (FArchive &Ar, FAssetIdentifier &AssetIdentifier)
 
FCbWriter & operator<< (FCbWriter &Writer, const FAssetIdentifier &Identifier)
 
COREUOBJECT_API friend bool LoadFromCompactBinary (FCbFieldView Field, FAssetIdentifier &Identifier)
 
COREUOBJECT_API friend void SerializeForLog (FCbWriter &Writer, const FAssetIdentifier &Value)
 

Detailed Description

A structure defining a thing that can be reference by something else in the asset registry. Represents either a package of a primary asset id

Constructor & Destructor Documentation

◆ FAssetIdentifier() [1/4]

FAssetIdentifier::FAssetIdentifier ( FName  InPackageName,
FName  InObjectName = FName(),
FName  InValueName = FName() 
)
inline

Can be implicitly constructed from just the package name

◆ FAssetIdentifier() [2/4]

FAssetIdentifier::FAssetIdentifier ( const FPrimaryAssetId &  PrimaryAssetId,
FName  InValueName = FName() 
)
inline

Construct from a primary asset id

◆ FAssetIdentifier() [3/4]

FAssetIdentifier::FAssetIdentifier ( UObject *  SourceObject,
FName  InValueName 
)

◆ FAssetIdentifier() [4/4]

FAssetIdentifier::FAssetIdentifier ( )
inline

Member Function Documentation

◆ AppendString()

void FAssetIdentifier::AppendString ( FStringBuilderBase &  Builder) const
inline

Appends to the given builder the string version of this identifier in Package.Object::Name format

◆ FastLess()

bool FAssetIdentifier::FastLess ( const FAssetIdentifier &  Other) const
inline

◆ FromString()

static FAssetIdentifier FAssetIdentifier::FromString ( const FString &  String)
inlinestatic

Converts from Package.Object::Name format

◆ GetPrimaryAssetId()

FPrimaryAssetId FAssetIdentifier::GetPrimaryAssetId ( ) const
inline

Returns primary asset id for this identifier, if valid

◆ IsObject()

bool FAssetIdentifier::IsObject ( ) const
inline

Returns true if this represents an object, true for both package objects and PrimaryAssetId objects

◆ IsPackage()

bool FAssetIdentifier::IsPackage ( ) const
inline

Returns true if this represents a package

◆ IsValid()

bool FAssetIdentifier::IsValid ( ) const
inline

Returns true if this is a valid non-null identifier

◆ IsValue()

bool FAssetIdentifier::IsValue ( ) const
inline

Returns true if this represents a specific value

◆ LexicalLess()

bool FAssetIdentifier::LexicalLess ( const FAssetIdentifier &  Other) const
inline

◆ ToString()

FString FAssetIdentifier::ToString ( ) const
inline

Returns string version of this identifier in Package.Object::Name format

◆ WriteCompactBinary()

void FAssetIdentifier::WriteCompactBinary ( FCbWriter &  Writer) const

Friends And Related Symbol Documentation

◆ GetTypeHash

uint32 GetTypeHash ( const FAssetIdentifier &  Key)
friend

◆ LoadFromCompactBinary

COREUOBJECT_API friend bool LoadFromCompactBinary ( FCbFieldView  Field,
FAssetIdentifier &  Identifier 
)
friend

◆ operator<< [1/2]

FArchive & operator<< ( FArchive &  Ar,
FAssetIdentifier &  AssetIdentifier 
)
friend

Identifiers may be serialized as part of the registry cache, or in other contexts. If you make changes here you must also change FAssetRegistryVersion

◆ operator<< [2/2]

FCbWriter & operator<< ( FCbWriter &  Writer,
const FAssetIdentifier &  Identifier 
)
friend

◆ operator==

bool operator== ( const FAssetIdentifier &  A,
const FAssetIdentifier &  B 
)
friend

◆ SerializeForLog

COREUOBJECT_API friend void SerializeForLog ( FCbWriter &  Writer,
const FAssetIdentifier &  Value 
)
friend

Member Data Documentation

◆ ObjectName

FName FAssetIdentifier::ObjectName

Specific object within a package. If empty, assumed to be the default asset

◆ PackageName

FName FAssetIdentifier::PackageName

The name of the package that is depended on, this is always set unless PrimaryAssetType is

◆ PrimaryAssetType

FPrimaryAssetType FAssetIdentifier::PrimaryAssetType

The primary asset type, if valid the ObjectName is the PrimaryAssetName

◆ ValueName

FName FAssetIdentifier::ValueName

Name of specific value being referenced, if ObjectName specifies a type such as a UStruct

The documentation for this struct was generated from the following files: