UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FLifetimeProperty Class Reference

#include <CoreNet.h>

Public Member Functions

 FLifetimeProperty ()=default
 
 FLifetimeProperty (int32 InRepIndex)
 
 FLifetimeProperty (int32 InRepIndex, ELifetimeCondition InCondition, ELifetimeRepNotifyCondition InRepNotifyCondition=REPNOTIFY_OnChanged, bool bInIsPushBased=false)
 
bool operator== (const FLifetimeProperty &Other) const
 

Public Attributes

uint16 RepIndex = 0
 
ELifetimeCondition Condition = COND_None
 
ELifetimeRepNotifyCondition RepNotifyCondition = REPNOTIFY_OnChanged
 
bool bIsPushBased = false
 
UE::Net::CreateAndRegisterReplicationFragmentFunc CreateAndRegisterReplicationFragmentFunction = nullptr
 

Detailed Description

FLifetimeProperty This class is used to track a property that is marked to be replicated for the lifetime of the actor channel. This doesn't mean the property will necessarily always be replicated, it just means: "check this property for replication for the life of the actor, and I don't want to think about it anymore" A secondary condition can also be used to skip replication based on the condition results

Constructor & Destructor Documentation

◆ FLifetimeProperty() [1/3]

FLifetimeProperty::FLifetimeProperty ( )
default

◆ FLifetimeProperty() [2/3]

FLifetimeProperty::FLifetimeProperty ( int32  InRepIndex)
inline

◆ FLifetimeProperty() [3/3]

FLifetimeProperty::FLifetimeProperty ( int32  InRepIndex,
ELifetimeCondition  InCondition,
ELifetimeRepNotifyCondition  InRepNotifyCondition = REPNOTIFY_OnChanged,
bool  bInIsPushBased = false 
)
inline

Member Function Documentation

◆ operator==()

bool FLifetimeProperty::operator== ( const FLifetimeProperty Other) const
inline

Member Data Documentation

◆ bIsPushBased

bool FLifetimeProperty::bIsPushBased = false

Is this property using push model suggestions to help the RepSystem tell when it's really dirty.

◆ Condition

ELifetimeCondition FLifetimeProperty::Condition = COND_None

The replication condition assigned to this property. Default is 'None' which means no conditions are needed.

◆ CreateAndRegisterReplicationFragmentFunction

UE::Net::CreateAndRegisterReplicationFragmentFunc FLifetimeProperty::CreateAndRegisterReplicationFragmentFunction = nullptr

Iris only: optional functor that will be used to create and register a ReplicationFragment for the property

◆ RepIndex

uint16 FLifetimeProperty::RepIndex = 0

The FProperty's RepIndex this struct is representing

◆ RepNotifyCondition

ELifetimeRepNotifyCondition FLifetimeProperty::RepNotifyCondition = REPNOTIFY_OnChanged

The RepNotify behavior of the property. Only useful if CPF_RepNotify is set on the property.


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