1. Epic GamesDeveloper
  3. UMultiUserClientStatics

UMultiUserClientStatics

API > API/Plugins > API/Plugins/MultiUserClientLibrary

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;&41;  
class UMultiUserClientStatics : public UBlueprintFunctionLibrary

Constructors

  Type Name Description
Public function  

UMultiUserClientStatics ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Static UFunction BlueprintCallable, Category, Meta bool Configure the Multi-User client.
Public function Static UFunction BlueprintCallable, Category, Meta TArray< FName >

GatherSessionChanges ( bool IgnorePersisted
)

 Get the list of packages that have changed since the last persist unless ignore persisted is false.
Public function Static UFunction BlueprintCallable, Category, Meta UMultiUserClientSyncDatabase * Get the proxy object for the sync database.
Public function Static UFunction BlueprintCallable, Category, Meta FMultiUserConnectionError Get the last Multi-User connection error that happened, if any
Public function Static UFunction BlueprintCallable, Category, Meta FMultiUserClientInfo Get the local ClientInfo. Works when not connected to a session.
Public function Static UFunction BlueprintCallable, Category, Meta bool

GetMultiUserClientInfoByName ( const FString& ClientName,
FMultiUserClientInfo& ClientInfo
)

 Get the ClientInfo for any Multi-User participant by name.
Public function Static UFunction BlueprintCallable, Category, Meta bool Get Multi-User connection status.
Public function Static UFunction BlueprintCallable, Category, Meta EMultiUserConnectionStatus Get Multi-User connection status.
Public function Static UFunction BlueprintCallable, Category, Meta FTransform

GetMultiUserPresenceTransform ( const FGuid& ClientEndpointId
)

 Get the Presence Actor transform for the specified client endpoint id or identity if the client isn't found
Public function Static UFunction BlueprintCallable, Category, Meta FMultiUserSessionInfo Get the current SessionInfo.
Public function Static UFunction BlueprintCallable, Category, Meta bool Get ClientInfos of current Multi-User participants except for the local user.
Public function Static UFunction BlueprintCallable, Category, Meta void

JumpToMultiUserPresence ( const FString& OtherUserName,
FTransform TransformOffset
)

 Teleport to another Multi-User user's presence.
Public function Static UFunction BlueprintCallable, Category, Meta void Persist the session changes and prepare the files for source control submission.
Public function Static UFunction BlueprintCallable, Category, Meta void

PersistSpecifiedPackages ( const TArray< FName >& PackagesToPersist
)

 Persist the specified sessions changes using source control.
Public function Static UFunction BlueprintCallable, Category, Meta void

SetMultiUserPresenceEnabled ( const bool IsEnabled
)

 Set whether presence is currently enabled and should be shown (unless hidden by other settings)
Public function Static UFunction BlueprintCallable, Category, Meta void

SetMultiUserPresenceVisibility ( const FString& Name,
bool Visibility,
bool PropagateToAll
)

 Set Presence Actor Visibility by display name
Public function Static UFunction BlueprintCallable, Category, Meta void

SetMultiUserPresenceVisibilityById ( const FGuid& ClientEndpointId,
bool Visibility,
bool PropagateToAll
)

 Set Presence Actor Visibility by client id
Public function Static UFunction BlueprintCallable, Category, Meta bool Start the Multi-User default connection process.
Public function Static UFunction BlueprintCallable, Category, Meta void Update Multi-User Workspace Modified Packages to be in sync for source control submission.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page