Facepunch / garrysmod-requests

Feature requests for Garry's Mod
84 stars 24 forks source link

Add Correctly Named DOCK enums #2455

Open A1steaksa opened 2 months ago

A1steaksa commented 2 months ago

The enums for panel docking are one of the few that breaks the naming convention and do not have the DOCK_ prefix. It's confusing, inconsistent, and annoying.

Luckily, enum aliases can be added without breaking compatability with existing code.
I'm aware there's some resistance to adding enums as they "pollute" the global table, but I suspect adding 6 entries won't be the proverbial straw that breaks the camel's back.

My proposed naming is: DOCK_NONE DOCK_FILL DOCK_LEFT DOCK_RIGHT DOCK_TOP DOCK_BOTTOM

garryspins commented 2 months ago

Do we actually want people writing p:Dock(DOCK_FILL) though?

A1steaksa commented 2 months ago

I want people to be able to discover the enums in their editor the same way they can with every other enum by typing the prefix of the enum and seeing what auto-complete options are available.

I also want the API to be consistent. That goal isn't achievable everywhere, but it's achievable here.