ObjectRef.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Misc/StringBuilder.h"
#include "UObject/ObjectHandleDefines.h"
#include "UObject/ObjectFwd.h"
#include "UObject/ObjectMacros.h"
 
#if UE_WITH_OBJECT_HANDLE_LATE_RESOLVE || UE_WITH_OBJECT_HANDLE_TRACKING
 
DECLARE_LOG_CATEGORY_EXTERN(LogObjectRef, Log, All);
 
 
struct FObjectRef;
 
namespace UE::CoreUObject::Private
{
    struct FPackedObjectRef;
    class FObjectPathId;
    FPackedObjectRef MakePackedObjectRef(const FObjectRef& ObjectRef);
}
 
struct FObjectRef
{
    FObjectRef() = default;
    FObjectRef(FName PackageName, FName ClassPackageName, FName ClassName, UE::CoreUObject::Private::FObjectPathId ObjectPath);
    explicit FObjectRef(const UObject* Object);
 
    bool operator==(const FObjectRef&& Other) const
    {
        return (PackageName == Other.PackageName) && (ObjectPathId == Other.ObjectPathId) && (ClassPackageName == Other.ClassPackageName) && (ClassName == Other.ClassName);
    }
 
    FString GetClassPathName(EObjectFullNameFlags Flags = EObjectFullNameFlags::IncludeClassPackage) const
    {
        TStringBuilder<FName::StringBufferSize> Result;
        AppendClassPathName(Result, Flags);
        return FString(Result);
    }
 
    COREUOBJECT_API void AppendClassPathName(FStringBuilderBase& OutClassPathNameBuilder, EObjectFullNameFlags Flags = EObjectFullNameFlags::IncludeClassPackage) const;
 
    COREUOBJECT_API FName GetFName() const;
 
    FString GetPathName() const
    {
        TStringBuilder<FName::StringBufferSize> Result;
        AppendPathName(Result);
        return FString(Result);
    }
 
    COREUOBJECT_API void AppendPathName(FStringBuilderBase& OutPathNameBuilder) const;
 
    FString GetFullName(EObjectFullNameFlags Flags = EObjectFullNameFlags::None) const
    {
        TStringBuilder<256> FullName;
        GetFullName(FullName, Flags);
        return FString(FullName);
    }
 
    void GetFullName(FStringBuilderBase& OutFullNameBuilder, EObjectFullNameFlags Flags = EObjectFullNameFlags::None) const
    {
        OutFullNameBuilder.Reset();
        AppendClassPathName(OutFullNameBuilder, Flags);
        OutFullNameBuilder.AppendChar(TEXT(' '));
        AppendPathName(OutFullNameBuilder);
    }
 
    FString GetExportTextName() const
    {
        TStringBuilder<256> ExportTextName;
        GetExportTextName(ExportTextName);
        return FString(ExportTextName);
    }
 
    void GetExportTextName(FStringBuilderBase& OutExportTextNameBuilder) const
    {
        OutExportTextNameBuilder.Reset();
        AppendClassPathName(OutExportTextNameBuilder);
        OutExportTextNameBuilder.AppendChar(TEXT('\''));
        AppendPathName(OutExportTextNameBuilder);
        OutExportTextNameBuilder.AppendChar(TEXT('\''));
    }
 
    inline bool IsNull() const 
    { 
        return PackageName.IsNone() && ObjectPathId == 0;
    }
 
    COREUOBJECT_API UClass* ResolveObjectRefClass(uint32 LoadFlags = LOAD_None) const;
    COREUOBJECT_API UObject* Resolve(uint32 LoadFlags = LOAD_None) const;
 
public:
    FName PackageName;
    FName ClassPackageName;
    FName ClassName;
 
private:
    uint64 ObjectPathId = 0;
 
    friend UE::CoreUObject::Private::FPackedObjectRef UE::CoreUObject::Private::MakePackedObjectRef(const FObjectRef& ObjectRef);
    UE::CoreUObject::Private::FObjectPathId GetObjectPath() const;
 
};
 
UE_DEPRECATED(5.2, "Use FObjectRef::IsNull() instead")
inline bool IsObjectRefNull(const FObjectRef& ObjectRef) { return ObjectRef.IsNull(); }
 
#endif