Rename many global enums relating to input #38054
Conversation
This comment has been minimized.
This comment has been minimized.
aaronfranke
force-pushed
the
enums
branch
2 times, most recently
from
e378aab
to
fe4e82c
Compare
aaronfranke
force-pushed
the
enums
branch
4 times, most recently
from
6db1987
to
aa96a61
Compare
aaronfranke
force-pushed
the
enums
branch
2 times, most recently
from
c9c8229
to
4f943eb
Compare
core/input/input.cpp
Outdated
| } | ||
|
|
||
| JoyAxisList Input::_get_output_axis(String output) { | ||
| ::JoyAxis Input::_get_output_axis(String output) { |
There was a problem hiding this comment.
It's a bit unfortunate to have a name clash with the other JoyAxis. Not sure if/how to solve it, it's not too bad I guess.
There was a problem hiding this comment.
We could rename struct JoyAxis to something else.
There was a problem hiding this comment.
Good idea, maybe JoyAxisValue?
| @@ -104,12 +104,12 @@ static Vector<_CoreConstant> _global_constants; | |||
|
|
|||
| #endif | |||
|
|
|||
| VARIANT_ENUM_CAST(KeyList); | |||
| VARIANT_ENUM_CAST(Key); | |||
There was a problem hiding this comment.
Only remaining concern that I have is that some users might not be happy with the fairly generic (3 letter) Key identifier being taken in the global scope. Might lead to issues if one wants to name a class Key for a key item, or naming a public property Key in C# (which I think uses PascalCase for public properties).
Of course I agree that the name is correct for the enum and matches the constants' naming scheme. But that might be the reason why this (and other enums, for consistency) was named KeyList and not Key in the first place.
There was a problem hiding this comment.
We also already have name conflicts between properties and non-properties in the core Godot API for C#.
One option is to make KeyList be the exception, or we could do something else like Keyboard or KeyCode. Key seems fine to me though.
There was a problem hiding this comment.
KeyCode sounds good. InputEventKey has a property with this name.
There was a problem hiding this comment.
Yeah I guess KeyCode might be fine. It does re-add an inconsistency, but to some extent the KeyList enumerated values are actually different from the other enums. They're internal keycodes while the rest are indices (0 to max).
There was a problem hiding this comment.
Should we have KEY_ENTER or KEY_CODE_ENTER?
There was a problem hiding this comment.
Oh, we can't use KeyCode, it conflicts with X11:
/usr/include/X11/X.h:108:23: note: 'KeyCode' has a previous declaration here
108 | typedef unsigned char KeyCode;
| ^~~~~~~
There was a problem hiding this comment.
Let's give it a go with Key and see what happens. If it turns out problematic, we can just do the few renames necessary before the 4.0 release.
|
Thanks! |
Implements #16863 (comment) + the following 2 comments. Implements and closes godotengine/godot-proposals#1817.
ButtonList->MouseButtonand members now start withMOUSE_BUTTON_KeyList->Keyand all members are the same.JoyButtonList->JoyButtonandJoyAxisList->JoyAxis.MidiMessageList->MIDIMessagefor consistency with the above.