UMultiUserClientStatics

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

MultiUserClientLibrary

Header

/Engine/Plugins/Developer/Concert/MultiUserClient/Source/MultiUserClientLibrary/Public/MultiUserClientStatics.h

Include

#include "MultiUserClientStatics.h"

Syntax

UCLASS()
class UMultiUserClientStatics : public UBlueprintFunctionLibrary

Constructors

Name Description

Public function

UMultiUserClientStatics

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function Static UFunction BlueprintCallable, Category, Meta

bool

 

ConfigureMultiUserClient

(
    const FMultiUserClientConfig& Clie...
)

Configure the Multi-User client.

Public function Static UFunction BlueprintCallable, Category, Meta

FMultiUserCo...

 

GetLastMultiUserConnectionError()

Get the last Multi-User connection error that happened, if any

Public function Static UFunction BlueprintCallable, Category, Meta

FMultiUserCl...

 

GetLocalMultiUserClientInfo()

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

 

GetMultiUserConnectionStatus()

Get Multi-User connection status.

Public function Static UFunction BlueprintCallable, Category, Meta

EMultiUserCo...

 

GetMultiUserConnectionStatusDetail()

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

bool

 

GetRemoteMultiUserClientInfos

(
    TArray< FMultiUserClientInfo >& Cl...
)

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

 

PersistMultiUserSessionChanges()

Persist the session changes and prepare the files for source control submission.

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

 

StartMultiUserDefaultConnection()

Start the Multi-User default connection process.

Public function Static UFunction BlueprintCallable, Category, Meta

void

 

UpdateWorkspaceModifiedPackages()

Update Multi-User Workspace Modified Packages to be in sync for source control submission.