unreal.EnhancedInputLibrary

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

Bases: BlueprintFunctionLibrary

Enhanced Input Library

C++ Source:

  • Plugin: EnhancedInput

  • Module: EnhancedInput

  • File: EnhancedInputLibrary.h

classmethod conv_input_action_value_to_string(action_value) str

Converts a FInputActionValue to a string

Parameters:

action_value (InputActionValue) –

Return type:

str

classmethod get_first_player_mappable_key_slot() PlayerMappableKeySlotData

Get First Player Mappable Key Slot deprecated: FPlayerMappableKeyOptions has been deprecated. Please use UPlayerMappableKeySettings instead.

Return type:

PlayerMappableKeySlotData

classmethod get_fourth_player_mappable_key_slot() PlayerMappableKeySlotData

Get Fourth Player Mappable Key Slot deprecated: FPlayerMappableKeyOptions has been deprecated. Please use UPlayerMappableKeySettings instead.

Return type:

PlayerMappableKeySlotData

classmethod get_mapping_name(action_key_mapping) Name

Returns the name of the mapping based on setting behavior used. If no name is found in the Mappable Key Settings it will return the name set in Player Mappable Options if bIsPlayerMappable is true.

Parameters:

action_key_mapping (EnhancedActionKeyMapping) –

Return type:

Name

classmethod get_player_mappable_key_settings(action_key_mapping) PlayerMappableKeySettings

Returns the Player Mappable Key Settings owned by the Action Key Mapping or by the referenced Input Action, or nothing based of the Setting Behavior.

Parameters:

action_key_mapping (EnhancedActionKeyMapping) –

Return type:

PlayerMappableKeySettings

classmethod get_second_player_mappable_key_slot() PlayerMappableKeySlotData

Get Second Player Mappable Key Slot deprecated: FPlayerMappableKeyOptions has been deprecated. Please use UPlayerMappableKeySettings instead.

Return type:

PlayerMappableKeySlotData

classmethod get_third_player_mappable_key_slot() PlayerMappableKeySlotData

Get Third Player Mappable Key Slot deprecated: FPlayerMappableKeyOptions has been deprecated. Please use UPlayerMappableKeySettings instead.

Return type:

PlayerMappableKeySlotData

classmethod is_action_key_mapping_player_mappable(action_key_mapping) bool

Returns true if this Action Key Mapping either holds a Player Mappable Key Settings or is set bIsPlayerMappable.

Parameters:

action_key_mapping (EnhancedActionKeyMapping) –

Return type:

bool

classmethod request_rebuild_control_mappings_using_context(context, force_immediately=False) None

Flag all enhanced input subsystems making use of the mapping context for reapplication of all control mappings at the end of this frame.

Parameters:
  • context (InputMappingContext) – Mappings will be rebuilt for all subsystems utilizing this context.

  • force_immediately (bool) – The mapping changes will be applied synchronously, rather than at the end of the frame, making them available to the input system on the same frame.