Input Prompt Icons: different naming convention for stick (Left Stick vs Stick L, Right Stick vs Stick R)

[hsandt]

Setup

I have Added Input Prompt Icons with Kenny's icon pack.

I'm currently working on an input hint system, following a Metroidvania tutorial around this place https://youtu.be/bdcuQ85uREg?list=PLfcCiyd_V9GFL_xF8ID9vIt5bs0NJI4EK&t=2961 but instead of making a custom system I thought it nice to reuse Maaack's Input menu existing Input Icon Mapper.

So I'm using:

@export var input_icon_mapper : InputIconMapper

func _on_input_hint_changed(action_name: String) -> void:
    input_icon_mapper.get_icon(input_event)

Problem

However, I got a specific text "Xbox Left Stick Up"

which is not present in the list of matching_icons:

(highlighted part where "Xbox Left Stick Up" should be, in alphabetical order)

so I had to fall back to readable text display with InputEventHelper.get_text(input_event):

However, going to further pages of the matching_icons variable debug, I found out it was actually named "Xbox Stick L Up":

Which is indeed the capitalized form of the name in Kenney's asset pack:

Looking at the Input Icon Mapping doc, this has already been taken into account since the manual instructions, which correspond to what's done by the wizard, say:

Set replace_strings with the key pairs:
...
"Stick L": "Left Stick"
"Stick R": "Right Stick"

and I confirm I see them in my inspector:

but it doesn't work anyway.

Workaround

Looking at InputEventHelper.get_device_specific_text > get_text I see it uses these constants:

const JOYSTICK_LEFT_NAME = "Left Stick"
const JOYSTICK_RIGHT_NAME = "Right Stick"

which I had to replace with

const JOYSTICK_LEFT_NAME = "Stick L"
const JOYSTICK_RIGHT_NAME = "Stick R"

and then it worked

[Maaack]

I'm a little confused here by what wasn't working originally. Was the icon not showing up just for the Left Stick Up? Left Stick Left, Right, and Down are chosen with the same logic, so I would have expected those to not be working either.

However, after inspecting I found the auto installer stopped working as of 4.6 because of the changed format of scene files (adding even more unique ids, yay /s). I'm pushing a fix for that in this branch:

#460

It sounds like you went through the manual process. Let me know if that ends up resolving anything on your end.

[Maaack]

I can also confirm that Xbox Left Stick input icons work on the base template. Doesn't appear to need changing.

Changing to:

const JOYSTICK_LEFT_NAME = "Stick L"
const JOYSTICK_RIGHT_NAME = "Stick R"

breaks icon mapping, as seen below.