NetSubObjectRegistry.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/Array.h"
#include "HAL/Platform.h"
#include "UObject/CoreNetTypes.h"
#include "UObject/ObjectKey.h"
 
class UActorComponent;
class UObject;
 
#ifndef UE_NET_SUBOBJECTLIST_WEAKPTR
    #define UE_NET_SUBOBJECTLIST_WEAKPTR 1
#endif
 
namespace UE::Net
{
    class FSubObjectRegistryGetter;
}
 
namespace UE::Net 
{
 
struct FSubObjectRegistry
{
public:
 
    enum class EResult : uint8
    {
        NewEntry,
        AlreadyRegistered,
        NetConditionConflict,
    };
 
    NETCORE_API FSubObjectRegistry::EResult AddSubObjectUnique(UObject* InSubObject, ELifetimeCondition InNetCondition);
 
    NETCORE_API bool RemoveSubObject(UObject* InSubObject);
 
    bool IsEmpty() const { return Registry.Num() == 0; }
    int32 Num() const    { return Registry.Num(); }
 
    NETCORE_API void CleanRegistryIndexes(const TArrayView<int32>& IndexesToClean);
 
    NETCORE_API ELifetimeCondition GetNetCondition(UObject* SubObject) const;
 
    struct FEntry
    {
    private:
#if UE_NET_SUBOBJECTLIST_WEAKPTR
        FWeakObjectPtr SubObject;
#else
        UObject* SubObject = nullptr;
#endif
 
    public:
 
        FObjectKey Key;
 
        ELifetimeCondition NetCondition = COND_None;
 
#if UE_NET_REPACTOR_NAME_DEBUG
        FName SubObjectClassName;
 
        FName SubObjectName;
#endif
 
        FEntry(UObject* InSubObject, ELifetimeCondition InNetCondition = COND_None)
            : SubObject(InSubObject)
            , Key(InSubObject)
            , NetCondition(InNetCondition)
#if UE_NET_REPACTOR_NAME_DEBUG
            , SubObjectClassName(InSubObject != nullptr ? ((UObjectBase*)((UObjectBase*)InSubObject)->GetClass())->GetFName() : NAME_None)
            , SubObjectName(InSubObject != nullptr ? ((UObjectBase*)InSubObject)->GetFName() : NAME_None)
#endif
        {
        }
 
        inline bool operator==(const FEntry& rhs) const { return Key == rhs.Key; }
        inline bool operator==(const UObject* rhs) const    { return SubObject == rhs; }
 
        inline UObject* GetSubObject() const
        {
#if UE_NET_SUBOBJECTLIST_WEAKPTR
            return SubObject.Get();
#else
            return SubObject;
#endif
        }
    };
 
    const TArray<FSubObjectRegistry::FEntry>& GetRegistryList() const { return Registry; }
 
    NETCORE_API bool IsSubObjectInRegistry(const UObject* SubObject) const;
 
private:
 
    TArray<FEntry> Registry;
};
 
struct FReplicatedComponentInfo
{
    UActorComponent* Component = nullptr;
 
    FObjectKey Key;
 
    ELifetimeCondition NetCondition = COND_None;
 
    FSubObjectRegistry SubObjects;
 
#if UE_NET_REPACTOR_NAME_DEBUG
    FName ComponentClassName;
 
    FName ComponentName;
#endif
 
    FReplicatedComponentInfo(UActorComponent* InComponent, ELifetimeCondition InNetCondition = COND_None)
        : Component(InComponent)
        , Key((UObject*)InComponent)
        , NetCondition(InNetCondition)
#if UE_NET_REPACTOR_NAME_DEBUG
        , ComponentClassName(InComponent != nullptr ? ((UObjectBase*)((UObjectBase*)InComponent)->GetClass())->GetFName() : NAME_None)
        , ComponentName(InComponent != nullptr ? ((UObjectBase*)InComponent)->GetFName() : NAME_None)
#endif
    {
    };
 
    bool operator==(const FReplicatedComponentInfo& rhs) const { return Key == rhs.Key; }
    bool operator==(const UActorComponent* rhs) const { return Component == rhs; }
};
 
 
} // namespace UE::Net