Navigation
API > API/Plugins > API/Plugins/MultiUserClientLibrary
| Name | UMultiUserSubsystem |
| Type | class |
| Header File | /Engine/Plugins/Developer/Concert/ConcertApp/MultiUserClient/Source/MultiUserClientLibrary/Public/MultiUserSubsystem.h |
| Include Path | #include "MultiUserSubsystem.h" |
Syntax
UCLASS (BlueprintType, Category="Multi-user", DisplayName="MultiUserSubsystem")
class UMultiUserSubsystem : public UEngineSubsystem
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → USubsystem → UDynamicSubsystem → UEngineSubsystem → UMultiUserSubsystem
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| OnSessionClientChanged | FOnSessionClientChanged | Invoked when information about a client changes while the local editor instance is in a session. | MultiUserSubsystem.h |
|
| OnSessionConnected | FOnSessionConnected | Invoked when the local editor instance has joined a session. | MultiUserSubsystem.h |
|
| OnSessionDisconnected | FOnSessionDisconnected | Invoked when the local editor instanced has left a session. | MultiUserSubsystem.h |
|
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| CustomEventHandlerTable | TMap< FName, FCustomEventHandler > | Table of registered handlers. | MultiUserSubsystem.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void DispatchEvent
(
const FConcertBlueprintEvent& InEvent |
Public interface to send the event to the registered blueprint handler. | MultiUserSubsystem.h | |
bool GetLocalClientId
(
FGuid& OutClientId |
If connected to a session, gets the endpoint identifiers of client corresponding to the local editor instance. | MultiUserSubsystem.h |
|
| If connected to a session, gets the endpoint identifiers of all remote clients. | MultiUserSubsystem.h |
|
|
bool IsConnectedToSession() |
Returns true if we are currently in a session. | MultiUserSubsystem.h |
|
void K2_ExtractEventData
(
FMultiUserBlueprintEventData& EventData, |
Extract event message data. | MultiUserSubsystem.h |
|
void K2_SendCustomEvent
(
const int32& EventData |
Send a custom event message over multi-user. | MultiUserSubsystem.h |
|
bool RegisterCustomEventHandler
(
const UStruct* EventType, |
Register an event handler for the given type. | MultiUserSubsystem.h |
|
bool UnregisterCustomEventHandler
(
const UStruct* EventType |
Unregister an event handler for the given type. | MultiUserSubsystem.h |
|