1. Epic GamesDeveloper
  3. UInputDeviceProperty

UInputDeviceProperty

Base class that represents a single Input Device Property.

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

Inheritance Hierarchy

References

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

Syntax

UCLASS (Abstract, Blueprintable, BlueprintType, EditInlineNew, CollapseCategories,  
       Meta=(ShowWorldContextPin), MinimalAPI)  
class UInputDeviceProperty : public UObject

Remarks

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.

Variables

  Type Name Description
Protected variable UProperty Category BlueprintReadWrite visibleanywhere float PropertyDuration The duration that this device property should last.

Constructors

  Type Name Description
Public function  

UInputDeviceProperty ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Protected function Virtual UFunction Category void

ApplyDeviceProperty ( const FPlatformUserId UserId,
const FInputDeviceId DeviceId
)

 Apply the device property from GetInternalDeviceProperty to the given platform user.
Protected function Static void

ApplyDeviceProperty_Internal ( const FPlatformUserId UserId,
const FInputDeviceId DeviceId,
FInputDeviceProperty* RawProperty
)

 Apply the given device property
Protected function UFunction Category blueprintnativeevent void

EvaluateDeviceProperty ( const FPlatformUserId PlatformUser,
const FInputDeviceId DeviceId,
const float DeltaTime,
const float Duration
)

 Evaluate this device property for a given duration.
Protected function Virtual void

EvaluateDeviceProperty_Implementation ( const FPlatformUserId PlatformUser,
const FInputDeviceId DeviceId,
const float DeltaTime,
const float Duration
)

 Native C++ implementation of EvaluateDeviceProperty.
Protected function Const const TDataLayout *

GetDeviceSpecificData ( const FPlatformUserId UserId,
const FInputDeviceId DeviceId,
const TMap< FName, TDataLayout >& InMap
)

 Returns the device specific data for the given platform user.
Protected function TDataLayout *

GetDeviceSpecificDataMutable ( const FPlatformUserId UserId,
const FInputDeviceId DeviceId,
TMap< FName, TDataLayout >& InMap
)

  
Public function Const float The duration that this device property should last.
Protected function Virtual FInputDeviceProperty * Gets a pointer to the current input device property that the IInputInterface can use.
Public function Virtual float Recalculates this device property's duration.
Protected function UFunction Category blueprintnativeevent void

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

 Reset the current device property.
Protected function Virtual void

ResetDeviceProperty_Implementation ( const FPlatformUserId PlatformUser,
const FInputDeviceId DeviceId,
bool bForceReset
)

 Native C++ implementation of ResetDeviceProperty Override this in C++ to alter the device property behavior in native code.

Overridden from UObject

  Type Name Description
Public function Virtual void Post edit change property to update the duration if there are any dynamic options like for curves.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page