Navigation
API > API/Plugins > API/Plugins/ConcertSyncClient > API/Plugins/ConcertSyncClient/Replication
References
| Module | ConcertSyncClient |
| Header | /Engine/Plugins/Developer/Concert/ConcertSync/ConcertSyncClient/Source/ConcertSyncClient/Public/Replication/IConcertClientReplicationBridge.h |
| Include | #include "Replication/IConcertClientReplicationBridge.h" |
Syntax
class IConcertClientReplicationBridge
Remarks
A session-independent object bridging Unreal Engine with Concert. Responsible for tracking the lifetime of replicated objects, i.e. level (un)load, etc.
An UObject is called "available" if it is in a state suitable for replicating; otherwise it is "unavailable". It is "tracked" if this bridge is keep track of whether is available; otherwise is is "untracked". The moment a tracked object is determined to be available it is said to "have been discovered". The moment is determined to be unavailable, it is said to "have become hidden".
In the editor an UObject should be considered
- available:
- in an UWorld the client currently has open,
- in an active data layer,
- unavailable
- in a non-loaded UWorld,
- in an unloaded or loaded data layer (remember that loaded means not visible),
- does not have an UWorld as outer (TODO: in the future this restriction could be lifted - there is no technical reason for it - VP workflows just do not need it right now)
Destructors
| Type | Name | Description | |
|---|---|---|---|
  |
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
UObject * | FindObjectIfAvailable
(
const FSoftObjectPath& Path |
Obtains the object if it is available. |
 |
bool | IsObjectAvailable
(
const FSoftObjectPath& Path |
More lightweight version of FindObjectIfAvailable which does not force the UObject to be loaded, if it is determined to be available. |
 |
FConcertClientReplicationBridgeObjectEvent & | Event for when a replicatable object becomes available, e.g. because its level is loaded. | |
 |
FConcertClientReplicationBridgeObjectPathEvent & | Event for when an object that was previously discovered becomes unavailable, e.g. because it is unloaded. | |
 |
void | PopTrackedObjects
(
TArrayView< const FSoftObjectPath > TrackedObjects |
Stops tracking a list of objects, possibly triggering OnObjectRemoved immediately. |
 |
void | PushTrackedObjects
(
TArrayView< const FSoftObjectPath > TrackedObjects |
Starts tracking a list of objects, possibly triggering OnObjectDiscovered immediately. |