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