UInputDeviceSubsystem Class Reference

The input device subsystem provides an interface to allow users to set Input Device Properties on any Platform User. More...

Static Public Member Functions
Static Functions
static UInputDeviceSubsystem	Get ()
static UClass	StaticClass ()
Static Public Member Functions inherited from UEngineSubsystem
static UClass	StaticClass ()
Static Public Member Functions inherited from UDynamicSubsystem
static UClass	StaticClass ()
Static Public Member Functions inherited from USubsystem
static UClass	StaticClass ()
Static Public Member Functions inherited from UObject
static UClass	StaticClass ()

Input Devices
FHardwareInputDeviceChanged	OnInputHardwareDeviceChanged
	A delegate that is fired when a platform user changes what Hardware Input device they are using.
void	RemoveAllDeviceProperties ()
	Removes all the current Input Device Properties that are active, regardless of the Platform User.
UInputDeviceProperty	GetActiveDeviceProperty (const FInputDevicePropertyHandle Handle) const
	Returns a pointer to the active input device property with the given handle. Returns null if the property doesn't exist.
FHardwareDeviceIdentifier	GetInputDeviceHardwareIdentifier (const FInputDeviceId InputDevice) const
FHardwareDeviceIdentifier	GetMostRecentlyUsedHardwareDevice (const FPlatformUserId InUserId) const
	Gets the most recently used hardware input device for the given platform user.
bool	IsPropertyActive (const FInputDevicePropertyHandle Handle) const
	Returns true if the property associated with the given handle is currently active, and it is not pending removal.
FInputDevicePropertyHandle	ActivateDevicePropertyOfClass (TSubclassOf< UInputDeviceProperty > PropertyClass, FActivateDevicePropertyParams Params)
	Spawn a new instance of the given device property class and activate it.
void	RemoveDevicePropertyByHandle (const FInputDevicePropertyHandle HandleToRemove)
	Remove a single device property based on it's handle.
void	RemoveDevicePropertyHandles (TSet< FInputDevicePropertyHandle > HandlesToRemove)
	Remove a set of device properties based on their handles.

Additional Inherited Members
Public Member Functions inherited from UObject
bool	MarkPackageDirty () const
void	RemoveFromRoot ()
bool	GetIsRooted () const
bool	IsTransient () const
bool	Modify (bool bAlwaysMarkDirty=true)
void	SetTransactional (bool bTransactional)
bool	IsSupportedForNetworking () const
UClass	GetClass () const
UObject	GetOuter () const
UObject	GetTypedOuter (TSubclassOf< UObject > Target) const
	Traverses the outer chain searching for the next object of a certain type.
UPackage	GetOutermost () const
UPackage	GetPackage () const
void	AddToRoot ()
UWorld	GetWorld () const
FName	GetName () const
FString	GetFullName (const UObject StopOuter=nullptr) const
FString	GetPathName (const UObject StopOuter=nullptr) const
bool	IsA (const UClass Class) const
	Returns true if this object is of the specified type, or a child of that type.
void	SaveConfig ()
void	LoadConfig ()
void	ReloadConfig ()
void	CopyScriptPropertiesFrom (const UObject OtherObject)
void	opCast (?&Address) const
FString	ToString () const
Public Attributes inherited from UObject
const UClass	Class
const UObject	Outer
const UPackage	Outermost
const UPackage	Package
const UWorld	World
const FName	Name
const bool	IsRooted

Detailed Description

The input device subsystem provides an interface to allow users to set Input Device Properties on any Platform User.

Member Function Documentation

ActivateDevicePropertyOfClass()

FInputDevicePropertyHandle ActivateDevicePropertyOfClass	(	TSubclassOf< UInputDeviceProperty >	PropertyClass,
		FActivateDevicePropertyParams	Params )

Spawn a new instance of the given device property class and activate it.

Get()

UInputDeviceSubsystem Get ( )

static

GetActiveDeviceProperty()

UInputDeviceProperty GetActiveDeviceProperty

(

const FInputDevicePropertyHandle

Handle

)

const

Returns a pointer to the active input device property with the given handle. Returns null if the property doesn't exist.

GetInputDeviceHardwareIdentifier()

FHardwareDeviceIdentifier GetInputDeviceHardwareIdentifier

(

const FInputDeviceId

InputDevice

)

const

GetMostRecentlyUsedHardwareDevice()

FHardwareDeviceIdentifier GetMostRecentlyUsedHardwareDevice

(

const FPlatformUserId

InUserId

)

const

Gets the most recently used hardware input device for the given platform user.

IsPropertyActive()

bool IsPropertyActive

(

const FInputDevicePropertyHandle

Handle

)

const

Returns true if the property associated with the given handle is currently active, and it is not pending removal.

RemoveAllDeviceProperties()

void RemoveAllDeviceProperties

(

)

Removes all the current Input Device Properties that are active, regardless of the Platform User.

RemoveDevicePropertyByHandle()

void RemoveDevicePropertyByHandle

(

const FInputDevicePropertyHandle

HandleToRemove

)

Remove a single device property based on it's handle.

Returns

The number of removed device properties.

RemoveDevicePropertyHandles()

void RemoveDevicePropertyHandles

(

TSet< FInputDevicePropertyHandle >

HandlesToRemove

)

Remove a set of device properties based on their handles.

Parameters

HandlesToRemove

The set of device property handles to remove

Returns

The number of removed device properties

StaticClass()

UClass StaticClass ( )

static

Member Data Documentation

OnInputHardwareDeviceChanged

FHardwareInputDeviceChanged OnInputHardwareDeviceChanged

A delegate that is fired when a platform user changes what Hardware Input device they are using.