UE::Net::FPropertyReplicationFragment Class Reference

#include <PropertyReplicationFragment.h>

Inheritance diagram for UE::Net::FPropertyReplicationFragment:

Public Member Functions
IRISCORE_API	FPropertyReplicationFragment (EReplicationFragmentTraits InTraits, UObject *InOwner, const FReplicationStateDescriptor *InDescriptor)
IRISCORE_API	~FPropertyReplicationFragment ()
const FPropertyReplicationState *	GetPropertyReplicationState () const
void	Register (FFragmentRegistrationContext &Fragments)
Public Member Functions inherited from UE::Net::FReplicationFragment
	FReplicationFragment (const FReplicationFragment &)=delete
FReplicationFragment &	operator= (const FReplicationFragment &)=delete
	FReplicationFragment (EReplicationFragmentTraits InTraits)
virtual	~FReplicationFragment ()
EReplicationFragmentTraits	GetTraits () const

Static Public Member Functions
static IRISCORE_API FPropertyReplicationFragment *	CreateAndRegisterFragment (UObject *InOwner, const FReplicationStateDescriptor *InDescriptor, FFragmentRegistrationContext &Context)

Protected Member Functions
virtual void	ApplyReplicatedState (FReplicationStateApplyContext &Context) const override
virtual void	CollectOwner (FReplicationStateOwnerCollector *Owners) const override
virtual void	CallRepNotifies (FReplicationStateApplyContext &Context) override
virtual bool	PollReplicatedState (EReplicationFragmentPollFlags PollOption) override
virtual void	ReplicatedStateToString (FStringBuilderBase &StringBuilder, FReplicationStateApplyContext &Context, EReplicationStateToStringFlags Flags) const override

Additional Inherited Members
Protected Attributes inherited from UE::Net::FReplicationFragment
EReplicationFragmentTraits	Traits

Detailed Description

FPropertyReplicationFragment - used to bind PropertyReplicationStates to their owner

Constructor & Destructor Documentation

FPropertyReplicationFragment()

UE::Net::FPropertyReplicationFragment::FPropertyReplicationFragment	(	EReplicationFragmentTraits	InTraits,
		UObject *	InOwner,
		const FReplicationStateDescriptor *	InDescriptor
	)

~FPropertyReplicationFragment()

UE::Net::FPropertyReplicationFragment::~FPropertyReplicationFragment ( )

default

Member Function Documentation

ApplyReplicatedState()

void UE::Net::FPropertyReplicationFragment::ApplyReplicatedState ( FReplicationStateApplyContext &  Context ) const

overrideprotectedvirtual

FReplicationFragment Implementation

Implements UE::Net::FReplicationFragment.

CallRepNotifies()

void UE::Net::FPropertyReplicationFragment::CallRepNotifies ( FReplicationStateApplyContext &  Context )

overrideprotectedvirtual

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

Reimplemented from UE::Net::FReplicationFragment.

CollectOwner()

void UE::Net::FPropertyReplicationFragment::CollectOwner ( FReplicationStateOwnerCollector *  Owners ) const

overrideprotectedvirtual

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

Reimplemented from UE::Net::FReplicationFragment.

CreateAndRegisterFragment()

FPropertyReplicationFragment * UE::Net::FPropertyReplicationFragment::CreateAndRegisterFragment ( UObject *  InOwner, const FReplicationStateDescriptor *  InDescriptor, FFragmentRegistrationContext &  Context  )

static

Create and register a PropertyReplicationFragment using the provided descriptor, the lifetime of the fragment will be managed by the ReplicationSystem Lifetime of the created fragment will be managed by the ReplicationSystem returns a pointer to the created fragment

GetPropertyReplicationState()

const FPropertyReplicationState * UE::Net::FPropertyReplicationFragment::GetPropertyReplicationState ( ) const

inline

Allow access to replication state

PollReplicatedState()

bool UE::Net::FPropertyReplicationFragment::PollReplicatedState ( EReplicationFragmentPollFlags  PollOption )

overrideprotectedvirtual

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 from UE::Net::FReplicationFragment.

Register()

void UE::Net::FPropertyReplicationFragment::Register

(

FFragmentRegistrationContext &

Fragments

)

Register an already existing PropertyReplicationFragment, for example one that is carried around by a base class

ReplicatedStateToString()

void UE::Net::FPropertyReplicationFragment::ReplicatedStateToString ( FStringBuilderBase &  StringBuilder, FReplicationStateApplyContext &  Context, EReplicationStateToStringFlags  Flags  ) const

overrideprotectedvirtual

Optional method to output state data to StringBuilder.

Reimplemented from UE::Net::FReplicationFragment.

---

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

• Engine/Source/Runtime/Net/Iris/Public/Iris/ReplicationSystem/PropertyReplicationFragment.h
• Engine/Source/Runtime/Net/Iris/Private/Iris/ReplicationSystem/PropertyReplicationFragment.cpp