summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorfrosch <frosch@openttd.org>2012-06-06 13:13:05 +0000
committerfrosch <frosch@openttd.org>2012-06-06 13:13:05 +0000
commitc0e209162a9c0ddac2ca04671c42c15d7a3101d6 (patch)
tree93c030c529e3b2dad2097ba70eb0b44a95472b7b
parent4bd09effe3314ce20c6c988994d97a8e9137bd4c (diff)
downloadopenttd-c0e209162a9c0ddac2ca04671c42c15d7a3101d6.tar.xz
(svn r24327) -Doc: [Script] Improve documentation of ScriptCompany::GetQuarterlyIncome/Expenses().
-rw-r--r--src/script/api/script_company.hpp5
1 files changed, 5 insertions, 0 deletions
diff --git a/src/script/api/script_company.hpp b/src/script/api/script_company.hpp
index e9a0b768c..6fcf01d0f 100644
--- a/src/script/api/script_company.hpp
+++ b/src/script/api/script_company.hpp
@@ -166,6 +166,8 @@ public:
/**
* Get the income of the company in the given quarter.
+ * Note that this function only considers recurring income from vehicles;
+ * it does not include one-time income from selling stuff.
* @param company The company to get the quarterly income of.
* @param quarter The quarter to get the income of.
* @pre ResolveCompanyID(company) != COMPANY_INVALID.
@@ -176,6 +178,9 @@ public:
/**
* Get the expenses of the company in the given quarter.
+ * Note that this function only considers recurring expensens from vehicle
+ * running cost, maintenance and interests; it does not include one-time
+ * expenses from construction and buying stuff.
* @param company The company to get the quarterly expenses of.
* @param quarter The quarter to get the expenses of.
* @pre ResolveCompanyID(company) != COMPANY_INVALID.