UE::Net::FReplicationFragment Class Reference

#include <ReplicationFragment.h>

Inheritance diagram for UE::Net::FReplicationFragment:

Public Member Functions
	FReplicationFragment (const FReplicationFragment &)=delete
FReplicationFragment &	operator= (const FReplicationFragment &)=delete
	FReplicationFragment (EReplicationFragmentTraits InTraits)
virtual	~FReplicationFragment ()
EReplicationFragmentTraits	GetTraits () const
virtual void	ApplyReplicatedState (FReplicationStateApplyContext &Context) const =0
virtual void	CollectOwner (FReplicationStateOwnerCollector *Owners) const
virtual void	CallRepNotifies (FReplicationStateApplyContext &Context)
virtual bool	PollReplicatedState (EReplicationFragmentPollFlags PollOption=EReplicationFragmentPollFlags::PollAllState)
virtual void	ReplicatedStateToString (FStringBuilderBase &StringBuilder, FReplicationStateApplyContext &Context, EReplicationStateToStringFlags Flags=EReplicationStateToStringFlags::None) const

Protected Attributes
EReplicationFragmentTraits	Traits

Detailed Description

ReplicationFragment Binds one or more ReplicationState(s) to the owner and is the key piece to defining the state that makes up a NetObject Used to extract and set state data on the game side.

Constructor & Destructor Documentation

FReplicationFragment() [1/2]

UE::Net::FReplicationFragment::FReplicationFragment ( const FReplicationFragment &  )

delete

FReplicationFragment() [2/2]

UE::Net::FReplicationFragment::FReplicationFragment ( EReplicationFragmentTraits  InTraits )

inlineexplicit

~FReplicationFragment()

virtual UE::Net::FReplicationFragment::~FReplicationFragment ( )

inlinevirtual

Member Function Documentation

ApplyReplicatedState()

virtual void UE::Net::FReplicationFragment::ApplyReplicatedState ( FReplicationStateApplyContext &  Context ) const

pure virtual

This is called from the ReplicationSystem / ReplicationBridge whenever we have new data Depending on the traits of the fragment we either get pointer to a StateBuffer in the expected external format including changemask information or we get the raw quantized state buffer along with the changemask information for any received states.

Implemented in UE::Net::TFastArrayReplicationFragment< FastArrayItemType, FastArrayType >, UE::Net::TNativeFastArrayReplicationFragment< FastArrayItemType, FastArrayType, PollingPolicyType >, UE::Net::FPropertyReplicationFragment, and UE::Net::TReplicationFragment< T, ReplicationStateT >.

CallRepNotifies()

virtual void UE::Net::FReplicationFragment::CallRepNotifies ( FReplicationStateApplyContext &  Context )

inlinevirtual

Optional method required for backwards compatibility mode which will be invoked for all Fragment with the EReplicationFragmentTraits::HasRepNotifies trait set.

Reimplemented in UE::Net::TFastArrayReplicationFragment< FastArrayItemType, FastArrayType >, UE::Net::TNativeFastArrayReplicationFragment< FastArrayItemType, FastArrayType, PollingPolicyType >, and UE::Net::FPropertyReplicationFragment.

CollectOwner()

virtual void UE::Net::FReplicationFragment::CollectOwner ( FReplicationStateOwnerCollector *  Owners ) const

inlinevirtual

Optional method required for backwards compatibility mode which is used to propagate required calls to Pre/PostNetReceive/PostRepNotifies.

Reimplemented in UE::Net::Private::FFastArrayReplicationFragmentBase, UE::Net::Private::FNativeFastArrayReplicationFragmentBase, and UE::Net::FPropertyReplicationFragment.

GetTraits()

EReplicationFragmentTraits UE::Net::FReplicationFragment::GetTraits ( ) const

inline

Traits

operator=()

FReplicationFragment & UE::Net::FReplicationFragment::operator= ( const FReplicationFragment &  )

delete

PollReplicatedState()

virtual bool UE::Net::FReplicationFragment::PollReplicatedState ( EReplicationFragmentPollFlags  PollOption = EReplicationFragmentPollFlags::PollAllState )

inlinevirtual

Optional Poll method required for backwards compatibility mode which will be invoked for all Fragment with the EReplicationFragmentTraits::NeedsPoll trait set.

Returns

True if the state is dirty, false if not.

Reimplemented in UE::Net::TFastArrayReplicationFragment< FastArrayItemType, FastArrayType >, UE::Net::TNativeFastArrayReplicationFragment< FastArrayItemType, FastArrayType, PollingPolicyType >, and UE::Net::FPropertyReplicationFragment.

ReplicatedStateToString()

virtual void UE::Net::FReplicationFragment::ReplicatedStateToString ( FStringBuilderBase &  StringBuilder, FReplicationStateApplyContext &  Context, EReplicationStateToStringFlags  Flags = EReplicationStateToStringFlags::None  ) const

inlinevirtual

Optional method to output state data to StringBuilder.

Reimplemented in UE::Net::TFastArrayReplicationFragment< FastArrayItemType, FastArrayType >, UE::Net::TNativeFastArrayReplicationFragment< FastArrayItemType, FastArrayType, PollingPolicyType >, and UE::Net::FPropertyReplicationFragment.

Member Data Documentation

Traits

EReplicationFragmentTraits UE::Net::FReplicationFragment::Traits

protected

---

The documentation for this class was generated from the following file:

• Engine/Source/Runtime/Net/Iris/Public/Iris/ReplicationSystem/ReplicationFragment.h