1. Epic GamesDeveloper
  3. UInputDeviceLibrary

UInputDeviceLibrary

A static BP library that exposes Input Device data to blueprints

API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/GameFramework

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Classes/GameFramework/InputDeviceLibrary.h
Include #include "GameFramework/InputDeviceLibrary.h"

Syntax

UCLASS (MinimalAPI)  
class UInputDeviceLibrary : public UBlueprintFunctionLibrary

Remarks

A static BP library that exposes Input Device data to blueprints

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

Functions

  Type Name Description
Public function Static UFunction BlueprintPure, Category, Meta bool Returns true if InputDeviceId A is equal to InputDeviceId B (A == B)
Public function Static UFunction BlueprintPure, Category, Meta bool Returns true if PlatformUserId A is equal to PlatformUserId B (A == B)
Public function Static UFunction BlueprintCallable, Category int32 Get all currently active platform ids, anyone who has a mapped input device
Public function Static UFunction BlueprintCallable, Category int32 Gather all currently connected input devices
Public function Static UFunction BlueprintCallable, Category int32

GetAllInputDevices ( TArray< FInputDeviceId >& OutInputDevices
)

 Get all mapped input devices on this platform regardless of their connection state.
Public function Static UFunction BlueprintCallable, Category int32

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

 Populates the OutInputDevices array with any InputDeviceID's that are mapped to the given platform user
Public function Static UFunction BlueprintPure, Category FInputDeviceId Returns the default device id used for things like keyboard/mouse input
Public function Static UFunction BlueprintCallable, Category EInputDeviceConnectionState Gets the connection state of the given input device.
Public function Static UFunction BlueprintCallable, Category APlayerController * Get the player controller who owns the given input device id
Public function Static UFunction BlueprintCallable, Category APlayerController * Get the player controller who has the given Platform User ID.
Public function Static UFunction BlueprintCallable, Category FInputDeviceId Returns the primary input device used by a specific player, or INPUTDEVICEID_NONE if invalid
Public function Static UFunction BlueprintPure, Category FPlatformUserId Returns the 'Primary' Platform user for this platform.
Public function Static UFunction BlueprintCallable, Category FPlatformUserId Returns the platform user attached to this input device, or PLATFORMUSERID_NONE if invalid
Public function Static UFunction BlueprintPure, Category FPlatformUserId Returns the platform user id that is being used for unmapped input devices.
Public function Static UFunction BlueprintPure, Category, Meta FInputDeviceId Static invalid input device
Public function Static UFunction BlueprintCallable, BlueprintPure, Category, Meta bool Returns true if the given handle is valid
Public function Static UFunction BlueprintPure, Category bool Returns true if the given input device is mapped to the unpaired platform user id.
Public function Static UFunction BlueprintPure, Category bool

IsUnpairedUserId ( const FPlatformUserId PlatformId
)

 Returns true if the given Platform User Id is the user for unpaired input devices on this platform.
Public function Static UFunction BlueprintPure, Category bool Check if the given input device is valid
Public function Static UFunction BlueprintPure, Category bool Check if the given platform ID is valid
Public function Static UFunction BlueprintPure, Category, Meta bool Returns true if InputDeviceId A is not equal to InputDeviceId B (A != B)
Public function Static UFunction BlueprintPure, Category, Meta bool Returns true if PlatformUserId A is not equal to PlatformUserId B (A != B)
Public function Static UFunction BlueprintPure, Category, Meta FPlatformUserId Static invalid platform user

See Also

IPlatformInputDeviceMapper

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page