Base class that represents a single Input Device Property. An Input Device Property represents a feature that can be set on an input device. Things like what color a light is, advanced rumble patterns, or trigger haptics. More...

Public Member Functions
InputDevice
void	ResetDeviceProperty (const FPlatformUserId PlatformUser, const FInputDeviceId DeviceId, bool bForceReset)
	Reset the current device property. Provides an opportunity to reset device state after evaluation is complete. If overriding in Blueprints, make sure to call the parent function!
void	EvaluateDeviceProperty (const FPlatformUserId PlatformUser, const FInputDeviceId DeviceId, float32 DeltaTime, float32 Duration)
	Evaluate this device property for a given duration. If overriding in Blueprints, make sure to call the parent function!
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

Static Public Member Functions
Static Functions
static UClass	StaticClass ()
Static Public Member Functions inherited from UObject
static UClass	StaticClass ()

Public Attributes
Info
float32	PropertyDuration
	The duration that this device property should last. Override this if your property has any dynamic curves to be the max time range.
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

Base class that represents a single Input Device Property. An Input Device Property represents a feature that can be set on an input device. Things like what color a light is, advanced rumble patterns, or trigger haptics.

This top level object can then be evaluated at a specific time to create a lower level FInputDeviceProperty, which the IInputInterface implementation can interpret however it desires.

The behavior of device properties can vary depending on the current platform. Some platforms may not support certain device properties. An older gamepad may not have any advanced trigger haptics for example.

Member Function Documentation

◆ EvaluateDeviceProperty()

void EvaluateDeviceProperty	(	const FPlatformUserId	PlatformUser,
		const FInputDeviceId	DeviceId,
		float32	DeltaTime,
		float32	Duration )

Evaluate this device property for a given duration. If overriding in Blueprints, make sure to call the parent function!

Parameters

PlatformUser	The platform user that should receive this device property change
DeltaTime	Delta time
Duration	The number of seconds that this property has been active. Use this to get things like curve data over time.

Returns: A pointer to the evaluated input device property.

◆ ResetDeviceProperty()

void ResetDeviceProperty	(	const FPlatformUserId	PlatformUser,
		const FInputDeviceId	DeviceId,
		bool	bForceReset )

Reset the current device property. Provides an opportunity to reset device state after evaluation is complete. If overriding in Blueprints, make sure to call the parent function!

Parameters

PlatformUser The platform user that should receive this device property change

◆ StaticClass()

UClass StaticClass ( )

static

Member Data Documentation

◆ PropertyDuration

float32 PropertyDuration

The duration that this device property should last. Override this if your property has any dynamic curves to be the max time range.

A duration of 0 means that the device property will be treated as a "One Shot" effect, being applied once before being removed by the Input Device Subsystem.

Public Member Functions

Static Public Member Functions