IMultiUserClientModule

Interface for the Multi-User module.

Windows
MacOS
Linux

Inheritance Hierarchy

IModuleInterface

IMultiUserClientModule

References

Module

MultiUserClient

Header

/Engine/Plugins/Developer/Concert/MultiUserClient/Source/MultiUserClient/Public/IMultiUserClientModule.h

Include

#include "IMultiUserClientModule.h"

Syntax

class IMultiUserClientModule : public IModuleInterface

Remarks

Interface for the Multi-User module.

Functions

Name Description

Public function

bool

 

DefaultConnect()

Connect to the default connection setup

Public function

bool

 

DisconnectSession

(
    bool bAlwaysAskConfirmation
)

Disconnect from the current session if any, but prompt the user about session changes first.

Public function Static

IMultiUserCl ...

 

Get()

Singleton-like access to this module's interface.

Public function Const

TSharedPtr < ...

 

GetClient()

Get the sync client that will performing the MultiUser role

Public function Static

bool

 

IsAvailable()

Checks to see if this module is loaded and ready.

Public function

bool

 

IsConcertServerRunning()

Public function

void

 

LaunchConcertServer()

Launches a server (if none are running) on the local machine.

Public function

void

 

OpenBrowser()

Invokes the Multi-User browser tab

Public function

void

 

OpenSettings()

Hot-links to Concert Settings.

Public function

void

 

ShutdownConcertServer()

Shuts down all local servers running. Do nothing if no servers are running.

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback