ReplicationStateUtil.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "HAL/Platform.h"
#include "Net/Core/NetBitArray.h"
#include "Net/Core/NetHandle/NetHandleManager.h"
#include "Net/Core/DirtyNetObjectTracker/GlobalDirtyNetObjectTracker.h"
#include "Iris/ReplicationState/ReplicationStateDescriptor.h"
#include "Iris/ReplicationState/ReplicationStateFwd.h"
 
namespace UE::Net
{
    inline void MarkNetObjectStateHeaderDirty(FReplicationStateHeader& Header)
    {
        Private::FReplicationStateHeaderAccessor::MarkStateDirty(Header);
    }
 
} // end namespace UE::Net
 
namespace UE::Net::Private
{
 
inline UE::Net::FReplicationStateHeader& GetReplicationStateHeader(void* StateBuffer, const FReplicationStateDescriptor* Descriptor)
{
    // $IRIS: $TODO: Currently we do not store the offset to the internal replication state
    const SIZE_T ReplicationStateHeaderOffset = (EnumHasAnyFlags(Descriptor->Traits, EReplicationStateTraits::IsNativeFastArrayReplicationState) ? SIZE_T(Descriptor->ChangeMasksExternalOffset - sizeof(FReplicationStateHeader)) : SIZE_T(0));
    return *reinterpret_cast<UE::Net::FReplicationStateHeader*>(reinterpret_cast<uint8*>(StateBuffer) + ReplicationStateHeaderOffset);
}
 
inline bool IsReplicationStateBound(void* StateBuffer, const FReplicationStateDescriptor* Descriptor)
{
    return GetReplicationStateHeader(StateBuffer, Descriptor).IsBound();
}
 
inline FNetBitArrayView GetMemberChangeMask(uint8* StateBuffer, const FReplicationStateDescriptor* Descriptor)
{
    return FNetBitArrayView((FNetBitArrayView::StorageWordType*)(StateBuffer + Descriptor->GetChangeMaskOffset()), Descriptor->ChangeMaskBitCount, FNetBitArrayView::NoResetNoValidate);
}
 
inline FNetBitArrayView GetMemberConditionalChangeMask(uint8* StateBuffer, const FReplicationStateDescriptor* Descriptor)
{
    return FNetBitArrayView((FNetBitArrayView::StorageWordType*)(StateBuffer + Descriptor->GetConditionalChangeMaskOffset()), Descriptor->ChangeMaskBitCount, FNetBitArrayView::NoResetNoValidate);
}
 
inline FNetBitArrayView GetMemberPollMask(uint8* StateBuffer, const FReplicationStateDescriptor* Descriptor)
{
    return FNetBitArrayView((FNetBitArrayView::StorageWordType*)(StateBuffer + Descriptor->GetMemberPollMaskOffset()), Descriptor->MemberCount, FNetBitArrayView::NoResetNoValidate);
}
 
inline void ResetMemberPollMask(uint8* StateBuffer, const FReplicationStateDescriptor* Descriptor)
{
    FNetBitArrayView((FNetBitArrayView::StorageWordType*)(StateBuffer + Descriptor->GetMemberPollMaskOffset()), Descriptor->MemberCount, FNetBitArrayView::ResetOnInit);
}
 
inline void MarkDirty(UE::Net::FReplicationStateHeader& InternalState, FNetBitArrayView& MemberChangeMask, const FReplicationStateMemberChangeMaskDescriptor& ChangeMaskInfo)
{
    // If this state is bound to a replicated object, notify the replication system that we have data to copy
    // Note that we only check the first bit of the changemask, as this is used to indicate whether the property is dirty or not
    // some properties might use additional bits but will only be treated as dirty if the parent bit is set.
    if (InternalState.IsBound() && !MemberChangeMask.GetBit(ChangeMaskInfo.BitOffset))
    {
        FReplicationStateHeaderAccessor::MarkStateDirty(InternalState);
        MarkNetObjectStateHeaderDirty(InternalState);
    }
 
    MemberChangeMask.SetBits(ChangeMaskInfo.BitOffset, ChangeMaskInfo.BitCount);
}
 
}