NetActorFactory.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 "NetActorFactory.generated.h"
 
namespace UE::Net
{
    enum class EActorNetSpawnInfoFlags : uint32
    {
        None = 0U,
        QuantizeScale = 1U,
        QuantizeLocation = QuantizeScale << 1U,
        QuantizeVelocity = QuantizeLocation << 1U,
    };
    ENUM_CLASS_FLAGS(EActorNetSpawnInfoFlags)
}
 
class UNetActorFactory;
 
 
namespace UE::Net
{
 
class FBaseActorNetCreationHeader : public FNetObjectCreationHeader
{
public:
    virtual bool IsDynamic() const = 0;
    virtual bool IsPreregistered() const = 0;
 
    ENGINE_API EActorNetSpawnInfoFlags GetFactorySpawnFlags(const UNetActorFactory* ActorFactory) const;
 
    ENGINE_API virtual bool Serialize(const FCreationHeaderContext& Context) const;
    ENGINE_API virtual bool Deserialize(const FCreationHeaderContext& Context);
 
public:
 
    TArray<uint8> CustomCreationData;
    uint16 CustomCreationDataBitCount = 0;
};
 
class FStaticActorNetCreationHeader : public FBaseActorNetCreationHeader
{
private:
 
    typedef FBaseActorNetCreationHeader Super;
 
public:
 
    virtual bool IsDynamic() const
    {
        return false;
    }
 
    virtual bool IsPreregistered() const
    {
        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;
 
public:
 
    FNetObjectReference ObjectReference;
};
 
 
class FDynamicActorNetCreationHeader : public FBaseActorNetCreationHeader
{
private:
 
    typedef FBaseActorNetCreationHeader Super;
 
public:
 
    struct FActorNetSpawnInfo
    {
        FActorNetSpawnInfo()
        : Location(EForceInit::ForceInitToZero)
        , Rotation(EForceInit::ForceInitToZero)
        , Scale(FVector::OneVector)
        , Velocity(EForceInit::ForceInitToZero)
        {}
 
        FVector Location;
        FRotator Rotation;
        FVector Scale;
        FVector Velocity;
    };
 
public:
 
    virtual bool IsDynamic() const override
    { 
        return true;
    }
 
    virtual bool IsPreregistered() const
    {
        return false;
    }
 
    ENGINE_API virtual FString ToString() const override;
 
    ENGINE_API virtual bool Serialize(const FCreationHeaderContext& Context) const override;
    ENGINE_API virtual bool Deserialize(const FCreationHeaderContext& Context) override;
 
public:
 
    FActorNetSpawnInfo SpawnInfo;
 
    FNetObjectReference ArchetypeReference;
    FNetObjectReference LevelReference; // Only when bUsePersistentLevel is false
    
    bool bUsePersistentLevel = false;
    bool bIsPreRegistered = false;
};
 
class FPreRegisteredActorNetCreationHeader : public FBaseActorNetCreationHeader
{
private:
 
    typedef FBaseActorNetCreationHeader Super;
 
public:
 
    virtual bool IsDynamic() const override
    { 
        return true;
    }
 
    virtual bool IsPreregistered() const
    {
        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;
};
 
} // end namespace UE::Net
 
UCLASS(MinimalAPI)
class UNetActorFactory : public UNetObjectFactory
{
    GENERATED_BODY()
 
public:
 
    ENGINE_API static FName GetFactoryName();
 
public:
 
    ENGINE_API virtual void OnInit() override;
 
    ENGINE_API virtual FInstantiateResult InstantiateReplicatedObjectFromHeader(const FInstantiateContext& Context, const UE::Net::FNetObjectCreationHeader* Header) override;
 
    ENGINE_API virtual void PostInstantiation(const FPostInstantiationContext& Context) override;
 
    ENGINE_API virtual void PostInit(const FPostInitContext& Context) 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;
 
protected:
 
    ENGINE_API bool FillHeader(UE::Net::FBaseActorNetCreationHeader* BaseHeader, UE::Net::FNetRefHandle Handle, AActor* Actor);
 
public:
 
    const UE::Net::FDynamicActorNetCreationHeader::FActorNetSpawnInfo DefaultSpawnInfo;
 
protected:
 
    friend UE::Net::FBaseActorNetCreationHeader;
 
    UE::Net::EActorNetSpawnInfoFlags SpawnInfoFlags;
 
};