[title: "NavigationHint Class"] ← Back to index

UI sprite that displays context-sensitive input prompts for gamepad and keyboard.

[heading: "Description"]

NavigationHint displays input prompts that change based on the current screen context. It automatically detects the last input source (touch, keyboard, or gamepad) and shows appropriate button icons.

[heading: "Constructor"] [table header] [ Parameter | Type | Description ] [ frame | number | Initial frame to display (0-7) ] [/table] [heading: "Methods"] [table header] [ Method | Parameters | Description ] [ change | (value) | Changes to a different frame ] [ hide | () | Hides the navigation hint ] [ show | () | Shows the navigation hint ] [/table] [heading: "Properties"] [table header] [ Property | Type | Description ] [ frame | number | Current frame (0-7) ] [/table] [heading: "Frame Reference"] [table header] [ Frame | Screen/Context ] [ 0 | Main Menu / Home ] [ 1 | Results Screen ] [ 2 | Song Select ] [ 3 | Jukebox ] [ 4 | Hair Color Customization ] [ 5 | Character Name Input ] [ 6 | Achievements Menu ] [ 7 | Chart Editor ] [/table] [heading: "Auto-detection"]

The NavigationHint automatically updates based on the last input source:

[list] * Keyboard - Shows keyboard key icons * Gamepad - Shows gamepad button icons * Touch - Shows touch screen icons [/list] [heading: "Example Usage"] [codeblock javascript] // Create navigation hint (usually done in state create) this.navigationHint = new NavigationHint(0); // Change frame for different screens this.navigationHint.change(2); // Song select mode // Hide when not needed this.navigationHint.hide(); [/codeblock] [footer: "© Retora 2026"]