Skip to main content
Version: 2.x

Key Visualization

Display input keys with platform-specific icons and custom names.

Project Settings​

Configure Project Settings → Plugins → Auto Settings Input:

Key Icon Sources​

Key Icon Sources provide the visual icons for input keys. Set the Key Icon Source property in Project Settings → Plugins → Auto Settings Input → Display.

Built-in:

  • CommonKeyIconSource - Uses CommonUI's icon system with automatic platform detection (requires CommonUI plugin)

Custom Icon Sources: Create custom icon sources in Blueprint by inheriting from KeyIconSource and implementing BP_GetIconBrushForKey to return the appropriate icon for each key based on platform and input device.

Key Friendly Names​

Override default key display names to use shorter or more readable names:

Left Mouse Button → "LMB"
Right Mouse Button → "RMB"
Gamepad_FaceButton_Bottom → "A"
LeftShift → "Shift"

Rich Text Integration​

Display keys inline with text using the Rich Text Block with RichTextBlockInputDecorator:

  1. Add a Rich Text Block to your widget
  2. Add RichTextBlockInputDecorator to the decorator classes
  3. Use <input> tags in your text:
Press <input action="Jump"/> to jump
Hold <input action="Aim"/> to aim
Use <input key="Space"/> to continue

The decorator automatically replaces the tags with key icons or names based on the current bindings and input device.

Key Label Widget​

The KeyLabel widget displays a key with automatic icon/text fallback:

  1. Add KeyLabel widget to your UI
  2. Set the Key property to the key you want to display
  3. The widget automatically shows the icon if available, otherwise shows the key name as text