Skip to content

InputActionLabel

Not yet Class Other

A GuiObject that automatically displays the keybinding for an action as text or an image.

Not implemented yet

This class exists in the current Roblox API but is not implemented in Nova yet. Scripts that reference it will fail at runtime.

0 Nova members · 18 modern Roblox members not implemented yet

Description

InputActionLabel is a drag-and-drop GuiObject that automatically shows the appropriate key or icon for an InputAction based on the player's current input device (keyboard/mouse, gamepad, touch, VR). When the player switches devices or the binding is rebound, the label updates instantly without scripting.

Rendering of the InputActionLabel depends on the InputAction (linked through InputActionLabel.InputAction) and that action's child InputBindings. As the label resolves what to show, it follows this order:

  1. Custom Images — If child InputBindings have their DisplayImage property set, the label renders those images directly, optionally modified by ImageColor3 and ImageTransparency.

  2. Platform Key Images — Lacking custom images, the label renders platform-provided images for child InputBindings through UserInputService.GetImageForKeyCode(), if such images are available. Composite bindings with modifiers show multiple icons with + separators.

  3. Custom Names — Lacking available images, if child InputBindings have their DisplayName property set, the label renders that text in a style defined by FontFace, TextColor3, TextSize, TextTransparency, TextWrapped, TextXAlignment, and TextYAlignment.

  4. Platform Key Strings — Lacking all of the above, the label renders platform-provided strings through UserInputService.GetStringForKeyCode().

  5. If no InputAction is assigned or no child InputBinding exists, the label renders a placeholder icon.

Inheritance

Object → Instance → GuiBase → GuiBase2d → GuiObject → InputActionLabel

Properties

Member Signature Summary
FontFace FontFace: Font Determines the font used to render text.
ImageColor3 ImageColor3: Color3 Determines how rendered label images will be colorized.
ImageTransparency ImageTransparency: float Determines the transparency of rendered label images.
InputAction InputAction: InputAction The InputAction whose preferred binding this label displays.
ResolvedImageContent ResolvedImageContent: Content Read-only. The resolved image content currently being displayed.
ResolvedText ResolvedText: string The resolved key name string currently being displayed.
TextColor3 TextColor3: Color3 Determines the color of rendered text.
TextSize TextSize: float Determines the line height of text in offsets.
TextTransparency TextTransparency: float Determines the transparency of rendered text.
TextWrapped TextWrapped: bool Determines if text wraps to multiple lines within the label's space.
TextXAlignment TextXAlignment: TextXAlignment Determines the horizontal alignment of rendered text.
TextYAlignment TextYAlignment: TextYAlignment Determines the vertical alignment of rendered text.

Roblox reference: InputActionLabel

Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.