1. Epic GamesDeveloper
  3. UMultiUserSubsystem

UMultiUserSubsystem

API > API/Plugins > API/Plugins/MultiUserClientLibrary

Inheritance Hierarchy

References

   
Module MultiUserClientLibrary
Header /Engine/Plugins/Developer/Concert/ConcertApp/MultiUserClient/Source/MultiUserClientLibrary/Public/MultiUserSubsystem.h
Include #include "MultiUserSubsystem.h"

Syntax

UCLASS (BlueprintType, Category="Multi-user", DisplayName="MultiUserSubsystem")  
class UMultiUserSubsystem : public UEngineSubsystem

Variables

  Type Name Description
Public variable UProperty Category BlueprintAssignable FOnSessionClientChanged OnSessionClientChanged Invoked when information about a client changes while the local editor instance is in a session.
Public variable UProperty Category BlueprintAssignable FOnSessionConnected OnSessionConnected Invoked when the local editor instance has joined a session.
Public variable UProperty Category BlueprintAssignable FOnSessionDisconnected OnSessionDisconnected Invoked when the local editor instanced has left a session.

Functions

  Type Name Description
Public function void

DispatchEvent ( const FConcertBlueprintEvent& InEvent
)

 Public interface to send the event to the registered blueprint handler.
Public function Const UFunction BlueprintPure, Category bool

GetLocalClientId ( FGuid& OutClientId
)

 If connected to a session, gets the endpoint identifiers of client corresponding to the local editor instance.
Public function UFunction BlueprintPure, Category bool

GetRemoteClientIds ( TArray< FGuid >& OutRemoteClientIds
)

 If connected to a session, gets the endpoint identifiers of all remote clients.
Public function Const UFunction BlueprintCallable, Category bool Returns true if we are currently in a session.
Public function UFunction BlueprintCallable, Category, Meta customthunk void

K2_ExtractEventData ( UPARAM(ref) FMultiUserBlueprintEventData& EventData,
UPARAM(ref) int32& StructOut
)

 Extract event message data.
Public function UFunction BlueprintCallable, Category, Meta customthunk void

K2_SendCustomEvent ( const int32& EventData
)

 Send a custom event message over multi-user.
Public function UFunction BlueprintCallable, Category bool

RegisterCustomEventHandler ( const UStruct* EventType,
FCustomEventHandler InEventHandler
)

 Register an event handler for the given type.
Public function UFunction BlueprintCallable, Category bool

UnregisterCustomEventHandler ( const UStruct* EventType
)

 Unregister an event handler for the given type.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page