Mercurial > hg > openttd
changeset 19424:7e5f7861487b draft
(svn r24327) -Doc: [Script] Improve documentation of ScriptCompany::GetQuarterlyIncome/Expenses().
| author | frosch <frosch@openttd.org> |
|---|---|
| date | Wed, 06 Jun 2012 13:13:05 +0000 |
| parents | 0dbf5aeba6f2 |
| children | 77d425d5d4f1 |
| files | src/script/api/script_company.hpp |
| diffstat | 1 files changed, 5 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- a/src/script/api/script_company.hpp +++ b/src/script/api/script_company.hpp @@ -166,6 +166,8 @@ /** * 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 @@ /** * 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.