# HG changeset patch # User frosch # Date 1338988385 0 # Node ID 7e5f7861487b9da1d179f0b47c833cd957709006 # Parent 0dbf5aeba6f25412a69ef117ab19ed31254918cb (svn r24327) -Doc: [Script] Improve documentation of ScriptCompany::GetQuarterlyIncome/Expenses(). diff --git a/src/script/api/script_company.hpp b/src/script/api/script_company.hpp --- 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.