cpp/openttd-patchpack/source Changeset - r19410:f2fbf89f252f

Changeset - r19410:f2fbf89f252f

Parent rev.

Child rev.

[Not reviewed]

master

0 1 0

frosch - 12 years ago 2012-06-06 13:13:05
frosch@openttd.org

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

1 file changed with 5 insertions and 0 deletions:

src/script/api/script_company.hpp

0 comments (0 inline, 0 general)

src/script/api/script_company.hpp

➞

Show inline comments

@@ @@ -157,34 +157,39 @@ public: @@
 	static Money GetLoanInterval();
 	/**
 	 * Gets the bank balance. In other words, the amount of money the given company can spent.
 	 * @param company The company to get the bank balance of.
 	 * @pre ResolveCompanyID(company) != COMPANY_INVALID.
 	 * @return The actual bank balance.
 	 */
 	static Money GetBankBalance(CompanyID company);
 	/**
 	 * 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.
 	 * @pre quarter <= EARLIEST_QUARTER.
 	 * @return The bruto income of the company in the given quarter.
 	 */
 	static Money GetQuarterlyIncome(CompanyID company, uint32 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 quarter The quarter to get the expenses of.
 	 * @pre ResolveCompanyID(company) != COMPANY_INVALID.
 	 * @pre quarter <= EARLIEST_QUARTER.
 	 * @return The expenses of the company in the given quarter.
 	 */
 	static Money GetQuarterlyExpenses(CompanyID company, uint32 quarter);
 	/**
 	 * Get the amount of cargo delivered by the given company in the given quarter.
 	 * @param company The company to get the amount of delivered cargo of.
 	 * @param quarter The quarter to get the amount of delivered cargo of.

0 comments (0 inline, 0 general)