1. Epic GamesDeveloper
  3. UInputDeviceLibrary

UInputDeviceLibrary

A static BP library that exposes Input Device data to blueprints

API > API/Runtime > API/Runtime/Engine

A static BP library that exposes Input Device data to blueprints

Keep any function comments up to date with those in GenericPlatformInputDeviceMapper.h!

   
Name UInputDeviceLibrary
Type class
Header File /Engine/Source/Runtime/Engine/Classes/GameFramework/InputDeviceLibrary.h
Include Path #include "GameFramework/InputDeviceLibrary.h"

Syntax

UCLASS (MinimalAPI)  
class UInputDeviceLibrary : public UBlueprintFunctionLibrary

Inheritance Hierarchy

Functions

Static

Name Remarks Include Path Unreal Specifiers

static bool EqualEqual_InputDeviceId ( FInputDeviceId A,
FInputDeviceId B
)

 Returns true if InputDeviceId A is equal to InputDeviceId B (A == B) GameFramework/InputDeviceLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Equal (InputDeviceId)", CompactNodeTitle="==", ScriptMethod="Equals", ScriptOperator="==", Keywords="== equal")
  • Category="Input Devices"

static bool EqualEqual_PlatformUserId ( FPlatformUserId A,
FPlatformUserId B
)

 Returns true if PlatformUserId A is equal to PlatformUserId B (A == B) GameFramework/InputDeviceLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Equal (PlatformUserId)", CompactNodeTitle="==", ScriptMethod="Equals", ScriptOperator="==", Keywords="== equal")
  • Category="Input Devices"

static int32 GetAllActiveUsers ( TArray< FPlatformUserId >& OutUsers
)

 Get all currently active platform ids, anyone who has a mapped input device GameFramework/InputDeviceLibrary.h
  • BlueprintCallable
  • Category="Input Devices"
  • Meta=(ReturnDisplayName="Number of Users")

static int32 GetAllConnectedInputDevices ( TArray< FInputDeviceId >& OutInputDevices
)

 Gather all currently connected input devices GameFramework/InputDeviceLibrary.h
  • BlueprintCallable
  • Category="Input Devices"
  • Meta=(ReturnDisplayName="Number of Devices")

static int32 GetAllInputDevices ( TArray< FInputDeviceId >& OutInputDevices
)

 Get all mapped input devices on this platform regardless of their connection state. GameFramework/InputDeviceLibrary.h
  • BlueprintCallable
  • Category="Input Devices"
  • Meta=(ReturnDisplayName="Number of Devices")

static int32 GetAllInputDevicesForUser ( const FPlatformUserId UserId,
TArray< FInputDeviceId >& OutInputDevices
)

 Populates the OutInputDevices array with any InputDeviceID's that are mapped to the given platform user GameFramework/InputDeviceLibrary.h
  • BlueprintCallable
  • Category="Input Devices"
  • Meta=(ReturnDisplayName="Number of Devices")

static FInputDeviceId GetDefaultInputDevice()

 Returns the default device id used for things like keyboard/mouse input GameFramework/InputDeviceLibrary.h
  • BlueprintPure
  • Category="Input Devices"

static EInputDeviceConnectionState GetInputDeviceConnectionState ( const FInputDeviceId DeviceId
)

 Gets the connection state of the given input device. GameFramework/InputDeviceLibrary.h
  • BlueprintCallable
  • Category="Input Devices"

static APlayerController * GetPlayerControllerFromInputDevice ( const FInputDeviceId DeviceId
)

 Get the player controller who owns the given input device id GameFramework/InputDeviceLibrary.h
  • BlueprintCallable
  • Category="Input Devices"

static APlayerController * GetPlayerControllerFromPlatformUser ( const FPlatformUserId UserId
)

 Get the player controller who has the given Platform User ID. GameFramework/InputDeviceLibrary.h
  • BlueprintCallable
  • Category="Input Devices"

static FInputDeviceId GetPrimaryInputDeviceForUser ( FPlatformUserId UserId
)

 Returns the primary input device used by a specific player, or INPUTDEVICEID_NONE if invalid GameFramework/InputDeviceLibrary.h
  • BlueprintCallable
  • Category="Input Devices"
Returns the 'Primary' Platform user for this platform. GameFramework/InputDeviceLibrary.h
  • BlueprintPure
  • Category="Input Devices"

static FPlatformUserId GetUserForInputDevice ( FInputDeviceId DeviceId
)

 Returns the platform user attached to this input device, or PLATFORMUSERID_NONE if invalid GameFramework/InputDeviceLibrary.h
  • BlueprintCallable
  • Category="Input Devices"
Returns the platform user id that is being used for unmapped input devices. GameFramework/InputDeviceLibrary.h
  • BlueprintPure
  • Category="Input Devices"

static FInputDeviceId InputDeviceId_None()

 Static invalid input device GameFramework/InputDeviceLibrary.h
  • BlueprintPure
  • Meta=(ScriptConstant="None", ScriptConstantHost="/Script/CoreUObject.InputDeviceId")
  • Category="Input Devices"

static bool IsDevicePropertyHandleValid ( const FInputDevicePropertyHandle& InHandle
)

 Returns true if the given handle is valid GameFramework/InputDeviceLibrary.h
  • BlueprintCallable
  • BlueprintPure
  • Category="Input Devices"
  • Meta=(ReturnDisplayName="Is Valid")

static bool IsInputDeviceMappedToUnpairedUser ( const FInputDeviceId InputDevice
)

 Returns true if the given input device is mapped to the unpaired platform user id. GameFramework/InputDeviceLibrary.h
  • BlueprintPure
  • Category="Input Devices"

static bool IsUnpairedUserId ( const FPlatformUserId PlatformId
)

 Returns true if the given Platform User Id is the user for unpaired input devices on this platform. GameFramework/InputDeviceLibrary.h
  • BlueprintPure
  • Category="Input Devices"

static bool IsValidInputDevice ( FInputDeviceId DeviceId
)

 Check if the given input device is valid GameFramework/InputDeviceLibrary.h
  • BlueprintPure
  • Category="Input Devices"
  • Meta=(ReturnDisplayName="Is Valid")

static bool IsValidPlatformId ( FPlatformUserId UserId
)

 Check if the given platform ID is valid GameFramework/InputDeviceLibrary.h
  • BlueprintPure
  • Category="Input Devices"
  • Meta=(ReturnDisplayName="Is Valid")

static bool NotEqual_InputDeviceId ( FInputDeviceId A,
FInputDeviceId B
)

 Returns true if InputDeviceId A is not equal to InputDeviceId B (A != B) GameFramework/InputDeviceLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Not Equal (InputDeviceId)", CompactNodeTitle="!=", ScriptMethod="NotEqual", ScriptOperator="!=", Keywords="!= not equal")
  • Category="Input Devices"

static bool NotEqual_PlatformUserId ( FPlatformUserId A,
FPlatformUserId B
)

 Returns true if PlatformUserId A is not equal to PlatformUserId B (A != B) GameFramework/InputDeviceLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Not Equal (PlatformUserId)", CompactNodeTitle="!=", ScriptMethod="NotEqual", ScriptOperator="!=", Keywords="!= not equal")
  • Category="Input Devices"

static FPlatformUserId PlatformUserId_None()

 Static invalid platform user GameFramework/InputDeviceLibrary.h
  • BlueprintPure
  • Meta=(ScriptConstant="None", ScriptConstantHost="/Script/CoreUObject.PlatformUserId")
  • Category="Input Devices"

See Also

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page