Keybindings Setup¶

To get started with the keybindings setup, you first need to configure which Input Mapping Contexts will be considered by the system and how grouping/conflicts should be handled.

To do so, open your Global Config Data Asset, you will then find the following relevant settings under the Options Menu section:

• Keybinding Mapping Contexts This variables defines the list of all the Input Mapping Contexts that will contain any rebindable inputs and you would like to be used in the Key Rebinding system. The text associated with each will be used as category name if grouping by Mapping Context

• Keybinding Mappings Grouping Type This variables defines how the keybindings are groupped when beind displayed inside the menu

  • Group by Mapping Context Will group all the keybinds under a category defined by the input mapping context
  • Group by Input Category Will group all the keybinds by each key's own Display Category, regardless of the mapping context

• Keybinding Mappings Conflict Method This variables defines how the keybindings conflicts should be handled by the system

  • Conflicts by Input Mapping Context Only keys within the same input mapping context will conflict (regardless of display categories)
  • Conflicts by Category Only keys within the same display categories will conflict (regardless of Input Mapping Context) - Note that based on your input setup, this could create unwanted behaviors withing IMCs, consider using "Conflicts All" if suitable
  • Conflicts All All keys will be considered for conflicts (regardless of category or IMC), meaning no conflict will be allowed at all across all available keymappings

  ---

Once this is configured, open the Input Mapping Context(s) that you would like to be set up for rebinding

Then, for each key that you would like to appear in the keybindings setting (even if locked to the player), configure them with the following parameters described below

• Setting Behavior Should be set to Override Settings if the key needs to be visible in the settings, Ignore Settings if it should be fully hidden
• Player Mappable Key Settings Simply select Player Mappable Key Settings in the dropdown for this variable

• Name Must be a fully unique name to describe the key. This name itself no real importance but it must be unique

  Keybind Modifiers

  The system supports multiple "modifiers" that can be added to any given key to change its behavior. To add a modifier simply add _ModifierName to the end of your unique Name, the following modifiers are available:

  • _Secondary Any key with this modifier will be shown in a secondary slot (only supported for mouse/keyboard keys), it can be shown alongside a primary keybind in the same mapping
  • _Locked Any key with this modifier will be displayed in the UI, but it won't be manually rebindable by the player
  • _AllowConflicts Any key with this modifier will ignore all conflicts, this means any other keybinds is allowed to have the same key as this one
  • _Hold Any key with this modifier will be shown as an "Hold" key, this doesn't modify the way the key rebinding works, only the visual of the key changes

  You can combine any modifiers, for example: MoveForward_Hold_Locked or MoveForward_AllowConflicts_Secondary etc.

• Display Name The name you wish to display in the UI, you can reuse the same text as other keys for this one, up to 3 keys can share a single Display Name (2 Mouse/Keyboard keys and 1 Gamepad Key), in which case they will be shown together in a single keybindings setting

• Display Category If choosing to sort by key category inside the Global Config, this will be the category under which the key will be displayed
• You can then ignore any settings that I did not mention