1. Epic GamesDeveloper
  3. UInputDeviceSubsystem

UInputDeviceSubsystem

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

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

Inheritance Hierarchy

References

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

Syntax

UCLASS (BlueprintType, MinimalAPI)  
class UInputDeviceSubsystem :  
    public UEngineSubsystem ,  
    public FTickableGameObject

Remarks

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

Variables

  Type Name Description
Protected variable UProperty Transient TSet< FActiveDeviceProperty > ActiveProperties Set of currently active input device properties that will be evaluated on tick
Protected variable bool bIsPIEPlaying  
Protected variable TSharedPtr< class FInputDeviceSubsystemProcessor > InputPreprocessor An input processor that is used to determine the most recently used hardware device for each user
Protected variable TMap< FInputDeviceId, FHardwareDeviceIdentifier > LatestInputDeviceIdentifiers A map of an input device to it's most recent hardware device identifier
Protected variable TMap< FPlatformUserId, FHardwareDeviceIdentifier > LatestUserDeviceIdentifiers A map of platform user's to their most recent hardware device identifier
Public variable UProperty Category BlueprintAssignable FHardwareInputDeviceChanged OnInputHardwareDeviceChanged A delegate that is fired when a platform user changes what Hardware Input device they are using
Protected variable UProperty Transient TSet< FInputDevicePropertyHandle > PropertiesPendingRemoval Set of property handles the properties that are currently pending manual removal.
Protected variable TArray< FResetPIEData > PropertyClassesRequiringReset A set of device properties that should be reset when PIE ends.

Functions

  Type Name Description
Public function FInputDevicePropertyHandle Starts tracking the given device property as an "Active" property.
Public function UFunction BlueprintCallable, Category, Meta FInputDevicePropertyHandle Spawn a new instance of the given device property class and activate it.
Public function Static UInputDeviceSubsystem *

Get ()

 Returns a pointer to the Input Device Engine Subsystem if it is available.
Public function Const UFunction BlueprintCallable, Category, Meta UInputDeviceProperty * Returns a pointer to the active input device property with the given handle.
Public function Const UFunction BlueprintCallable, Category FHardwareDeviceIdentifier  
Public function Const UFunction BlueprintCallable, Category FHardwareDeviceIdentifier Gets the most recently used hardware input device for the given platform user
Public function Const UFunction BlueprintCallable, Category, Meta bool Returns true if the property associated with the given handle is currently active, and it is not pending removal
Protected function void

OnPIEPaused ( bool bSimulating
)

  
Protected function void

OnPIEResumed ( bool bSimulating
)

  
Protected function void

OnPIEStopped ( bool bSimulating
)

  
Protected function void

OnPrePIEStarted ( bool bSimulating
)

 Callbacks for when PIE is started/stopped.
Public function UFunction BlueprintCallable, Category void Removes all the current Input Device Properties that are active, regardless of the Platform User
Public function UFunction BlueprintCallable, Category void Remove a single device property based on it's handle
Public function UFunction BlueprintCallable, Category void Remove a set of device properties based on their handles.
Protected function void Set the most recently used hardware device from the input processor

Overridden from USubsystem

  Type Name Description
Public function Virtual void Implement this for deinitialization of instances of the system
Public function Virtual void Implement this for initialization of instances of the system
Public function Virtual Const bool Override to control if the Subsystem should be created at all.

Overridden from FTickableGameObject

  Type Name Description
Public function Virtual Const UWorld *  
Public function Virtual Const bool Used to determine whether the object should be ticked in the editor.

Overridden from FTickableObjectBase

  Type Name Description
Public function Virtual Const TStatId Return the stat id to use for this tickable
Public function Virtual Const ETickableTickType Virtual that can be overloaded by the inheriting class.
Public function Virtual Const bool Virtual that can be overloaded by the inheriting class.
Public function Virtual void

Tick ( float DeltaTime
)

 Pure virtual that must be overloaded by the inheriting class.

Classes

  Type Name Description
Protected struct FResetPIEData    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page