Navigation
API > API/Plugins > API/Plugins/MultiUserClientLibrary
Exposes ways to interact with the Multi-user replication system via Blueprints.
| Name | UMultiUserReplicationSubsystem |
| Type | class |
| Header File | /Engine/Plugins/Developer/Concert/ConcertApp/MultiUserClient/Source/MultiUserClientLibrary/Public/Replication/MultiUserReplicationSubsystem.h |
| Include Path | #include "Replication/MultiUserReplicationSubsystem.h" |
Syntax
UCLASS ()
class UMultiUserReplicationSubsystem : public UEngineSubsystem
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → USubsystem → UDynamicSubsystem → UEngineSubsystem → UMultiUserReplicationSubsystem
Classes
| Name | Remarks |
|---|---|
| FOnOfflineClientsChanged | |
| FOnServerStateChanged |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| OnClientAuthorityServerStateChanged | FOnServerStateChanged | Event triggered a client changes the objects it is replicating. | Replication/MultiUserReplicationSubsystem.h |
|
| OnClientStreamServerStateChanged | FOnServerStateChanged | Event triggered when the following changes about a client: | Replication/MultiUserReplicationSubsystem.h |
|
| OnOfflineClientContentChanged | FOnServerStateChanged | Event triggered when the content that an offline client will attempt to re-claim changes. | Replication/MultiUserReplicationSubsystem.h |
|
| OnOfflineClientsChanged | FOnOfflineClientsChanged | Event triggered when the local list of offline clients has changed. | Replication/MultiUserReplicationSubsystem.h |
|
| UObjectAdapter | TSharedPtr< UE::MultiUserClientLibrary::FUObjectAdapterReplicationDiscoverer > | This is used only for when the adds an object through the Add button in the UI. | Replication/MultiUserReplicationSubsystem.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool GetObjectReplicationFrequency
(
const FGuid& ClientId, |
An object can be registered but not replicated. | Replication/MultiUserReplicationSubsystem.h |
|
| Replication/MultiUserReplicationSubsystem.h |
|
||
TArray< FGuid > GetOwningOfflineClients
(
const FSoftObjectPath& ObjectPath |
A list of offline clients that, upon rejoining a session, will attempt to reclaim properties they previously registered for an object, regardless of whether the client left gracefully or due to a crash. | Replication/MultiUserReplicationSubsystem.h |
|
TArray< FConcertPropertyChainWrapper > GetPropertiesRegisteredToObject
(
const FGuid& ClientId, |
An object can be registered but not replicated. | Replication/MultiUserReplicationSubsystem.h |
|
TArray< FSoftObjectPath > GetRegisteredObjects
(
const FGuid& ClientId |
Gets the objects the online or offline client has registered with the server. | Replication/MultiUserReplicationSubsystem.h |
|
TArray< FSoftObjectPath > GetReplicatedObjects
(
const FGuid& ClientId |
Gets the objects that are currently being replicated by the client. | Replication/MultiUserReplicationSubsystem.h |
|
bool IsOwnedByOfflineClient
(
const FSoftObjectPath& ObjectPath |
Replication/MultiUserReplicationSubsystem.h |
|
|
bool IsReplicatingObject
(
const FGuid& ClientId, |
An object can be registered but not replicated. | Replication/MultiUserReplicationSubsystem.h |
|
Overridden from USubsystem
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Deinitialize() |
Replication/MultiUserReplicationSubsystem.h | ||
virtual void Initialize
(
FSubsystemCollectionBase& Collection |
Replication/MultiUserReplicationSubsystem.h |