Navigation
| Name | ConcertSyncClient |
| Type | Developer |
| Part of Plugins | Concert Sync - Client |
| Location | /Engine/Plugins/Developer/Concert/ConcertSync/ConcertSyncClient/Source/ConcertSyncClient/ |
| Module Build Rules | ConcertSyncClient.Build.cs |
Classes
| Name | Remarks |
|---|---|
| AConcertClientDesktopPresenceActor | A AConcertClientDesktopPresenceActor is a child of AConcertClientPresenceActor that is used to represent users in desktop |
| AConcertClientPresenceActor | A ConcertClientPresenceActor is a transient actor representing other client presences during a concert client session. |
| AConcertClientVRPresenceActor | A ConcertClientVRPresenceActor is a child of AConcertClientPresenceActor that is used to represent users in VR |
| FConcertActivityStream | Streams an archived session activities asynchronously and caches them until the client poll and consume them synchronously. |
| FConcertClientLocalDataStore | Maintains a type-safe key/value local map where the values are USTRUCT() struct or a supported basic types (int8, uint8, int16, uint16, int32, uint32, int64, uint64, float, double, bool, FName, FText, FString). |
| FConcertClientMovement | |
| UConcertClientObjectFactory | Factory API that can be implemented to extend the set of objects that Concert understands how to create/destroy. |
Structs
| Name | Remarks |
|---|---|
| FConcertActionDefinition | Defines actions for a given context. |
| FConcertClientLocalTransactionCommonData | Common data for a transaction. |
| FConcertClientLocalTransactionFinalizedData | Finalized data for a transaction. |
| FConcertClientLocalTransactionSnapshotData | Snapshot data for a transaction. |
| FConcertConflictDescriptionBase | Data holding information about conflict that occurred while processing an inbound transaction. |
| FConcertTransactionFilterArgs | |
| FJoinReplicatedSessionArgs | |
| FJoinReplicatedSessionResult | |
| FPersistParameters | Input parameters for persistance of an existing session. |
| FPersistResult | Result of a persist. |
| FRemoteEditEvent |
Interfaces
| Name | Remarks |
|---|---|
| IConcertClientBasePresenceMode | Base class for Multi-User PresenceMode. |
| IConcertClientDataStore | Interacts with a key/value store shared by one or more clients connected to a Concert session. |
| IConcertClientPackageBridge | Bridge between the editor package events and Concert. |
| IConcertClientPresenceManager | |
| IConcertClientPresenceModeFactory | Interface for the presence mode factory The presence manager uses a default implementation but it is possible to change the factory to get different presence mode behavior than the default one. |
| IConcertClientReplicationBridge | A session-independent object bridging Unreal Engine with Concert. |
| IConcertClientReplicationManager | Handles all communication with the server regarding replication. |
| IConcertClientSequencerManager | Sequencer manager that is held by the client sync module that keeps track of open sequencer UIs, regardless of whether a session is open or not Events are registered to client sessions that will then operate on any tracked sequencer UIs |
| IConcertClientTransactionBridge | Bridge between the editor transaction system and Concert. |
| IConcertClientWorkspace | |
| IConcertSyncClient | Interface for a Concert Sync Client. |
| IConcertSyncClientModule | Interface for the Concert Sync Client module. |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FCanFinalizeWorkspaceDelegate | TBaseDelegate_NoParams< bool > | IConcertClientWorkspace.h | |
| FCanProcessPendingPackages | TBaseDelegate_NoParams< bool > | IConcertClientWorkspace.h | |
| FConcertClientReplicationBridgeObjectEvent | TMulticastDelegate_OneParam< void, UObject & > | Replication/IConcertClientReplicationBridge.h | |
| FConcertClientReplicationBridgeObjectPathEvent | TMulticastDelegate_OneParam< void, const FSoftObjectPath & > | Replication/IConcertClientReplicationBridge.h | |
| FOnActivityAddedOrUpdated | TMulticastDelegate_ThreeParams< void, const FConcertClientInfo &, const FConcertSyncActivity &, const FStructOnScope & > | IConcertClientWorkspace.h | |
| FOnApplyTransaction | TMulticastDelegate_TwoParams< void, ETransactionNotification, const bool bIsSnapshot > | IConcertClientTransactionBridge.h | |
| FOnConcertClientCreated | TMulticastDelegate_OneParam< void, TSharedRef< IConcertSyncClient > > | IConcertSyncClientModule.h | |
| FOnConcertClientLocalPackageDiscarded | TMulticastDelegate_OneParam< void, UPackage * > | IConcertClientPackageBridge.h | |
| FOnConcertClientLocalPackageEvent | TMulticastDelegate_TwoParams< void, const FConcertPackageInfo &, const FString & > | IConcertClientPackageBridge.h | |
| FOnConcertClientLocalTransactionFinalized | TMulticastDelegate_TwoParams< void, const FConcertClientLocalTransactionCommonData &, const FConcertClientLocalTransactionFinalizedData & > | IConcertClientTransactionBridge.h | |
| FOnConcertClientLocalTransactionSnapshot | TMulticastDelegate_TwoParams< void, const FConcertClientLocalTransactionCommonData &, const FConcertClientLocalTransactionSnapshotData & > | IConcertClientTransactionBridge.h | |
| FOnConcertClientSyncSessionStartupOrShutdown | TMulticastDelegate_OneParam< void, const IConcertSyncClient * > | IConcertSyncClient.h | |
| FOnConcertClientWorkspaceStartupOrShutdown | TMulticastDelegate_OneParam< void, const TSharedPtr< IConcertClientWorkspace > & > | IConcertSyncClient.h | |
| FOnConcertConflictResolutionForPendingSend | TMulticastDelegate_OneParam< void, const FConcertConflictDescriptionBase &ConflictDescription > | IConcertClientTransactionBridge.h | |
| FOnExecuteAction | TBaseDelegate_NoParams< void > | ConcertActionDefinition.h | |
| FOnFilterTransactionDelegate | TBaseDelegate_OneParam< ETransactionFilterResult, const FConcertTransactionFilterArgs & > | IConcertClientTransactionBridge.h | |
| FOnFinalizeWorkspaceSyncCompleted | TMulticastDelegate_NoParams< void > | IConcertClientWorkspace.h | |
| FOnWorkspaceSynchronized | TMulticastDelegate_NoParams< void > | IConcertClientWorkspace.h | |
| FPackageFilterDelegate | TBaseDelegate_OneParam< EPackageFilterResult, const FConcertPackageInfo & > | IConcertClientPackageBridge.h | |
| FPackageHotReloadHintDelegate | TBaseDelegate_OneParam< bool, const FConcertPackageInfo & > | IConcertClientPackageBridge.h | |
| FTransactionFilterDelegate | TBaseDelegate_TwoParams< ETransactionFilterResult, UObject *, UPackage * > | IConcertClientTransactionBridge.h |
Enums
Public
| Name | Remarks |
|---|---|
| EConcertActionType | Defines the possible type of actions this module can provide. |
| EConcertDataStoreChangeNotificationOptions | The options flags used to register a key/value handler. |
| EEditorPlayMode | Defines the supported editor play modes. |
| EPackageFilterResult | |
| EPersistStatus | Possible outcomes from a session persist. |
| ETransactionNotification |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool operator!
(
EConcertDataStoreChangeNotificationOptions E |
IConcertClientDataStore.h | ||
| IConcertClientDataStore.h | |||
| IConcertClientDataStore.h | |||
| IConcertClientDataStore.h | |||
| IConcertClientDataStore.h | |||
| IConcertClientDataStore.h | |||
| IConcertClientDataStore.h | |||
| IConcertClientDataStore.h |