NetSubObjectFactory.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Iris/ReplicationSystem/NetObjectFactory.h"
 
#include "Iris/Core/NetObjectReference.h"
 
#include "NetSubObjectFactory.generated.h"
 
 
namespace UE::Net
{
 
class FNetBaseSubObjectCreationHeader : public FNetObjectCreationHeader
{
public:
    
    virtual bool IsDynamic() const = 0;
 
    virtual bool Serialize(const FCreationHeaderContext& Context) const { return false; }
    virtual bool Deserialize(const FCreationHeaderContext& Context) { return false; }
};
 
 
class FNetStaticSubObjectCreationHeader : public FNetBaseSubObjectCreationHeader
{
public:
 
    virtual bool IsDynamic() const override
    {
        return false;
    }
 
    ENGINE_API virtual bool Serialize(const FCreationHeaderContext& Context) const override;
    ENGINE_API virtual bool Deserialize(const FCreationHeaderContext& Context) override;
 
    ENGINE_API virtual FString ToString() const override;
 
    FNetObjectReference ObjectReference; // Only for static objects
};
 
class FNetDynamicSubObjectCreationHeader : public FNetBaseSubObjectCreationHeader
{
public:
 
    virtual bool IsDynamic() const override
    { 
        return true;
    }
 
    ENGINE_API virtual bool Serialize(const FCreationHeaderContext& Context) const override;
    ENGINE_API virtual bool Deserialize(const FCreationHeaderContext& Context) override;
 
    ENGINE_API virtual FString ToString() const override;
 
    FNetObjectReference TemplateReference;
    FNetObjectReference OuterReference;
    uint8 bUsePersistentLevel : 1 = false;
    uint8 bOuterIsTransientLevel : 1 = false;   // When set the OuterReference was not sent because the Outer is the default transient level.
    uint8 bOuterIsRootObject : 1 = false;       // When set the OuterReference was not sent because the Outer is the known RootObject.
 
};
 
} // end namespace UE::Net
 
UCLASS(MinimalAPI)
class UNetSubObjectFactory : public UNetObjectFactory
{
    GENERATED_BODY()
 
public:
 
    ENGINE_API static FName GetFactoryName();
    
    ENGINE_API virtual FInstantiateResult InstantiateReplicatedObjectFromHeader(const FInstantiateContext& Context, const UE::Net::FNetObjectCreationHeader* Header) override;
 
    ENGINE_API virtual void SubObjectCreatedFromReplication(UE::Net::FNetRefHandle RootObject, UE::Net::FNetRefHandle SubObjectCreated) override;
 
    ENGINE_API virtual void DetachedFromReplication(const FDestroyedContext& Context) override;
 
    ENGINE_API virtual TOptional<FWorldInfoData> GetWorldInfo(const FWorldInfoContext& Context) const override;
 
    ENGINE_API virtual float GetPollFrequency(UE::Net::FNetRefHandle RootObjectHandle, UObject* RootObjectInstance) override;
 
protected:
 
    ENGINE_API virtual TUniquePtr<UE::Net::FNetObjectCreationHeader> CreateAndFillHeader(UE::Net::FNetRefHandle Handle) override;
    ENGINE_API virtual TUniquePtr<UE::Net::FNetObjectCreationHeader> CreateAndDeserializeHeader(const UE::Net::FCreationHeaderContext& Context) override;
 
    ENGINE_API virtual bool SerializeHeader(const UE::Net::FCreationHeaderContext& Context, const UE::Net::FNetObjectCreationHeader* Header)  override;
 
    ENGINE_API bool FillDynamicHeader(UE::Net::FNetDynamicSubObjectCreationHeader* DynamicHeader, const UObject* SubObject, UE::Net::FNetRefHandle Handle);
};