unreal.EnhancedActionKeyMapping

class unreal.EnhancedActionKeyMapping(triggers: None = [], modifiers: None = [], action: InputAction = Ellipsis, key: Key = [])

Bases: 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 to be affected by the key

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

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

    Note: Modifiers defined in individual key mappings will be applied before those defined in the Input Action asset. Modifiers will not override any that are defined on the Input Action asset, they will be combined together during evaluation.

  • player_mappable_key_settings (PlayerMappableKeySettings): [Read-Write] Used to expose this mapping or to opt-out of settings completely.

  • setting_behavior (PlayerMappableKeySettingBehaviors): [Read-Write] Defines which Player Mappable Key Setting to use for a Action Key Mapping.

  • triggers (Array[InputTrigger]): [Read-Write] 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: InputAction

[Read-Write] Action to be affected by the key

Type:

(InputAction)

property key: Key

[Read-Write] Key that affect the action.

Type:

(Key)

property modifiers: None

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

Note: Modifiers defined in individual key mappings will be applied before those defined in the Input Action asset. Modifiers will not override any that are defined on the Input Action asset, they will be combined together during evaluation.

Type:

(Array[InputModifier])

property triggers: None

[Read-Write] 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])