InputEvent as_text now returns readable string. Added to_string for debug strings

[EricEzaM]

InputEvent changed as_text() to return a display-friendly and human readable string, to be used for UI display. to_string() can be used to get a non-display friendly version which has more information for debugging. Before, some as_text() methods returned a nice readable string, and some displayed more debug-style information.

Based on Calinou comment #38326 (comment)

This is the first commit of a larger series based on #42600.

[akien-mga]

This will likely conflict with #43591 (or the other way around, depending on which is merged first).

On the other hand it can go in the same direction as the proposal on #43591 (comment) to remove these methods:

    int get_joy_axis_index_from_string ( String axis )
    String get_joy_axis_string ( int axis_index )
    int get_joy_button_index_from_string ( String button )
    String get_joy_button_string ( int button_index )

[groud]

Looks good.

[madmiraal]

See below for specifics, but this PR includes a duplication of descriptions for joypad buttons and axes that needs to be addressed.

[EricEzaM]

@madmiraal ah yep in the original pr of #42600 I completely remove the input map editor, as I make it generic (action_map_editor.cpp), so in that pr this issue does not exist. Here it seems I will have to edit the input map editor to use as_text rather than constructing its own strings everywhere.

Seeing input map editor construct the representation of the events on its own is what made me want to do this change in the first place, since the text representation of an event should be consistent across the engine.

[EricEzaM]

@madmiraal @akien-mga Ok, finished the above reviews up. Also added some text to the descriptions as per https://github.com/godotengine/godot/pull/43591/files#r52860139, and also rebased with newest master, which includes #43591

[madmiraal]

I think there is something wrong here. It looks like you're missing the + or - after the axis number and before the description in parentheses and instead are adding "with Value ±1" to the end. Is this intentional? This is what the Input Map Editor currently presents:

[EricEzaM]

Yeah it looks wrong:

What about Joypad Motion on Axis 0, Value -1 (Left Stick Left, Joystick 0 Left), i.e. putting the value before the description. I think I actually meant to do this, as how I currently have it in the image above doesn't make much sense.

[madmiraal]

Perhaps there does need to be a separation between the as_text() for the event and the 20 direction descriptions used by Input Map Editor.

[EricEzaM]

It would be nice if it could be avoided but maybe it can't. To keep the descriptions in one place though, a method to get the axis/button descriptions would need to be introduced (i.e. get_axis_description(int axis))

Is there a particular issue you have with Joypad Motion on Axis 0, Value -1 (Left Stick Left, Joystick 0 Left)? This will also likely come along with a different event editor (shown below) which was a part of #42600 which I have now split up into multiple prs.

[madmiraal]

Is there a particular issue you have with Joypad Motion on Axis 0, Value -1 (Left Stick Left, Joystick 0 Left)?

I just think there is a difference between the event description, which is axis specific and the Input Map description, which is half axis specific:
Event description: Joypad Motion on Axis 0, (Left Stick X-Axis, Joystick 0 X-Axis) with Value -0.3
Input Map description: Joypad Axis 0 - (Left Stick Left, Joystick 0 Left)

[madmiraal]

I still think the differences between the event descriptions (10 axis specific), and the Input Map descriptions (20 half-axis specific) are enough to justify two different lists of descriptions for the two different needs:

Event descriptions:

• Joypad Motion on Axis 0, (Left Stick X-Axis, Joystick 0 X-Axis) with Value -0.3
• Joypad Motion on Axis 0, (Left Stick X-Axis, Joystick 0 X-Axis) with Value 0.3
• Joypad Motion on Axis 1, (Left Stick Y-Axis, Joystick 0 Y-Axis) with Value -0.3
• Joypad Motion on Axis 1, (Left Stick Y-Axis, Joystick 0 Y-Axis) with Value 0.3

Input Map descriptions:

• Joypad Axis 0 – (Left Stick Left, Joystick 0 Left)
• Joypad Axis 0 + (Left Stick Right, Joystick 0 Right)
• Joypad Axis 1 – (Left Stick Up, Joystick 0 Up)
• Joypad Axis 1 + (Left Stick Down, Joystick 0 Down)

I've highlighted the differences above for one joystick (two axes and the four directions).

[EricEzaM]

So do you propose a method specific for InputEventJoypadMotion? In addition to as_text(), something like input_map_description() (bad example but you know what I mean)?

[akien-mga]

If it's specific to the input map, it should only be in the input map editor code IMO and not an extra method in InputEvents.

[EricEzaM]

Yep, makes sense

[EricEzaM]

Ok, all done. Changed as_text() to contain 10 options for InputEventJoyMotion, and added joy axis descriptions to Input Map Editor such that the description meets the above examples by @madmiraal.

See lines 358-390 of input_map_editor.cpp for the main changes in this iteration

[madmiraal]

Aside from the typo above, I think it's good to go.

[EricEzaM]

All sorted now, thanks!

[akien-mga]

Thanks!

[hsandt]

Hi, I just got the issue of listening to gamepad axis showing the long readable string, but not the one needed to add an input mapping, in v4.0.beta.custom_build [767f8fb]

I'm looking at the code in editor/input_event_configuration_dialog.cpp and can clearly see the quickfix under

// Joypad motion events will display slightly differently than what the event->as_text() provides. See #43660.

but it doesn't seem to be applied.

I couldn't make debugging work in my VS Code so I don't know why the quickfix doesn't work exactly (I'll try to rebuild the whole project with llvm but it will take time, and I have a few things to finish on my project first).

Should I open a new bug report, or let you handle this in this issue?

[Zireael07]

This PR has been merged 2 years ago. Open a new issue.