gronod/OpenTTD
1
0
Fork 0
mirror of https://github.com/OpenTTD/OpenTTD.git synced 2025-03-12 10:30:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

(svn r24327) -Doc: [Script] Improve documentation of ScriptCompany::GetQuarterlyIncome/Expenses().

Browse Source
This commit is contained in:
frosch 2012-06-06 13:13:05 +00:00
parent 4bd09effe3
commit c0e209162a
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
src/script/api/script_company.hpp
View File

@ -166,6 +166,8 @@ public:
/** /**
* Get the income of the company in the given quarter. * 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 company The company to get the quarterly income of.
* @param quarter The quarter to get the income of. * @param quarter The quarter to get the income of.
* @pre ResolveCompanyID(company) != COMPANY_INVALID. * @pre ResolveCompanyID(company) != COMPANY_INVALID.
@ -176,6 +178,9 @@ public:
/** /**
* Get the expenses of the company in the given quarter. * 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 company The company to get the quarterly expenses of.
* @param quarter The quarter to get the expenses of. * @param quarter The quarter to get the expenses of.
* @pre ResolveCompanyID(company) != COMPANY_INVALID. * @pre ResolveCompanyID(company) != COMPANY_INVALID.