1. Epic GamesDeveloper
  3. UMultiUserSubsystem

UMultiUserSubsystem

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

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
  • BlueprintAssignable
  • Category="Multi-user"
OnSessionConnected FOnSessionConnected Invoked when the local editor instance has joined a session. MultiUserSubsystem.h
  • BlueprintAssignable
  • Category="Multi-user"
OnSessionDisconnected FOnSessionDisconnected Invoked when the local editor instanced has left a session. MultiUserSubsystem.h
  • BlueprintAssignable
  • Category="Multi-user"

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
) const

 If connected to a session, gets the endpoint identifiers of client corresponding to the local editor instance. MultiUserSubsystem.h
  • BlueprintPure
  • Category="Multi-user"

bool GetRemoteClientIds ( TArray< FGuid >& OutRemoteClientIds
)

 If connected to a session, gets the endpoint identifiers of all remote clients. MultiUserSubsystem.h
  • BlueprintPure
  • Category="Multi-user"

bool IsConnectedToSession()

 Returns true if we are currently in a session. MultiUserSubsystem.h
  • BlueprintCallable
  • Category="Multi-user"

void K2_ExtractEventData ( FMultiUserBlueprintEventData& EventData,
int32& StructOut
)

 Extract event message data. MultiUserSubsystem.h
  • BlueprintCallable
  • CustomThunk
  • Category="Multi-user"
  • Meta=(CustomStructureParam="StructOut", AllowAbstract="false", DisplayName="Extract Event Data")

void K2_SendCustomEvent ( const int32& EventData
)

 Send a custom event message over multi-user. MultiUserSubsystem.h
  • BlueprintCallable
  • CustomThunk
  • Category="Multi-user"
  • Meta=(CustomStructureParam="EventData", AllowAbstract="false", DisplayName="Send Custom Event")

bool RegisterCustomEventHandler ( const UStruct* EventType,
FCustomEventHandler InEventHandler
)

 Register an event handler for the given type. MultiUserSubsystem.h
  • BlueprintCallable
  • Category="Multi-user"

bool UnregisterCustomEventHandler ( const UStruct* EventType
)

 Unregister an event handler for the given type. MultiUserSubsystem.h
  • BlueprintCallable
  • Category="Multi-user"

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page