unreal.PlayerMappableInputConfig
¶
- class unreal.PlayerMappableInputConfig(outer: Object | None = None, name: Name | str = 'None')¶
Bases:
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 mappable 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] The display name that can be usedconfig_name
(Name): [Read-Write] The unique name of this config that can be used when saving itcontexts
(Map[InputMappingContext, int32]): [Read-Write] Mapping contexts that make up this Input Config with their associated priority.is_deprecated
(bool): [Read-Write] A flag that can be used to mark this Input Config as deprecated to your player/designers.metadata
(Object): [Read-Write] Metadata that can used to store any other related items to your key mapping such as icons, ability assets, etc.
- property config_name: Name¶
[Read-Only] The unique name of this config that can be used when saving it
- Type:
(Name)
- property contexts: None¶
[Read-Only] Mapping contexts that make up this Input Config with their associated priority.
- Type:
(Map[InputMappingContext, int32])
- get_keys_bound_to_action(action) Array[EnhancedActionKeyMapping] ¶
Returns all the keys mapped to a specific Input Action in this mapping config.
- Parameters:
action (InputAction) –
- Return type:
- 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:
- get_mapping_contexts() Map[InputMappingContext, int32] ¶
Return all the Input Mapping contexts that
- Return type:
Map[InputMappingContext, int32]
- get_player_mappable_keys() Array[EnhancedActionKeyMapping] ¶
Get all the player mappable keys in this config.
- Return type: