Navigation
API > API/Plugins > API/Plugins/ConcertSyncCore
Requests that sets the state of replication atomically. It can be used to change the streams and / or authority of multiple clients together with the mute state in a single request. This is useful i.e. for setting the session to a preset state.
Upon successful execution, the server will send a FConcertReplication_ChangeClientEvent notification to all affected clients except the requesting client to update them about the changed information; the requesting client receives only sync control changes (since they know the rest they changed).
Upon failure, it is guaranteed no changes have taken place. The request fails whenever any of the following occurs:
- applying the request would generate any authority conflict. For example, a request that wants client 1 and 2 to both replicate the same properties of the same object would fail.
- a client leaves replication before the request is processed and the SkipDisconnectedClients is not set.
This request is only available if EConcertSyncSessionFlags::ShouldEnableRemoteEditing.
| Name | FConcertReplication_PutState_Request |
| Type | struct |
| Header File | /Engine/Plugins/Developer/Concert/ConcertSync/ConcertSyncCore/Source/ConcertSyncCore/Public/Replication/Messages/PutState.h |
| Include Path | #include "Replication/Messages/PutState.h" |
Syntax
USTRUCT ()
struct FConcertReplication_PutState_Request
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Flags | EConcertReplicationPutStateFlags | Additional flags that alter the behavior of the request. | Replication/Messages/PutState.h | |
| MuteChange | FConcertReplication_ChangeMuteState_Request | Mute state to apply after NewStreams and NewAuthorityState has been applied. | Replication/Messages/PutState.h | |
| NewAuthorityState | TMap< FGuid, FConcertObjectInStreamArray > | Maps a client's endpoint ID to new authority it should have. | Replication/Messages/PutState.h | |
| NewStreams | TMap< FGuid, FConcertReplicationStreamArray > | Maps a client's endpoint ID to the stream content it should have. | Replication/Messages/PutState.h |