You've already forked UnrealEngineUWP
mirror of
https://github.com/izzy2lost/UnrealEngineUWP.git
synced 2026-03-26 18:15:20 -07:00
87 lines
4.6 KiB
C++
87 lines
4.6 KiB
C++
// Copyright Epic Games, Inc. All Rights Reserved.
|
|
|
|
#pragma once
|
|
|
|
#include "CoreMinimal.h"
|
|
#include "Kismet/BlueprintFunctionLibrary.h"
|
|
#include "MultiUserClientStatics.generated.h"
|
|
|
|
/**
|
|
* BP copy of FConcertSessionClientInfo
|
|
* Holds info on a client connected through multi-user
|
|
*/
|
|
USTRUCT(BlueprintType)
|
|
struct FMultiUserClientInfo
|
|
{
|
|
GENERATED_BODY()
|
|
|
|
/** Holds the display name of the user that owns this instance. */
|
|
UPROPERTY(VisibleAnywhere, BlueprintReadOnly, Category = "Client Info")
|
|
FGuid ClientEndpointId;
|
|
|
|
/** Holds the display name of the user that owns this instance. */
|
|
UPROPERTY(VisibleAnywhere, BlueprintReadOnly, Category = "Client Info")
|
|
FString DisplayName;
|
|
|
|
/** Holds the color of the user avatar in a session. */
|
|
UPROPERTY(VisibleAnywhere, BlueprintReadOnly, Category = "Client Info")
|
|
FLinearColor AvatarColor;
|
|
|
|
/** Holds an array of tags that can be used for grouping and categorizing. */
|
|
UPROPERTY(VisibleAnywhere, BlueprintReadOnly, AdvancedDisplay, Category = "Client Info")
|
|
TArray<FName> Tags;
|
|
};
|
|
|
|
UCLASS()
|
|
class MULTIUSERCLIENTLIBRARY_API UMultiUserClientStatics : public UBlueprintFunctionLibrary
|
|
{
|
|
GENERATED_UCLASS_BODY()
|
|
|
|
public:
|
|
|
|
/** Set whether presence is currently enabled and should be shown (unless hidden by other settings) */
|
|
UFUNCTION(BlueprintCallable, Category = "Multi-User Presence", meta=(DevelopmentOnly, DisplayName = "Set Multi-User Presence Enabled"))
|
|
static void SetMultiUserPresenceEnabled(const bool IsEnabled = true);
|
|
|
|
/** Set Presence Actor Visibility by display name */
|
|
UFUNCTION(BlueprintCallable, Category = "Multi-User Presence", meta=(DevelopmentOnly, DisplayName = "Set Multi-User Presence Visibility"))
|
|
static void SetMultiUserPresenceVisibility(const FString& Name, bool Visibility, bool PropagateToAll = false);
|
|
|
|
/** Set Presence Actor Visibility by client id */
|
|
UFUNCTION(BlueprintCallable, Category = "Multi-User Presence", meta = (DevelopmentOnly, DisplayName = "Set Multi-User Presence Visibility By Id"))
|
|
static void SetMultiUserPresenceVisibilityById(const FGuid& ClientEndpointId, bool Visibility, bool PropagateToAll = false);
|
|
|
|
/** Get the Presence Actor transform for the specified client endpoint id or identity if the client isn't found */
|
|
UFUNCTION(BlueprintCallable, Category = "Multi-User Presence", meta = (DevelopmentOnly, DisplayName = "Get Multi-User Presence Transform"))
|
|
static FTransform GetMultiUserPresenceTransform(const FGuid& ClientEndpointId);
|
|
|
|
/** Teleport to another Multi-User user's presence. */
|
|
UFUNCTION(BlueprintCallable, Category = "Multi-User Client", meta = (DevelopmentOnly, DisplayName = "Jump to Multi-User Presence"))
|
|
static void JumpToMultiUserPresence(const FString& OtherUserName, FTransform TransformOffset);
|
|
|
|
/** Update Multi-User Workspace Modified Packages to be in sync for source control submission. */
|
|
UFUNCTION(BlueprintCallable, Category = "Multi-User Source Control", meta=(DevelopmentOnly, DeprecatedFunction, DeprecationMessage = "UpdateWorkspaceModifiedPackages is deprecated. Please use PersistMultiUserSessionChanges instead."))
|
|
static void UpdateWorkspaceModifiedPackages();
|
|
|
|
/** Persist the session changes and prepare the files for source control submission. */
|
|
UFUNCTION(BlueprintCallable, Category = "Multi-User Source Control", meta=(DevelopmentOnly, DisplayName = "Persist Multi-User Session Changes"))
|
|
static void PersistMultiUserSessionChanges();
|
|
|
|
/** Get the local ClientInfo. Works when not connected to a session. */
|
|
UFUNCTION(BlueprintCallable, Category = "Multi-User Client", meta=(DevelopmentOnly, DisplayName = "Get Local Multi-User Client Info"))
|
|
static FMultiUserClientInfo GetLocalMultiUserClientInfo();
|
|
|
|
/** Get the ClientInfo for any Multi-User participant by name. The local user is found even when not connected to a session. Returns false is no client was found. */
|
|
UFUNCTION(BlueprintCallable, Category = "Multi-User Client", meta=(DevelopmentOnly, DisplayName = "Get Multi-User Client Info by Name"))
|
|
static bool GetMultiUserClientInfoByName(const FString& ClientName, FMultiUserClientInfo& ClientInfo);
|
|
|
|
/** Get ClientInfos of current Multi-User participants except for the local user. Returns false is no remote clients were found. */
|
|
UFUNCTION(BlueprintCallable, Category = "Multi-User Client", meta=(DevelopmentOnly, DisplayName = "Get Remote Multi-User Client Infos"))
|
|
static bool GetRemoteMultiUserClientInfos(TArray<FMultiUserClientInfo>& ClientInfos);
|
|
|
|
/** Get Multi-User connection status. */
|
|
UFUNCTION(BlueprintCallable, Category = "Multi-User Client", meta=(DevelopmentOnly, DisplayName = "Get Multi-User Connection Status"))
|
|
static bool GetMultiUserConnectionStatus();
|
|
|
|
};
|