Author: jtn Date: Mon Apr 6 10:48:10 2015 New Revision: 28723 URL: http://svn.gna.org/viewcvs/freeciv?rev=28723&view=rev Log: Expand header comments for effect_cumulative_min/max().
Modified: branches/S2_6/common/effects.c Modified: branches/S2_6/common/effects.c URL: http://svn.gna.org/viewcvs/freeciv/branches/S2_6/common/effects.c?rev=28723&r1=28722&r2=28723&view=diff ============================================================================== --- branches/S2_6/common/effects.c (original) +++ branches/S2_6/common/effects.c Mon Apr 6 10:48:10 2015 @@ -285,8 +285,11 @@ } /**************************************************************************** - Get the maximum effect value in this ruleset for the universal. - Universal can be NULL to get overall max + Get the maximum effect value in this ruleset for the universal + (that is, the sum of all positive effects clauses that apply specifically + to this universal -- this can be an overestimate in the case of + mutually exclusive effects). + for_uni can be NULL to get max effect value ignoring requirements. ****************************************************************************/ int effect_cumulative_max(enum effect_type type, struct universal *for_uni) { @@ -308,8 +311,11 @@ } /**************************************************************************** - Get the minimum effect value in this ruleset for the universal. - Universal can be NULL for the overall minimum + Get the minimum effect value in this ruleset for the universal + (that is, the sum of all negative effects clauses that apply specifically + to this universal -- this can be an overestimate in the case of + mutually exclusive effects). + for_uni can be NULL to get min effect value ignoring requirements. ****************************************************************************/ int effect_cumulative_min(enum effect_type type, struct universal *for_uni) { _______________________________________________ Freeciv-commits mailing list Freeciv-commits@gna.org https://mail.gna.org/listinfo/freeciv-commits