From 28f60095092081967535aa69e3fb8c8dfe7d132b Mon Sep 17 00:00:00 2001 From: frosch Date: Mon, 28 Oct 2013 11:03:13 +0000 Subject: (svn r25923) -Fix: [NoGo] Documentation for GSTown::SetGrowthRate --- src/script/api/script_town.hpp | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'src/script') diff --git a/src/script/api/script_town.hpp b/src/script/api/script_town.hpp index b41b7f401..d301cbe56 100644 --- a/src/script/api/script_town.hpp +++ b/src/script/api/script_town.hpp @@ -252,7 +252,8 @@ public: * @param days_between_town_growth The amount of days between town growth. * @pre IsValidTown(town_id). * @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 */ static bool SetGrowthRate(TownID town_id, uint16 days_between_town_growth); -- cgit v1.2.3-70-g09d2