unreal.PlayerKeyMapping

class unreal.PlayerKeyMapping(mapping_name: Name = 'None', display_name: Text = '', display_category: Text = '', slot: PlayerMappableKeySlot = Ellipsis, is_dirty: bool = False, default_key: Key = [], current_key: Key = [], hardware_device_id: HardwareDeviceIdentifier = Ellipsis, associated_input_action: InputAction = Ellipsis)

Bases: StructBase

Represents a single key mapping that is set by the player

C++ Source:

  • Plugin: EnhancedInput

  • Module: EnhancedInput

  • File: EnhancedInputUserSettings.h

Editor Properties: (see get_editor_property/set_editor_property)

  • associated_input_action (InputAction): [Read-Only] The input action associated with this player key mapping

  • current_key (Key): [Read-Only] The key that the player has mapped to

  • default_key (Key): [Read-Only] The default key that this mapping was set to in its input mapping context

  • display_category (Text): [Read-Only] Localized display category of this mapping

  • display_name (Text): [Read-Only] Localized display name of this mapping

  • hardware_device_id (HardwareDeviceIdentifier): [Read-Only] An optional Hardware Device specifier for this mapping

  • is_dirty (bool): [Read-Only] True if this key mapping is dirty (i.e. has been changed by the player)

  • mapping_name (Name): [Read-Only] The name of the mapping for this key

  • slot (PlayerMappableKeySlot): [Read-Only] What slot this key is mapped to

property associated_input_action: InputAction

[Read-Only] The input action associated with this player key mapping

Type:

(InputAction)

property current_key: Key

[Read-Only] The key that the player has mapped to

Type:

(Key)

property default_key: Key

[Read-Only] The default key that this mapping was set to in its input mapping context

Type:

(Key)

property display_category: Text

[Read-Only] Localized display category of this mapping

Type:

(Text)

property display_name: Text

[Read-Only] Localized display name of this mapping

Type:

(Text)

property hardware_device_id: HardwareDeviceIdentifier

[Read-Only] An optional Hardware Device specifier for this mapping

Type:

(HardwareDeviceIdentifier)

property is_dirty: bool

[Read-Only] True if this key mapping is dirty (i.e. has been changed by the player)

Type:

(bool)

property mapping_name: Name

[Read-Only] The name of the mapping for this key

Type:

(Name)

property slot: PlayerMappableKeySlot

[Read-Only] What slot this key is mapped to

Type:

(PlayerMappableKeySlot)