mirror
/
OpenTTD
mirror of https://github.com/OpenTTD/OpenTTD
1
0
Fork 0
Code Issues

(svn r26915) -Fix: API docs

release/1.5
frosch 2014-09-24 16:45:20 +00:00
parent 1f74484ede
commit 1c6705ba34
2 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -192,6 +192,7 @@ public:
* @param company The company to change the bank balance of. * @param company The company to change the bank balance of.
* @param delta Amount of money to give or take from the bank balance. A positive value adds money to the bank balance. * @param delta Amount of money to give or take from the bank balance. A positive value adds money to the bank balance.
* @param expenses_type The account in the finances window that will register the cost. * @param expenses_type The account in the finances window that will register the cost.
* @return True, if the bank balance was changed.
* @game @pre No ScriptCompanyMode active in scope. * @game @pre No ScriptCompanyMode active in scope.
* @pre ResolveCompanyID(company) != COMPANY_INVALID. * @pre ResolveCompanyID(company) != COMPANY_INVALID.
* @pre delta >= -2**31 * @pre delta >= -2**31

7
src/script/api/script_town.hpp
View File

@ -232,10 +232,10 @@ public:
/** /**
* Set the goal of a cargo for this town. * Set the goal of a cargo for this town.
* @param town_id The index of the town. * @param town_id The index of the town.
* @param towneffect_id The index of the cargo. * @param towneffect_id The index of the towneffect.
* @param goal The new goal. * @param goal The new goal.
* @pre IsValidTown(town_id). * @pre IsValidTown(town_id).
* @pre ScriptCargo::IsValidTownEffect(cargo_id). * @pre ScriptCargo::IsValidTownEffect(towneffect_id).
* @return True if the action succeeded. * @return True if the action succeeded.
* @api -ai * @api -ai
*/ */
@ -247,7 +247,7 @@ public:
* @param town_id The index of the town. * @param town_id The index of the town.
* @param towneffect_id The index of the towneffect. * @param towneffect_id The index of the towneffect.
* @pre IsValidTown(town_id). * @pre IsValidTown(town_id).
* @pre ScriptCargo::IsValidTownEffect(cargo_id). * @pre ScriptCargo::IsValidTownEffect(towneffect_id).
* @return The goal of the cargo. * @return The goal of the cargo.
* @note Goals can change over time. For example with a changing snowline, or * @note Goals can change over time. For example with a changing snowline, or
* with a growing town. * with a growing town.
@ -263,6 +263,7 @@ public:
* @return True if the action succeeded. * @return True if the action succeeded.
* @note Even when setting a growth rate, towns only grow when the conditions for growth (SetCargoCoal) are met, * @note Even when setting a growth rate, towns only grow when the conditions for growth (SetCargoCoal) are met,
* and the game settings (economy.town_growth_rate) allow town growth at all. * and the game settings (economy.town_growth_rate) allow town growth at all.
* @note When changing the growth rate, the relative progress is preserved and scaled to the new rate.
* @api -ai * @api -ai
*/ */
static bool SetGrowthRate(TownID town_id, uint32 days_between_town_growth); static bool SetGrowthRate(TownID town_id, uint32 days_between_town_growth);