1. Epic GamesDeveloper
  3. FSyncControlState

FSyncControlState

Keeps track of the sync control (AllowedObjects), which is a set of objects a client is allowed to replicate.

API > API/Plugins > API/Plugins/ConcertSyncCore

Keeps track of the sync control (AllowedObjects), which is a set of objects a client is allowed to replicate. It knows how to parse network messages that explicitly and implicitly change sync control and update AllowedObjects.

This class does not know where the network messages come from and is designed to be used as utility by lower level systems.

   
Name FSyncControlState
Type class
Header File /Engine/Plugins/Developer/Concert/ConcertSync/ConcertSyncCore/Source/ConcertSyncCore/Public/Replication/SyncControlState.h
Include Path #include "Replication/SyncControlState.h"

Syntax

class FSyncControlState

Constructors

Name Remarks Include Path Unreal Specifiers
  Replication/SyncControlState.h  

FSyncControlState ( TSet< FConcertObjectInStreamID >&& AllowedObjects
)

 Not explicit to make it useful to use. Replication/SyncControlState.h  

FSyncControlState ( const TSet< FConcertObjectInStreamID >& AllowedObjects
)

   Replication/SyncControlState.h  

Classes

Name Remarks
FPredictedObjectRemoval  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
AllowedObjects TSet< FConcertObjectInStreamID > The objects the client has sync control over, i.e. is allowed to replicate. Replication/SyncControlState.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers
  Replication/SyncControlState.h  

void AppendAuthorityChange ( const FConcertReplication_ChangeAuthority_Request& Request,
const FConcertReplication_ChangeSyncControl& Response,
TOnAllowed&& OnAllowed,
TOnDisallowed&& OnDisallowed
)

 Combines implicit and explicit sync control changes caused by authority changes. Replication/SyncControlState.h  

void AppendChanges ( const FConcertReplication_ChangeSyncControl& Event,
TOnAllowed&& OnAllowed,
TOnDisallowed&& OnDisallowed
)

 Combines past state with an incoming sync control event. Replication/SyncControlState.h  
  Replication/SyncControlState.h  

void AppendStreamChange ( const FConcertReplication_ChangeStream_Request& Request,
TOnDisallowed&& OnDisallowed
)

 Combines implicit sync control changes caused by stream change. Replication/SyncControlState.h  
  Replication/SyncControlState.h  

void ApplyOrRevertMuteResponse ( const FPredictedObjectRemoval& ObjectsRemovedInRequest,
const FConcertReplication_ChangeMuteState_Response& Response,
TOnAllowed&& OnAllowed
)

 Looks at the response: Replication/SyncControlState.h  
  Replication/SyncControlState.h  

void ApplyOrRevertRestoreContentResponse ( const FPredictedObjectRemoval& ObjectsRemovedInRequest,
const FConcertReplication_RestoreContent_Response& Response,
TOnAllowed&& OnAllowed,
TOnDisallowed&& OnDisallowed
)

 Looks at the response Replication/SyncControlState.h  

bool EnumerateAllowedObjects ( TProcessObject Callback
) const

 Enumerates all sync controlled objects. Replication/SyncControlState.h  

bool IsObjectAllowed ( const FConcertObjectInStreamID& Object
) const

   Replication/SyncControlState.h  

uint32 Num()

   Replication/SyncControlState.h  
  Replication/SyncControlState.h  
Combines implicit sync control changes caused by the local client sending a mute event. Replication/SyncControlState.h  

FPredictedObjectRemoval PredictAndApplyRestoreContentChanges ( const FConcertReplication_RestoreContent_Request& Request,
TOnDisallowed&& OnDisallowed
)

 If the request replaces the content, removes sync control for all objects. Replication/SyncControlState.h  

Static

Name Remarks Include Path Unreal Specifiers

static void EnumerateChanges ( const FConcertReplication_ChangeSyncControl& Event,
TOnAllowed&& OnAllowed,
TOnDisallowed&& OnDisallowed
)

 Enumerates the changes that would be made by applying this event. Replication/SyncControlState.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page