bugFreeciv - Bugs: bug #20521, Government Upkeep_Factor help wrong

 
 
Show feedback again

bug #20521: Government Upkeep_Factor help wrong

Submitted by:  Jacob Nevins <jtn>
Submitted on:  Sun 17 Feb 2013 03:16:48 PM UTC  
 
Category: docsSeverity: 3 - Normal
Priority: 5 - NormalStatus: None
Assigned to: NoneOpen/Closed: Open
Release: S2_4 r22361Operating System: None
Planned Release: 

Add a New Comment (Rich MarkupRich Markup):
   

You are not logged in

Please log in, so followups can be emailed to you.

 

Mon 01 Apr 2013 11:13:02 PM UTC, comment #1:

> However, the help for [civ2] Settlers says:
> "Settlers in a Republic or Democracy require twice as much
> food per turn, and in Communist or Fundamentalist societies,
> three times as much."

I haven't checked the original game, but two references I've found (1, 2) don't mention it, and the first indicates that food upkeep is 1 for these govs.

Did we make this up?

  • The "three times as much" text came from me in patch #1390. I presume I was just updating docs to match the ruleset, so we can't take that as intention.
  • Going back, I think r11293 (when effects were added) bumped it from 2 to 3, and that this was probably inadvertent.
  • Going back further, upkeep=2 seems to have been deliberate; r4517 deliberately changed it for Communism, and r3761 implemented Fundamentalism in this state.

So I think we should at least reduce it to 2 (under a new ticket), and possibly back to 1 (depending on whether we can find out what commercial Civ2 did).

(I can see a possible game balance argument for having high settler upkeep, to balance the military advantages of these governments, but the civ2 ruleset isn't the place for such tweaks.)

> (Incidentally, if we are intentionally shipping rulesets with
> upkeep 3, it's not ideal that the upkeep icon can only go up
> to 2 -- I only noticed this by hovering over the unit icon to
> get the upkeep numbers.)

Patch #3824 will address this limitation.

Jacob Nevins <jtn>
Project Administrator
Sun 17 Feb 2013 03:16:48 PM UTC, original submission:

Noticed with civ2 ruleset, but will affect others.

In the autogenerated help for civ2 Fundamentalism and Communism we have:

  • "You pay 2 times normal Food upkeep for your units."

No other government types mention this.

However, the help for Settlers says:
"Settlers in a Republic or Democracy require twice as much food per turn, and in Communist or Fundamentalist societies, three times as much."

And by experiment, this appears to be accurate.

(Incidentally, if we are intentionally shipping rulesets with upkeep 3, it's not ideal that the upkeep icon can only go up to 2 -- I only noticed this by hovering over the unit icon to get the upkeep numbers.)

Root cause is that the government help (helptext_government()) cherry-picks effects that apply to the current government, but doesn't consider effects that aren't government-specific. The effect structure in civ2/effects.ruleset looks like:

So "effect_base_unit_upkeep" is not taken into account. For many descriptions that sort of thing doesn't matter, but for Upkeep_Factor which is multiplicative it's very misleading.

This explains why no help text is seen for Republic/Democracy: the resultant factor is 1, which isn't seen as worth mentioning.

A fix that would help here would be to explicitly look for and take account of completely unqualified effects like base_unit_upkeep here.
That doesn't catch more complicated interactions, but most of those would hopefully be specific enough that it's reasonable to say "gov X pays 2x upkeep" and expect the player to know that in condition Y that's a base level that's modified. (In general, this generated help text will never cope with all these circumstances; the best we can hope for is to remain silent when things get complicated.)

(This is with S2_4; haven't checked other branches yet.)

Jacob Nevins <jtn>
Project Administrator

 

(Note: upload size limit is set to 1024 kB, after insertion of the required escape characters.)

Attach File(s):
   
   
Comment:
   

No files currently attached

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -unavailable- added by jtn (Submitted the item)
  •  

    Do you think this task is very important?
    If so, you can click here to add your encouragement to it.
    This task has 0 encouragements so far.

    Only logged-in users can vote.

     

    Please enter the title of George Orwell's famous dystopian book (it's a date):

     

     

    No Changes Have Been Made to This Item
    Show feedback again

    Back to the top


    Powered by Savane 3.1-cleanup