Remove 'Auto-generated effect descriptions'

Programmers discuss here anything related to FreeOrion programming. Primarily for the developers to discuss.

Moderator: Committer

Post Reply
Message
Author
User avatar
adrian_broher
Programmer
Posts: 1072
Joined: Fri Mar 01, 2013 9:52 am
Location: Germany

Remove 'Auto-generated effect descriptions'

#1 Post by adrian_broher » Wed Aug 24, 2016 6:56 pm

If there are no objections to it I would like to remove the 'Auto-generated effect descriptions'. To my knowledge the output always was subpar and by adding the optional 'description' parameter to an EffectsGroup a year ago (8359b308) content writers now can provide much better description texts. Removing this option would simplify some of the ValueRef code greatly and remove a good chunk of hard to extract translation keys.
Resident code gremlin
Attached patches are released under GPL 2.0 or later.
Git author: Marcel Metz

User avatar
Vezzra
Release Manager, Design
Posts: 4606
Joined: Wed Nov 16, 2011 12:56 pm
Location: Sol III

Re: Remove 'Auto-generated effect descriptions'

#2 Post by Vezzra » Wed Aug 24, 2016 7:56 pm

Never really used that feature, so no opinion/preference on that one. Can go as far as I'm concerned.

User avatar
Geoff the Medio
Programming, Design, Admin
Posts: 12247
Joined: Wed Oct 08, 2003 1:33 am
Location: Munich

Re: Remove 'Auto-generated effect descriptions'

#3 Post by Geoff the Medio » Wed Aug 24, 2016 7:57 pm

I don't think the optional hand-written description text for effectsgroups is a replacement for the autogenerated descriptions, but I don't think that matters. Switching AutoGeneratedDescription to call ->Dump() instead of ->AutoGeneratedDescription() works at least as well for debugging purposes, which was one of the main reasons to keep the autogenerated descriptions last time it was discussed.

All the autogenerated descriptions for conditions and valuerefs needs to remain though, until all location and enqueue conditions have hand-written descriptions.

User avatar
adrian_broher
Programmer
Posts: 1072
Joined: Fri Mar 01, 2013 9:52 am
Location: Germany

Re: Remove 'Auto-generated effect descriptions'

#4 Post by adrian_broher » Wed Aug 24, 2016 8:25 pm

Geoff the Medio wrote:I don't think the optional hand-written description text for effectsgroups is a replacement for the autogenerated descriptions, but I don't think that matters. Switching AutoGeneratedDescription to call ->Dump() instead of ->AutoGeneratedDescription() works at least as well for debugging purposes, which was one of the main reasons to keep the autogenerated descriptions last time it was discussed.
I already forgot that PR. I will replace it with obj->Dump() calls then and adapt the related code and settings then.
Geoff the Medio wrote:All the autogenerated descriptions for conditions and valuerefs needs to remain though, until all location and enqueue conditions have hand-written descriptions.
I didn't see that. Well, have to start somewhere.
Resident code gremlin
Attached patches are released under GPL 2.0 or later.
Git author: Marcel Metz

Post Reply