Navigation
API > API/Plugins > API/Plugins/MultiUserClient
Inheritance Hierarchy
- IModuleInterface
- IMultiUserClientModule
References
| Module | MultiUserClient |
| Header | /Engine/Plugins/Developer/Concert/ConcertApp/MultiUserClient/Source/MultiUserClient/Public/IMultiUserClientModule.h |
| Include | #include "IMultiUserClientModule.h" |
Syntax
class IMultiUserClientModule : public IModuleInterface
Remarks
Interface for the Multi-User module.
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
bool | Connect to the default connection setup | |
 |
bool | DisconnectSession
(
bool bAlwaysAskConfirmation |
Disconnect from the current session if any, but prompt the user about session changes first. |
  |
IMultiUserClientModule & | Get () |
Singleton-like access to this module's interface. |
  |
TSharedPtr< IConcertSyncClient > | GetClient () |
Get the sync client that will performing the MultiUser role |
  |
UE::MultiUserClient::IMultiUserReplication * | Gets the interface for interacting with the replication system that Multi User sets-up. | |
  |
bool | IsAvailable () |
Checks to see if this module is loaded and ready. |
 |
bool | ||
 |
TOptional< FProcHandle > | LaunchConcertServer
(
TOptional< FServerLaunchOverrides > LaunchOverrides |
Launches a server (if none are running) on the local machine. |
 |
void | OpenBrowser () |
Invokes the Multi-User browser tab |
 |
void | OpenSettings () |
Hot-links to Concert Settings. |
 |
void | Shuts down all local servers running. Do nothing if no servers are running. |