1. Epic GamesDeveloper
  3. UMultiUserClientStatics

UMultiUserClientStatics

API > API/Plugins > API/Plugins/MultiUserClientLibrary

   
Name UMultiUserClientStatics
Type class
Header File /Engine/Plugins/Developer/Concert/ConcertApp/MultiUserClient/Source/MultiUserClientLibrary/Public/MultiUserClientStatics.h
Include Path #include "MultiUserClientStatics.h"

Syntax

UCLASS ()  
class UMultiUserClientStatics : public UBlueprintFunctionLibrary

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UMultiUserClientStatics ( const FObjectInitializer& ObjectInitializer
)

   MultiUserClientStatics.h  

Functions

Public

Static

Name Remarks Include Path Unreal Specifiers

static bool ConfigureMultiUserClient ( const FMultiUserClientConfig& ClientConfig
)

 Configure the Multi-User client. MultiUserClientStatics.h
  • BlueprintCallable
  • Category="Multi-User Client"
  • Meta=(DevelopmentOnly, DisplayName="Configure Multi-User Client")

static TArray< FName > GatherSessionChanges ( bool IgnorePersisted
)

 Get the list of packages that have changed since the last persist unless ignore persisted is false. MultiUserClientStatics.h
  • BlueprintCallable
  • Category="Multi-User Source Control"
  • Meta=(DevelopmentOnly, DsiplayName="Get List of Packages that have changed.")

static UMultiUserClientSyncDatabase * GetConcertSyncDatabase()

 Get the proxy object for the sync database. MultiUserClientStatics.h
  • BlueprintCallable
  • Category="Multi-User Source Control"
  • Meta=(DevelopmentOnly, DsiplayName="Get Multi-user Sync Database.")

static FMultiUserConnectionError GetLastMultiUserConnectionError()

 Get the last Multi-User connection error that happened, if any MultiUserClientStatics.h
  • BlueprintCallable
  • Category="Multi-User Client"
  • Meta=(DevelopmentOnly, DisplayName="Get Last Multi-User Connection Error")

static FMultiUserClientInfo GetLocalMultiUserClientInfo()

 Get the local ClientInfo. Works when not connected to a session. MultiUserClientStatics.h
  • BlueprintCallable
  • Category="Multi-User Client"
  • Meta=(DevelopmentOnly, DisplayName="Get Local Multi-User Client Info")

static bool GetMultiUserClientInfoByName ( const FString& ClientName,
FMultiUserClientInfo& ClientInfo
)

 Get the ClientInfo for any Multi-User participant by name. MultiUserClientStatics.h
  • BlueprintCallable
  • Category="Multi-User Client"
  • Meta=(DevelopmentOnly, DisplayName="Get Multi-User Client Info by Name")

static bool GetMultiUserConnectionStatus()

 Get Multi-User connection status. MultiUserClientStatics.h
  • BlueprintCallable
  • Category="Multi-User Client"
  • Meta=(DevelopmentOnly, DeprecatedFunction, DeprecationMessage="'Get Multi-User Connection Status' is deprecated. Please use 'Get Multi-User Connection Status Detail' instead.", DisplayName="Get Multi-User Connection Status")

static EMultiUserConnectionStatus GetMultiUserConnectionStatusDetail()

 Get Multi-User connection status. MultiUserClientStatics.h
  • BlueprintCallable
  • Category="Multi-User Client"
  • Meta=(DevelopmentOnly, DisplayName="Get Multi-User Connection Status Detail")

static FTransform GetMultiUserPresenceTransform ( const FGuid& ClientEndpointId
)

 Get the Presence Actor transform for the specified client endpoint id or identity if the client isn't found MultiUserClientStatics.h
  • BlueprintCallable
  • Category="Multi-User Presence"
  • Meta=(DevelopmentOnly, DisplayName="Get Multi-User Presence Transform")
Get the current SessionInfo. MultiUserClientStatics.h
  • BlueprintCallable
  • Category="Multi-User Client"
  • Meta=(DevelopmentOnly, DisplayName="Get Multi-User Session Info")
Get ClientInfos of current Multi-User participants except for the local user. MultiUserClientStatics.h
  • BlueprintCallable
  • Category="Multi-User Client"
  • Meta=(DevelopmentOnly, DisplayName="Get Remote Multi-User Client Infos")

static void JumpToMultiUserPresence ( const FString& OtherUserName,
FTransform TransformOffset
)

 Teleport to another Multi-User user's presence. MultiUserClientStatics.h
  • BlueprintCallable
  • Category="Multi-User Presence"
  • Meta=(DevelopmentOnly, DisplayName="Jump to Multi-User Presence")

static void PersistMultiUserSessionChanges()

 Persist the session changes and prepare the files for source control submission. MultiUserClientStatics.h
  • BlueprintCallable
  • Category="Multi-User Revision Control"
  • Meta=(DevelopmentOnly, DisplayName="Persist Multi-User Session Changes", Keywords="Source Control")

static void PersistSpecifiedPackages ( const TArray< FName >& PackagesToPersist
)

 Persist the specified sessions changes using source control. MultiUserClientStatics.h
  • BlueprintCallable
  • Category="Multi-User Source Control"
  • Meta=(DevelopmentOnly, DsiplayName="Persist Multi-User Sessions Changes (By Package name)")

static void SetMultiUserPresenceEnabled ( const bool IsEnabled
)

 Set whether presence is currently enabled and should be shown (unless hidden by other settings) MultiUserClientStatics.h
  • BlueprintCallable
  • Category="Multi-User Presence"
  • Meta=(DevelopmentOnly, DisplayName="Set Multi-User Presence Enabled")

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

 Set Presence Actor Visibility by display name MultiUserClientStatics.h
  • BlueprintCallable
  • Category="Multi-User Presence"
  • Meta=(DevelopmentOnly, DisplayName="Set Multi-User Presence Visibility")

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

 Set Presence Actor Visibility by client id MultiUserClientStatics.h
  • BlueprintCallable
  • Category="Multi-User Presence"
  • Meta=(DevelopmentOnly, DisplayName="Set Multi-User Presence Visibility By Id")

static bool StartMultiUserDefaultConnection()

 Start the Multi-User default connection process. MultiUserClientStatics.h
  • BlueprintCallable
  • Category="Multi-User Client"
  • Meta=(DevelopmentOnly, DisplayName="Start Multi-User Default Connection")

static void UpdateWorkspaceModifiedPackages()

 Update Multi-User Workspace Modified Packages to be in sync for source control submission. MultiUserClientStatics.h
  • BlueprintCallable
  • Category="Multi-User Revision Control"
  • Meta=(DevelopmentOnly, DeprecatedFunction, DeprecationMessage="UpdateWorkspaceModifiedPackages is deprecated. Please use PersistMultiUserSessionChanges instead.", Keywords="Source Control")

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page