1. Epic GamesDeveloper
  3. FPropertyReplicationState

FPropertyReplicationState

ReplicationState created at runtime using a descriptor built from existing reflection data StateBuffer contains storage for all properties described by the descriptor, When polling data from the source object properties we will compare the value with what we have stored in the statebuffer and mark the member as dirty.if the value differs

API > API/Runtime > API/Runtime/IrisCore > API/Runtime/IrisCore/Iris > API/Runtime/IrisCore/Iris/ReplicationState

References

   
Module IrisCore
Header /Engine/Source/Runtime/Experimental/Iris/Core/Public/Iris/ReplicationState/PropertyReplicationState.h
Include #include "Iris/ReplicationState/PropertyReplicationState.h"

Syntax

class FPropertyReplicationState

Remarks

ReplicationState created at runtime using a descriptor built from existing reflection data StateBuffer contains storage for all properties described by the descriptor, When polling data from the source object properties we will compare the value with what we have stored in the statebuffer and mark the member as dirty.if the value differs

Polling is quite expensive but we only do it once per update of the replication system

Constructors

  Type Name Description
Public function   Construct a new state, StateBuffer will be allocated and constructed according to data in the descriptor
Public function   Copy constructor, will not copy internal data
Public function  

FPropertyReplicationState ( const FReplicationStateDescriptor* Descriptor,
uint8* InStateBuffer
)

 Construct a new state, using already constructed state in InStateBuffer

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function Const void

CallRepNotifies ( void*RESTRICT DstData,
const FPropertyReplicationState* PreviousState,
bool bIsInit
)

  
Public function Const void

CallRepNotifies ( void*RESTRICT DstData,
const FCallRepNotifiesParameters& Params
)

 Invoke repnotifies for all dirty members
Public function void Copy dirty properties from the other state including changemask
Public function Const void

GetPropertyValue ( uint32 Index,
void* DstValue
)

 Retrieve the value at the provided Index by writing it to DstValue.
Public function Const const FReplicationStateDescriptor *  
Public function Const uint8 *  
Public function Const bool If state has custom conditionals then this function will check whether the condition is enabled or not.
Public function Const bool

IsDirty ( uint32 Index
)

 Is the property at the given index dirty, for properties with multiple bits in the statemask this will return true if any of those bits are set
Public function Const bool

IsValid ()

 Either StateBuffer is initialized and owned by this instance, or we have been injected with a state from the network system A default constructed state is not valid
Protected function void Explicitly mark an array at the given Index as dirty.
Public function void

MarkDirty ( uint32 Index
)

 Explicitly mark the property at the given Index as dirty, for properties with multiple bits in the statemask this will mark all bits dirty
Public function bool

PollObjectReferences ( const void*RESTRICT SrcData
)

 Poll data from object referencing properties in SrcData, Note: SrcData is a UObject containing properties.
Public function bool

PollPropertyReplicationState ( const void*RESTRICT SrcData
)

 $IRIS TODO: Move Poll/Push/CallRepNotifies out of PropertyReplicationState as loose functions Poll src data from properties in SrcData, where SrcData is a UClass/UStruct containing properties.
Public function Const void

PushPropertyReplicationState ( const UObject* Owner,
void*RESTRICT DstData,
bool bPushAll
)

 Push received state data to properties in DstData buffer.
Public function void

Set ( const FPropertyReplicationState& Other
)

 Set from Other this will update dirtiness by comparing all properties
Public function void

SetPropertyValue ( uint32 Index,
const void* SrcValue
)

 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 Set the value at the provided Index, The UProperty is looked up from the descriptor using the index, if the value differs the statemask is updated Mostly intended for test code Normal use of this class is through the poll layer TODO: It would be nice if we could provide some validation on property types
Public function bool

StoreCurrentPropertyReplicationStateForRepNotifies ( const void*RESTRICT SrcData,
const FPropertyReplicationState* NewStateToBeApplied
)

 Certain rep notifies requires the current state to be stored before we overwrite it, this method will copy property values from src data, , where SrcData is a UClass/UStruct containing properties if the property is marked as dirty in NewStateToBeApplied
Public function Const FString

ToString ( bool bIncludeAll
)

 Debug output state to FString
Public function Const const TCHAR *

ToString ( FStringBuilderBase& StringBuilder,
bool bIncludeAll
)

 Debug output state to StringBuilder

Operators

  Type Name Description
Public function FPropertyReplicationState & Assignment operator, it is debatable if this should be provided or not.

Classes

  Type Name Description
Public struct FCallRepNotifiesParameters    

Enums

  Type Name Description
Public enum API/Runtime/IrisCore/Iris/ReplicationState/FPropertyReplicationState_1    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page