unreal.EnhancedActionKeyMapping

class unreal.EnhancedActionKeyMapping(action=None, key=[], is_player_mappable=False, player_mappable_options=['None', '', ''], triggers=[], modifiers=[])

Bases: unreal.StructBase

Defines a mapping between a key activation and the resulting enhanced action An key could be a button press, joystick axis movement, etc. An enhanced action could be MoveForward, Jump, Fire, etc.

C++ Source:

  • Plugin: EnhancedInput

  • Module: EnhancedInput

  • File: EnhancedActionKeyMapping.h

Editor Properties: (see get_editor_property/set_editor_property)

  • action (InputAction): [Read-Write] Action: Action to be affected by the key

  • is_player_mappable (bool): [Read-Write] Is Player Mappable: If true than this ActionKeyMapping will be exposed as a player bindable key

  • key (Key): [Read-Write] Key: Key that affect the action.

  • modifiers (Array(InputModifier)): [Read-Write] Modifiers: Modifiers applied to the raw key value. These are applied sequentially in array order.

  • player_mappable_options (PlayerMappableKeyOptions): [Read-Write] Player Mappable Options: Options for making this a player mappable keymapping

  • triggers (Array(InputTrigger)): [Read-Write] Triggers: Trigger qualifiers. If any trigger qualifiers exist the mapping will not trigger unless: If there are any Explicit triggers in this list at least one of them must be met. All Implicit triggers in this list must be met.

property action

[Read-Only] Action: Action to be affected by the key

Type

(InputAction)

property is_player_mappable

[Read-Only] Is Player Mappable: If true than this ActionKeyMapping will be exposed as a player bindable key

Type

(bool)

property key

[Read-Only] Key: Key that affect the action.

Type

(Key)

property modifiers

[Read-Write] Modifiers: Modifiers applied to the raw key value. These are applied sequentially in array order.

Type

(Array(InputModifier))

property player_mappable_options

[Read-Only] Player Mappable Options: Options for making this a player mappable keymapping

Type

(PlayerMappableKeyOptions)

property triggers

[Read-Write] Triggers: Trigger qualifiers. If any trigger qualifiers exist the mapping will not trigger unless: If there are any Explicit triggers in this list at least one of them must be met. All Implicit triggers in this list must be met.

Type

(Array(InputTrigger))