summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorfrosch <frosch@openttd.org>2014-09-24 16:45:20 +0000
committerfrosch <frosch@openttd.org>2014-09-24 16:45:20 +0000
commit1c6705ba34ccc96d4692dc3f882d966732c19e5f (patch)
treeade90ba41936be86c47c2ea73ea82472d268c8a1
parent1f74484ede908ffecfaf2787d5361b5fccdd91c0 (diff)
downloadopenttd-1c6705ba34ccc96d4692dc3f882d966732c19e5f.tar.xz
(svn r26915) -Fix: API docs
-rw-r--r--src/script/api/script_company.hpp1
-rw-r--r--src/script/api/script_town.hpp7
2 files changed, 5 insertions, 3 deletions
diff --git a/src/script/api/script_company.hpp b/src/script/api/script_company.hpp
index 532793081..4deaeed5e 100644
--- a/src/script/api/script_company.hpp
+++ b/src/script/api/script_company.hpp
@@ -192,6 +192,7 @@ public:
* @param company The company to change the bank balance of.
* @param delta Amount of money to give or take from the bank balance. A positive value adds money to the bank balance.
* @param expenses_type The account in the finances window that will register the cost.
+ * @return True, if the bank balance was changed.
* @game @pre No ScriptCompanyMode active in scope.
* @pre ResolveCompanyID(company) != COMPANY_INVALID.
* @pre delta >= -2**31
diff --git a/src/script/api/script_town.hpp b/src/script/api/script_town.hpp
index 4aef587e6..03868e67a 100644
--- a/src/script/api/script_town.hpp
+++ b/src/script/api/script_town.hpp
@@ -232,10 +232,10 @@ public:
/**
* Set the goal of a cargo for this town.
* @param town_id The index of the town.
- * @param towneffect_id The index of the cargo.
+ * @param towneffect_id The index of the towneffect.
* @param goal The new goal.
* @pre IsValidTown(town_id).
- * @pre ScriptCargo::IsValidTownEffect(cargo_id).
+ * @pre ScriptCargo::IsValidTownEffect(towneffect_id).
* @return True if the action succeeded.
* @api -ai
*/
@@ -247,7 +247,7 @@ public:
* @param town_id The index of the town.
* @param towneffect_id The index of the towneffect.
* @pre IsValidTown(town_id).
- * @pre ScriptCargo::IsValidTownEffect(cargo_id).
+ * @pre ScriptCargo::IsValidTownEffect(towneffect_id).
* @return The goal of the cargo.
* @note Goals can change over time. For example with a changing snowline, or
* with a growing town.
@@ -263,6 +263,7 @@ public:
* @return True if the action succeeded.
* @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.
+ * @note When changing the growth rate, the relative progress is preserved and scaled to the new rate.
* @api -ai
*/
static bool SetGrowthRate(TownID town_id, uint32 days_between_town_growth);