unreal.PlayerMappableKeyOptions

class unreal.PlayerMappableKeyOptions(metadata: Object = Ellipsis, name: Name = 'None', display_name: Text = '', display_category: Text = '')

Bases: StructBase

A struct that represents player facing mapping options for an action key mapping. Use this to set a unique FName for the mapping option to save it, as well as some FText options for use in UI.

C++ Source:

  • Plugin: EnhancedInput

  • Module: EnhancedInput

  • File: EnhancedActionKeyMapping.h

Editor Properties: (see get_editor_property/set_editor_property)

  • display_category (Text): [Read-Write] The category that this player mapping is in

  • display_name (Text): [Read-Write] The localized display name of this key mapping. Use this when displaying the mappings to a user.

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

  • name (Name): [Read-Write] A unique name for this player mapping to be saved with.

property display_category: Text

[Read-Write] The category that this player mapping is in

Type:

(Text)

property display_name: Text

[Read-Write] The localized display name of this key mapping. Use this when displaying the mappings to a user.

Type:

(Text)

property metadata: Object

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

Type:

(Object)

property name: Name

[Read-Write] A unique name for this player mapping to be saved with.

Type:

(Name)