Anonymous Login
2019-07-18 20:15 UTC

View Issue Details Jump to Notes ]
IDProjectCategoryView StatusLast Update
0000152OpenClonkEnginepublic2014-05-07 14:03
ReporterNewton 
Assigned To 
PrioritylowSeverityfeatureReproducibilityhave not tried
StatusnewResolutionopen 
Product Version 
Target VersionFixed in Version 
Summary0000152: Consistent naming for Player*, Object* functions
DescriptionJCaesar proposed to rename all functions about Objects/Players consistently.
TagsNo tags attached.
Attached Files

-Relationships
+Relationships

-Notes

~0000301

Caesar (developer)

It's actually changing 489 lines in planet and C4Script.cpp (to be done with a rather simple regexp), but there are also the docs, and some questions. Some functions get really long names, the GetXVal.c-functions look silly, and what to do with constants? (I found two, "FX_Call_EngObjHit" and "C4MN_Add_ImgObjRank")

~0003037

Clonkonaut (developer)

Last edited: 2014-05-06 09:36

View 2 revisions

Isn't this like a silent convention "whenever the resulting phrase strikes you as silly, use the short version"?
Maybe it would just be enough to fill the documentation with cross references, e.g. "SetObjectDrawTransform - Did you mean SetObjDrawTransform?"

~0003038

Zapper (developer)

Last edited: 2014-05-07 07:38

View 2 revisions

Even then it might be a good idea to just strike out the conditional phrase from your convention and shorten it to: "always use the short phrase".

People might have a different perception as to what sounds "silly" :)

PS: ...or "use the short version iff the phrase is followed by another word" to keep stuff like FindObject and RemoveObject

~0003039

Clonkonaut (developer)

Bah! Humbug!

(PS sounds good)

~0003040

Sven2 (developer)

I'm in favor of always using the long name. Do we still have a name length limit for identifiers? There used to be a time when function names could be max 30 characters.
+Notes

-Issue History
Date Modified Username Field Change
2010-02-18 21:20 Newton New Issue
2010-02-19 11:23 Newton Priority normal => low
2010-02-20 19:08 Caesar Note Added: 0000301
2014-05-06 09:36 Clonkonaut Note Added: 0003037
2014-05-06 09:36 Clonkonaut Note Edited: 0003037 View Revisions
2014-05-07 07:34 Zapper Note Added: 0003038
2014-05-07 07:38 Zapper Note Edited: 0003038 View Revisions
2014-05-07 08:22 Clonkonaut Note Added: 0003039
2014-05-07 14:03 Sven2 Note Added: 0003040
+Issue History