summaryrefslogtreecommitdiff
path: root/src/script/api
diff options
context:
space:
mode:
authorfrosch <frosch@openttd.org>2013-10-28 11:03:13 +0000
committerfrosch <frosch@openttd.org>2013-10-28 11:03:13 +0000
commit28f60095092081967535aa69e3fb8c8dfe7d132b (patch)
tree45e773148d2a37ce8c984b6d104c1f8baccc3abc /src/script/api
parent12b30103b1341fc20389df4c40bd8b34b4b2be3d (diff)
downloadopenttd-28f60095092081967535aa69e3fb8c8dfe7d132b.tar.xz
(svn r25923) -Fix: [NoGo] Documentation for GSTown::SetGrowthRate
Diffstat (limited to 'src/script/api')
-rw-r--r--src/script/api/script_town.hpp3
1 files changed, 2 insertions, 1 deletions
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);