FReplicationStateDescriptor

A ReplicationState is our replication primitive, all members of a ReplicationState has the same high level conditional, i.e. connection level, IsInit, and has the same owner filtering on the block level might be Initial, Connection, Owner Within a ReplicationState we do we also support per member conditionals

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/ReplicationStateDescriptor.h
Include #include "Iris/ReplicationState/ReplicationStateDescriptor.h"

Syntax

struct FReplicationStateDescriptor

Remarks

A ReplicationState is our replication primitive, all members of a ReplicationState has the same high level conditional, i.e. connection level, IsInit, and has the same owner filtering on the block level might be Initial, Connection, Owner Within a ReplicationState we do we also support per member conditionals

Variables

  Type Name Description
Public variable const UScriptStruct * BaseStruct Non-null for derived struct descriptors.
Public variable uint16 ChangeMaskBitCount How many bits do we need for our tracking of dirty changes.
Public variable uint32 ChangeMasksExternalOffset This is the offset to where we store data for changemasks in the external state.
Public variable ConstructReplicationStateFunc ConstructReplicationState Function to construct external state representation in a preallocated buffer.
Public variable CreateAndRegisterReplicationFragmentFunc CreateAndRegisterReplicationFragmentFunction Function used to construct custom replication fragments.
Public variable const FNetDebugName * DebugName Optional debug info.
Public variable const uint8 * DefaultStateBuffer Pointer to default state buffer, must be explicitly destroyed if set since it might contain dynamic data.
Public variable FReplicationStateIdentifier DescriptorIdentifier We need to assign a unique key that is stable between server and client (name hash of class + state type for now)
Public variable DestructReplicationStateFunc DestructReplicationState Function to destruct external state representation.
Public variable uint16 ExternalAlignment  
Public variable uint32 ExternalSize  
Public variable uint16 FunctionCount  
Public variable uint16 InternalAlignment  
Public variable uint32 InternalSize  
Public variable const FReplicationStateMemberChangeMaskDescriptor * MemberChangeMaskDescriptors  
Public variable uint16 MemberCount  
Public variable const FReplicationStateMemberDebugDescriptor * MemberDebugDescriptors  
Public variable const FReplicationStateMemberDescriptor * MemberDescriptors  
Public variable const FReplicationStateMemberFunctionDescriptor * MemberFunctionDescriptors  
Public variable const FReplicationStateMemberLifetimeConditionDescriptor * MemberLifetimeConditionDescriptors Non-null if trait HasLifetimeConditionals is set.
Public variable const FProperty ** MemberProperties This should possibly be moved to its own external descriptor as we do not want to rely on UProperties if we can.
Public variable const FReplicationStateMemberPropertyDescriptor * MemberPropertyDescriptors Additional data associated with applying state data for properties We keep this in a separate array as we might only need this if we can receive data
Public variable const FReplicationStateMemberReferenceDescriptor * MemberReferenceDescriptors  
Public variable const FReplicationStateMemberRepIndexToMemberIndexDescriptor * MemberRepIndexToMemberIndexDescriptors Non-null if RepIndexCount > 0.
Public variable const FReplicationStateMemberSerializerDescriptor * MemberSerializerDescriptors  
Public variable const FReplicationStateMemberTagDescriptor * MemberTagDescriptors  
Public variable const FReplicationStateMemberTraitsDescriptor * MemberTraitsDescriptors  
Public variable uint16 ObjectReferenceCount  
Public variable std::atomic< int32 > RefCount  
Public variable uint16 RepIndexCount How many RepIndex to MemberIndex entries there are.
Public variable uint16 TagCount  
Public variable EReplicationStateTraits Traits  

Functions

  Type Name Description
Public function Const void

AddRef ()

 RefCounting required for runtime created descriptors.
Public function Const uint32  
Public function Const uint32  
Public function Const int32  
Public function Const bool  
Public function Const bool  
Public function Const void

Release ()

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page