NetObjectReference.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreTypes.h"
#include "Iris/ReplicationSystem/NetRefHandle.h"
#include "Net/Core/NetToken/NetToken.h"
#include "Misc/EnumClassFlags.h"
#include "Templates/IsPODType.h"
 
class UReplicationSystem;
class UObject;
 
namespace UE::Net::Private
{
    class FObjectReferenceCache;
}
 
namespace UE::Net
{
 
enum class ENetObjectReferenceTraits : uint32
{
    None = 0U,
    CanBeExported = 1U,
};
ENUM_CLASS_FLAGS(ENetObjectReferenceTraits);
 
class FNetObjectReference
{
public:
    inline FNetObjectReference() {}
 
    inline bool IsValid() const { return RefHandle.IsValid() || PathToken.IsValid(); }
    inline bool operator==(const FNetObjectReference& Other) const { return RefHandle == Other.GetRefHandle() && PathToken == Other.PathToken; }
    inline bool operator!=(const FNetObjectReference& Other) const { return !(*this == Other); }
        
    FNetRefHandle GetRefHandle() const { return RefHandle; }
    FNetToken GetPathToken() const { return PathToken; }
    bool CanBeExported() const { return EnumHasAnyFlags(Traits, ENetObjectReferenceTraits::CanBeExported); }
 
    inline FString ToString() const
    {
        if (PathToken.IsValid())
        {
            if (RefHandle.IsValid())
            {
                FString Result(PathToken.ToString());
                Result.Appendf(TEXT(" : %s"), ToCStr(RefHandle.ToString()));
                return Result;          
            }
            else
            {
                return PathToken.ToString();
            }
        }
        else
        {
            return RefHandle.ToString();
        }
    }
 
private:
    friend class Private::FObjectReferenceCache;
 
    inline FNetObjectReference(FNetRefHandle InHandle, FNetToken InPathToken, ENetObjectReferenceTraits InTraits)
        : RefHandle(InHandle)
        , PathToken(InPathToken)
        , Traits(InTraits)
    {
    }
 
    inline explicit FNetObjectReference(FNetRefHandle Handle)
    : FNetObjectReference(Handle, FNetToken(), ENetObjectReferenceTraits::None)
    {
    }
 
    FNetRefHandle RefHandle;
    FNetToken PathToken;
    ENetObjectReferenceTraits Traits = ENetObjectReferenceTraits::None;
};
 
struct FNetDependencyInfo
{
    explicit FNetDependencyInfo(const FNetObjectReference& InObjectRef)
    : ObjectRef(InObjectRef)
    {}
 
    FNetObjectReference ObjectRef;
};
 
enum class ENetObjectReferenceResolveResult : uint32
{
    None = 0U,
    HasUnresolvedReferences = 1 << 0U,
    HasUnresolvedMustBeMappedReferences = HasUnresolvedReferences << 1U,
};
ENUM_CLASS_FLAGS(ENetObjectReferenceResolveResult);
 
}
 
template <> struct TIsPODType<UE::Net::FNetObjectReference> { enum { Value = true }; };