(svn r25923) -Fix: [NoGo] Documentation for GSTown::SetGrowthRate

This commit is contained in:
frosch 2013-10-28 11:03:13 +00:00
parent 12b30103b1
commit 28f6009509

View File

@ -252,7 +252,8 @@ public:
* @param days_between_town_growth The amount of days between town growth. * @param days_between_town_growth The amount of days between town growth.
* @pre IsValidTown(town_id). * @pre IsValidTown(town_id).
* @return True if the action succeeded. * @return True if the action succeeded.
* @note If 'Fund Building' and 'economy.town_growth_rate' is active, the game will often set a new GrowthRate. * @note Even when setting a growth rate, towns only grow when the conditions for growth (SetCargoCoal) are met,
* and the game settings (economy.town_growth_rate) allow town growth at all.
* @api -ai * @api -ai
*/ */
static bool SetGrowthRate(TownID town_id, uint16 days_between_town_growth); static bool SetGrowthRate(TownID town_id, uint16 days_between_town_growth);