PropertyReplicationState.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "HAL/Platform.h"
#include "Templates/RefCounting.h"
 
namespace UE::Net
{
    struct FReplicationStateDescriptor;
}
 
namespace UE::Net
{
 
class FPropertyReplicationState
{
public:
    IRISCORE_API explicit FPropertyReplicationState(const FReplicationStateDescriptor* Descriptor);
 
    IRISCORE_API FPropertyReplicationState(const FReplicationStateDescriptor* Descriptor, uint8* InStateBuffer);
 
    IRISCORE_API ~FPropertyReplicationState();
 
    IRISCORE_API FPropertyReplicationState(const FPropertyReplicationState& Other);
 
    IRISCORE_API FPropertyReplicationState& operator=(const FPropertyReplicationState& Other);
 
    IRISCORE_API void Set(const FPropertyReplicationState& Other);
    
    IRISCORE_API bool IsValid() const;
 
    //
    // Note: There is little to none error checking in the methods below, they are mostly intended to be used from internal code and tests
    // Expected usage for this type of ReplicationState is through the polling system
    //
 
    IRISCORE_API void SetPropertyValue(uint32 Index, const void* SrcValue);
 
    IRISCORE_API void GetPropertyValue(uint32 Index, void* DstValue) const;
 
    IRISCORE_API bool IsDirty(uint32 Index) const;
 
    IRISCORE_API void MarkDirty(uint32 Index);
 
    IRISCORE_API bool PollPropertyReplicationState(const void* RESTRICT SrcData);
 
    struct FPollParameters
    {
        bool bEnableVerboseProfiling = false;
        bool bForceRefreshObjectReferences = false;
    };
 
    IRISCORE_API bool PollPushBasedPropertyReplicationState(const void* RESTRICT SrcData, const FPollParameters& PollParameters);
 
    IRISCORE_API bool StoreCurrentPropertyReplicationStateForRepNotifies(const void* RESTRICT SrcData, const FPropertyReplicationState* NewStateToBeApplied);
 
    IRISCORE_API void PushPropertyReplicationState(const UObject* Owner, void* RESTRICT DstData, bool bPushAll = false) const;
 
 
    IRISCORE_API bool PollObjectReferences(const void* RESTRICT SrcData);
 
    IRISCORE_API void CopyDirtyProperties(const FPropertyReplicationState& Other);
 
    struct FCallRepNotifiesParameters
    {
        // Previous state if requested
        const FPropertyReplicationState* PreviousState = nullptr;
 
        // This is an init state
        bool bIsInit = false;
 
        // Only call repnotify if value differs from local value
        bool bOnlyCallIfDiffersFromLocal = false;
    };
 
    IRISCORE_API void CallRepNotifies(void* RESTRICT DstData, const FCallRepNotifiesParameters& Params) const;
    inline void CallRepNotifies(void* RESTRICT DstData, const FPropertyReplicationState* PreviousState, bool bIsInit) const;
 
    IRISCORE_API FString ToString(bool bIncludeAll = true) const;
 
    IRISCORE_API const TCHAR* ToString(FStringBuilderBase& StringBuilder, bool bIncludeAll = true) const;
 
    const FReplicationStateDescriptor* GetReplicationStateDescriptor() const { return ReplicationStateDescriptor; }
    uint8* GetStateBuffer() const { return StateBuffer; }
 
protected:
    IRISCORE_API void MarkArrayDirty(uint32 Index);
 
public:
    // These methods are for internal use only.
 
    enum : unsigned
    {
        // How many bits to use to track dirtiness for individual elements.
        TArrayElementChangeMaskBits = 63U,
        // The changemask bit into the TArray changemask info that indicates the TArray is dirty.
        TArrayPropertyChangeMaskBitIndex = 0U,
        // At which offset in the TArray changemask element dirtiness begins.
        TArrayElementChangeMaskBitOffset = 1U,
    };
 
    IRISCORE_API bool IsCustomConditionEnabled(uint32 Index) const;
 
    IRISCORE_API bool IsDirtyForPolling() const;
 
private:
    // Returns true if member should be polled, returns true if memberpollmask is dirty or if changemask is dirty.
    bool IsDirtyForPolling(uint32 Index) const;
 
    // Returns true if changemask or header of the state is marked dirty
    bool IsDirty() const;
    bool IsInitState() const;
    void ConstructStateInternal();
    void DestructStateInternal();
    void InjectState(const FReplicationStateDescriptor* Descriptor, uint8* InStateBuffer);
    void PollPropertyValue(uint32 Index, const void* SrcValue);
    void PushPropertyValue(uint32 Index, void* DstValue) const;
 
    TRefCountPtr<const FReplicationStateDescriptor> ReplicationStateDescriptor;
    uint8* StateBuffer;
    uint32 bOwnState : 1;
};
 
void FPropertyReplicationState::CallRepNotifies(void* RESTRICT DstData, const FPropertyReplicationState* PreviousState, bool bIsInit) const
{
    FCallRepNotifiesParameters Params; 
 
    Params.PreviousState = PreviousState;
    Params.bIsInit = bIsInit;
    CallRepNotifies(DstData, Params);
}
 
}