NetworkPredictionInterface.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
//=============================================================================
// INetworkPredictionInterface is an interface for objects that want to perform
// network prediction of movement. See UCharacterMovementComponent for an example implementation.
//=============================================================================
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "UObject/Interface.h"
#include "NetworkPredictionInterface.generated.h"
 
UINTERFACE(MinimalAPI, meta=(CannotImplementInterfaceInBlueprint))
class UNetworkPredictionInterface : public UInterface
{
    GENERATED_UINTERFACE_BODY()
};
 
class INetworkPredictionInterface
{
    GENERATED_IINTERFACE_BODY()
 
    //--------------------------------
    // Server hooks
    //--------------------------------
 
    
    virtual void SendClientAdjustment()                 PURE_VIRTUAL(INetworkPredictionInterface::SendClientAdjustment,);
 
    virtual bool ForcePositionUpdate(float DeltaTime)   PURE_VIRTUAL(INetworkPredictionInterface::ForcePositionUpdate, return false;);
 
    //--------------------------------
    // Client hooks
    //--------------------------------
 
    virtual void SmoothCorrection(const FVector& OldLocation, const FQuat& OldRotation, const FVector& NewLocation, const FQuat& NewRotation) PURE_VIRTUAL(INetworkPredictionInterface::SmoothCorrection,);
 
    //--------------------------------
    // Other
    //--------------------------------
 
    virtual class FNetworkPredictionData_Client* GetPredictionData_Client() const PURE_VIRTUAL(INetworkPredictionInterface::GetPredictionData_Client, return NULL;);
    
    virtual class FNetworkPredictionData_Server* GetPredictionData_Server() const PURE_VIRTUAL(INetworkPredictionInterface::GetPredictionData_Server, return NULL;);
 
    virtual bool HasPredictionData_Client() const PURE_VIRTUAL(INetworkPredictionInterface::HasPredictionData_Client, return false;);
 
    virtual bool HasPredictionData_Server() const PURE_VIRTUAL(INetworkPredictionInterface::HasPredictionData_Server, return false;);
 
    virtual void ResetPredictionData_Client() PURE_VIRTUAL(INetworkPredictionInterface::ResetPredictionData_Client,);
 
    virtual void ResetPredictionData_Server() PURE_VIRTUAL(INetworkPredictionInterface::ResetPredictionData_Server,);
};
 
 
// Network data representation on the client
class FNetworkPredictionData_Client
{
public:
 
    FNetworkPredictionData_Client()
    {
    }
 
    virtual ~FNetworkPredictionData_Client() {}
 
    virtual void AddStructReferencedObjects(FReferenceCollector& Collector) const {};
};
 
 
// Network data representation on the server
class FNetworkPredictionData_Server
{
public:
 
    FNetworkPredictionData_Server()
    : ServerTimeStamp(0.f)
    , ServerTimeBeginningForcedUpdates(0.f)
    , ServerTimeLastForcedUpdate(0.f)
    , bTriggeringForcedUpdates(false)
    , bForcedUpdateDurationExceeded(false)
    , bLastRequestNeedsForcedUpdates(false)
    {
    }
 
    virtual ~FNetworkPredictionData_Server() {}
 
    virtual void ResetForcedUpdateState()
    {
        ServerTimeBeginningForcedUpdates = 0.0f;
        ServerTimeLastForcedUpdate = 0.0f;
        bTriggeringForcedUpdates = false;
        bForcedUpdateDurationExceeded = false;
    }
 
    virtual void AddStructReferencedObjects(FReferenceCollector& Collector) const {};
 
    float ServerTimeStamp;
 
    // Forced update state
 
    float ServerTimeBeginningForcedUpdates;
 
    float ServerTimeLastForcedUpdate;
 
    uint8 bTriggeringForcedUpdates : 1;
 
    uint8 bForcedUpdateDurationExceeded : 1;
 
    uint8 bLastRequestNeedsForcedUpdates : 1;
 
    virtual void Serialize(FArchive& Archive)
    {
        if (Archive.IsMigratingRemoteObjects())
        {
            Archive << ServerTimeStamp;
            Archive << ServerTimeBeginningForcedUpdates;
            Archive << ServerTimeLastForcedUpdate;
            
            bool bTempTriggeringForcedUpdates = bTriggeringForcedUpdates;
            Archive << bTempTriggeringForcedUpdates;
            bTriggeringForcedUpdates = bTempTriggeringForcedUpdates;
 
            bool bTempForcedUpdateDurationExceeded = bForcedUpdateDurationExceeded;
            Archive << bTempForcedUpdateDurationExceeded;
            bForcedUpdateDurationExceeded = bTempForcedUpdateDurationExceeded;
 
            bool bTempLastRequestNeedsForcedUpdates = bLastRequestNeedsForcedUpdates;
            Archive << bTempLastRequestNeedsForcedUpdates;
            bLastRequestNeedsForcedUpdates = bTempLastRequestNeedsForcedUpdates;
        }
    }
};