InputDeviceLibrary.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Kismet/BlueprintFunctionLibrary.h"
#include "GameFramework/InputDevicePropertyHandle.h"
 
#include "InputDeviceLibrary.generated.h"
 
enum class EInputDeviceConnectionState : uint8;
class APlayerController;
 
ENGINE_API DECLARE_LOG_CATEGORY_EXTERN(LogInputDevices, Log, All);
 
UCLASS(MinimalAPI)
class UInputDeviceLibrary : public UBlueprintFunctionLibrary
{
    GENERATED_BODY()
 
public:
 
    UFUNCTION(BlueprintCallable, Category = "Input Devices")
    static ENGINE_API APlayerController* GetPlayerControllerFromPlatformUser(const FPlatformUserId UserId);
 
    UFUNCTION(BlueprintCallable, Category = "Input Devices")
    static ENGINE_API APlayerController* GetPlayerControllerFromInputDevice(const FInputDeviceId DeviceId);
 
    UFUNCTION(BlueprintCallable, BlueprintPure, Category = "Input Devices", meta = (ReturnDisplayName = "Is Valid"))
    static ENGINE_API bool IsDevicePropertyHandleValid(const FInputDevicePropertyHandle& InHandle);
    
    UFUNCTION(BlueprintCallable, Category = "Input Devices", meta=(ReturnDisplayName="Number of Devices"))
    static ENGINE_API int32 GetAllInputDevicesForUser(const FPlatformUserId UserId, TArray<FInputDeviceId>& OutInputDevices);
 
    UFUNCTION(BlueprintCallable, Category = "Input Devices", meta=(ReturnDisplayName="Number of Devices"))
    static ENGINE_API int32 GetAllInputDevices(TArray<FInputDeviceId>& OutInputDevices);
 
    UFUNCTION(BlueprintCallable, Category = "Input Devices", meta=(ReturnDisplayName="Number of Devices"))
    static ENGINE_API int32 GetAllConnectedInputDevices(TArray<FInputDeviceId>& OutInputDevices);
 
    UFUNCTION(BlueprintCallable, Category = "Input Devices", meta=(ReturnDisplayName="Number of Users"))
    static ENGINE_API int32 GetAllActiveUsers(TArray<FPlatformUserId>& OutUsers);
 
    UFUNCTION(BlueprintPure, Category = "Input Devices")
    static ENGINE_API FPlatformUserId GetUserForUnpairedInputDevices();
 
    UFUNCTION(BlueprintPure, Category = "Input Devices")
    static ENGINE_API FPlatformUserId GetPrimaryPlatformUser();
 
    UFUNCTION(BlueprintPure, Category = "Input Devices")
    static ENGINE_API bool IsUnpairedUserId(const FPlatformUserId PlatformId);
 
    UFUNCTION(BlueprintPure, Category = "Input Devices")
    static ENGINE_API bool IsInputDeviceMappedToUnpairedUser(const FInputDeviceId InputDevice);
 
    UFUNCTION(BlueprintPure, Category = "Input Devices")
    static ENGINE_API FInputDeviceId GetDefaultInputDevice();
 
    UFUNCTION(BlueprintCallable, Category = "Input Devices")
    static ENGINE_API FPlatformUserId GetUserForInputDevice(FInputDeviceId DeviceId);
 
    UFUNCTION(BlueprintCallable, Category = "Input Devices")
    static ENGINE_API FInputDeviceId GetPrimaryInputDeviceForUser(FPlatformUserId UserId);
 
    UFUNCTION(BlueprintCallable, Category = "Input Devices")
    static ENGINE_API EInputDeviceConnectionState GetInputDeviceConnectionState(const FInputDeviceId DeviceId);
 
    UFUNCTION(BlueprintPure, Category = "Input Devices", meta=(ReturnDisplayName="Is Valid"))
    static ENGINE_API bool IsValidInputDevice(FInputDeviceId DeviceId);
 
    UFUNCTION(BlueprintPure, Category = "Input Devices", meta=(ReturnDisplayName="Is Valid"))
    static ENGINE_API bool IsValidPlatformId(FPlatformUserId UserId);
 
    UFUNCTION(BlueprintPure, meta = (ScriptConstant = "None", ScriptConstantHost = "/Script/CoreUObject.PlatformUserId"), Category = "Input Devices")
    static ENGINE_API FPlatformUserId PlatformUserId_None();
 
    UFUNCTION(BlueprintPure, meta = (ScriptConstant = "None", ScriptConstantHost = "/Script/CoreUObject.InputDeviceId"), Category = "Input Devices")
    static ENGINE_API FInputDeviceId InputDeviceId_None();
 
    UFUNCTION(BlueprintPure, meta = (DisplayName = "Equal (PlatformUserId)", CompactNodeTitle = "==", ScriptMethod = "Equals", ScriptOperator = "==", Keywords = "== equal"), Category = "Input Devices")
    static ENGINE_API bool EqualEqual_PlatformUserId(FPlatformUserId A, FPlatformUserId B);
 
    UFUNCTION(BlueprintPure, meta = (DisplayName = "Not Equal (PlatformUserId)", CompactNodeTitle = "!=", ScriptMethod = "NotEqual", ScriptOperator = "!=", Keywords = "!= not equal"), Category = "Input Devices")
    static ENGINE_API bool NotEqual_PlatformUserId(FPlatformUserId A, FPlatformUserId B);
    
    UFUNCTION(BlueprintPure, meta = (DisplayName = "Equal (InputDeviceId)", CompactNodeTitle = "==", ScriptMethod = "Equals", ScriptOperator = "==", Keywords = "== equal"), Category = "Input Devices")
    static ENGINE_API bool EqualEqual_InputDeviceId(FInputDeviceId A, FInputDeviceId B);
    
    UFUNCTION(BlueprintPure, meta = (DisplayName = "Not Equal (InputDeviceId)", CompactNodeTitle = "!=", ScriptMethod = "NotEqual", ScriptOperator = "!=", Keywords = "!= not equal"), Category = "Input Devices")
    static ENGINE_API bool NotEqual_InputDeviceId(FInputDeviceId A, FInputDeviceId B);
};