unreal.InputDeviceSubsystem

class unreal.InputDeviceSubsystem(outer: Object | None = None, name: Name | str = 'None')

Bases: EngineSubsystem

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

C++ Source:

  • Module: Engine

  • File: InputDeviceSubsystem.h

Editor Properties: (see get_editor_property/set_editor_property)

  • on_input_hardware_device_changed (HardwareInputDeviceChanged): [Read-Write] A delegate that is fired when a platform user changes what Hardware Input device they are using

activate_device_property_of_class(property_class, params) → InputDevicePropertyHandle

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

Parameters:
Return type:

InputDevicePropertyHandle

get_active_device_property(handle) → InputDeviceProperty

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

Parameters:

handle (InputDevicePropertyHandle)

Return type:

InputDeviceProperty

get_input_device_hardware_identifier(input_device) → HardwareDeviceIdentifier

Get Input Device Hardware Identifier

Parameters:

input_device (InputDeviceId)

Return type:

HardwareDeviceIdentifier

get_most_recently_used_hardware_device(user_id) → HardwareDeviceIdentifier

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

Parameters:

user_id (PlatformUserId)

Return type:

HardwareDeviceIdentifier

get_most_recently_used_input_device_id(user_id, of_type=HardwareDevicePrimaryType.UNSPECIFIED) → InputDeviceId

Returns the most recently used FInputDeviceId for the given platform user id.

This will be INPUTDEVICEID_NONE if there is no known device for the given user.

Parameters:

  • user_id (PlatformUserId) – The platform user to find the most recent device for

  • of_type (HardwareDevicePrimaryType) – The type of input device to filter by. If unspecified, then the latest device regardless of its type will be returned.

Return type:

InputDeviceId

is_property_active(handle) → bool

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

Parameters:

handle (InputDevicePropertyHandle)

Return type:

bool

property on_input_hardware_device_changed: HardwareInputDeviceChanged

[Read-Write] A delegate that is fired when a platform user changes what Hardware Input device they are using

Type:

(HardwareInputDeviceChanged)

remove_all_device_properties() → None

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

remove_device_property_by_handle(handle_to_remove) → None

Remove a single device property based on it’s handle

Parameters:

handle_to_remove (InputDevicePropertyHandle)

remove_device_property_handles(handles_to_remove) → None

Remove a set of device properties based on their handles.

Parameters:

handles_to_remove (Set[InputDevicePropertyHandle]) – The set of device property handles to remove