unreal.PlayerMappableKeyQueryOptions
¶
- class unreal.PlayerMappableKeyQueryOptions(mapping_name: Name = 'None', key_to_match: Key = [], slot_to_match: PlayerMappableKeySlot = Ellipsis, match_basic_key_types: bool = False, match_key_axis_type: bool = False, required_device_type: HardwareDevicePrimaryType = Ellipsis, required_device_flags: int = 0)¶
Bases:
StructBase
Options when querying what keys are mapped to a specific action on the player mappable key profile.
C++ Source:
Plugin: EnhancedInput
Module: EnhancedInput
File: EnhancedInputUserSettings.h
Editor Properties: (see get_editor_property/set_editor_property)
key_to_match
(Key): [Read-Write] If specified, then this key will be used to match against when checking if the key types and axis are the same.mapping_name
(Name): [Read-Write] The mapping name to search formatch_basic_key_types
(bool): [Read-Write] If true, then only keys that have the same value for IsGamepadKey, IsTouch, and IsGesture will be included in the results of this querymatch_key_axis_type
(bool): [Read-Write] If true, then only keys that have the same value of IsAxis1D, IsAxis2D, and IsAxis3D will be included in the results of this queryrequired_device_flags
(int32): [Read-Write] If set, then only player mappings whose Hardware Device Identifier that has the same flags as this will be included in the resultsrequired_device_type
(HardwareDevicePrimaryType): [Read-Write] If set, then only player mappings whose hardware device identifier that has the same primary input device type will be included in the results of this queryslot_to_match
(PlayerMappableKeySlot): [Read-Write] The key slot that will be required to match if set. By default this is EPlayerMappableKeySlot::Unspecified, which will not filter by the slot at all.
- property key_to_match: Key¶
[Read-Write] If specified, then this key will be used to match against when checking if the key types and axis are the same.
- Type:
(Key)
- property match_basic_key_types: bool¶
[Read-Write] If true, then only keys that have the same value for IsGamepadKey, IsTouch, and IsGesture will be included in the results of this query
- Type:
(bool)
- property match_key_axis_type: bool¶
[Read-Write] If true, then only keys that have the same value of IsAxis1D, IsAxis2D, and IsAxis3D will be included in the results of this query
- Type:
(bool)
- property required_device_flags: int¶
[Read-Write] If set, then only player mappings whose Hardware Device Identifier that has the same flags as this will be included in the results
- Type:
(int32)
- property required_device_type: HardwareDevicePrimaryType¶
[Read-Write] If set, then only player mappings whose hardware device identifier that has the same primary input device type will be included in the results of this query
- Type:
- property slot_to_match: PlayerMappableKeySlot¶
[Read-Write] The key slot that will be required to match if set. By default this is EPlayerMappableKeySlot::Unspecified, which will not filter by the slot at all.
- Type: