Navigation
API > API/Plugins > API/Plugins/ConcertSyncClient
Bridge between the editor transaction system and Concert. Deals with converting local ongoing transactions to Concert transaction data, and applying remote Concert transaction data onto this local instance.
| Name | IConcertClientTransactionBridge |
| Type | class |
| Header File | /Engine/Plugins/Developer/Concert/ConcertSync/ConcertSyncClient/Source/ConcertSyncClient/Public/IConcertClientTransactionBridge.h |
| Include Path | #include "IConcertClientTransactionBridge.h" |
Syntax
class IConcertClientTransactionBridge
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IConcertClientTransactionBridge() |
IConcertClientTransactionBridge.h |
Structs
| Name | Remarks |
|---|---|
| FRemoteTransactionObjectResult | Extended information that describes what changed for a single object within a remote transaction |
| FRemoteTransactionResult | Extended information that describes what changed after applying a remote transaction |
| FScopedIgnoreLocalTransaction | Scoped struct to ignore a local transaction |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void ApplyRemoteTransaction
(
const FConcertTransactionEventBase& InEvent, |
Apply a remote transaction event to this local instance. | IConcertClientTransactionBridge.h | |
void ApplyRemoteTransaction
(
const FConcertTransactionEventBase& InEvent, |
Apply a remote transaction event to this local instance. | IConcertClientTransactionBridge.h | |
bool CanApplyRemoteTransaction() |
Can we currently apply a remote transaction event to this local instance? | IConcertClientTransactionBridge.h | |
FOnApplyTransaction & OnApplyTransaction () |
Notification of an application of a transaction. | IConcertClientTransactionBridge.h | |
FOnConcertConflictResolutionForPendingSend & OnConflictResolutionForPendingSend() |
Callback when a conflict occurs on pending transactions. | IConcertClientTransactionBridge.h | |
FOnConcertClientLocalTransactionFinalized & OnLocalTransactionFinalized() |
Called when an transaction is finalized. This is called during end-frame processing. | IConcertClientTransactionBridge.h | |
FOnConcertClientLocalTransactionSnapshot & OnLocalTransactionSnapshot () |
Called when an ongoing transaction is updated via a snapshot. | IConcertClientTransactionBridge.h | |
void RegisterTransactionFilter
(
FName FilterName, |
Callback to register delegate for handling transaction events | IConcertClientTransactionBridge.h | |
void RegisterTransactionFilter
(
FName FilterName, |
Callback to register delegate for handling transaction events | IConcertClientTransactionBridge.h | |
void SetIncludeAnnotationObjectChanges
(
const bool InIncludeAnnotationObjectChanges |
Set whether to include object changes that have been generated via a transaction annotation (where possible), or whether to send the entire transaction annotation blob instead. | IConcertClientTransactionBridge.h | |
void SetIncludeEditorOnlyProperties
(
const bool InIncludeEditorOnlyProperties |
Set whether or not to include editor-only properties when serializing object and property changes. | IConcertClientTransactionBridge.h | |
void SetIncludeNonPropertyObjectData
(
const bool InIncludeNonPropertyObjectData |
Set whether to include non-property object data in updates, or whether to only include property changes. | IConcertClientTransactionBridge.h | |
void StartBridge () |
Bind to the transaction system to receive transaction events. | IConcertClientTransactionBridge.h | |
void StopBridge () |
Stop briding the transaction system. | IConcertClientTransactionBridge.h | |
void UnregisterTransactionFilter
(
FName FilterName |
Callback to register delegate for handling transaction events | IConcertClientTransactionBridge.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool & GetIgnoreLocalTransactionsRef () |
Function to access the internal bool controlling whether local transactions are currently being tracked. | IConcertClientTransactionBridge.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static TUniquePtr< IConcertClientTransactionBridge > NewInstance() |
Create a new instance of the concrete implementation of this class. | IConcertClientTransactionBridge.h |