unreal.PlayerMappableInputConfig

class unreal.PlayerMappableInputConfig(outer=None, name='None')

Bases: unreal.PrimaryDataAsset

UPlayerMappableInputConfig

This represents one set of Player Mappable controller/keymappings. You can use this input config to create the default mappings for your player to start with in your game. It provides an easy way to get only the player mappable key actions, and it can be used to add multiple UInputMappingContext’s at once to the player.

Populate this data asset with Input Mapping Contexts that have player bindable actions in them.

C++ Source:

  • Plugin: EnhancedInput

  • Module: EnhancedInput

  • File: PlayerMappableInputConfig.h

Editor Properties: (see get_editor_property/set_editor_property)

  • config_display_name (Text): [Read-Write] Config Display Name: The display name that can be used

  • config_name (Name): [Read-Write] Config Name: The unique name of this config that can be used when saving it

  • contexts (Map(InputMappingContext, int32)): [Read-Write] Contexts: Mapping contexts that make up this Input Config with their associated priority.

  • is_deprecated (bool): [Read-Write] Is Deprecated

  • metadata (Object): [Read-Write] Metadata: Metadata that can used to store any other related items to your key mapping such as icons, ability assets, etc.

property config_display_name

[Read-Only] Config Display Name: The display name that can be used

Type

(Text)

property config_name

[Read-Only] Config Name: The unique name of this config that can be used when saving it

Type

(Name)

property contexts

[Read-Only] Contexts: Mapping contexts that make up this Input Config with their associated priority.

Type

(Map(InputMappingContext, int32))

get_config_name() → Name

Get Config Name

Return type

Name

get_display_name() → Text

Get Display Name

Return type

Text

get_keys_bound_to_action(action)

Returns all the keys mapped to a specific Input Action in this mapping config.

Parameters

action (InputAction) –

Return type

Array(EnhancedActionKeyMapping)

get_mapping_by_name(mapping_name) → EnhancedActionKeyMapping

Returns the action key mapping for the mapping that matches the given name

Parameters

mapping_name (Name) –

Return type

EnhancedActionKeyMapping

get_mapping_contexts()

Return all the Input Mapping contexts that

Return type

Map(InputMappingContext, int32)

get_metadata() → Object

Get all the player mappable keys in this config.

Return type

Object

get_player_mappable_keys()

Get all the player mappable keys in this config.

Return type

Array(EnhancedActionKeyMapping)

is_deprecated() → bool

Is Deprecated

Return type

bool

property metadata

[Read-Only] Metadata: Metadata that can used to store any other related items to your key mapping such as icons, ability assets, etc.

Type

(Object)

reset_to_default() → None

Resets this mappable config to use the keys