dave/openttd
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

(svn r23620) -Add: ScriptTown::SetCargoGoal and ScriptTown::SetGrowthRate (GameScript only)

Browse Source
This commit is contained in:
truebrain
2011-12-19 20:59:19 +00:00
parent c7c1deaf41
commit afcf07ac8a
9 changed files with 124 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -191,6 +191,18 @@ public:
*/
static int32 GetLastMonthReceived(TownID town_id, ScriptCargo::TownEffect towneffect_id);
/**
* Set the goal of a cargo for this town.
* @param town_id The index of the town.
* @param towneffect_id The index of the cargo.
* @param goal The new goal.
* @pre IsValidTown(town_id).
* @pre ScriptCargo::IsValidTownEffect(cargo_id).
* @return True if the action succeeded.
* @api -ai
*/
static bool SetCargoGoal(TownID town_id, ScriptCargo::TownEffect towneffect_id, uint32 goal);
/**
* Get the amount of cargo that needs to be delivered (per TownEffect) for a
* town to grow. All goals need to be reached before a town will grow.
@@ -204,6 +216,17 @@ public:
*/
static uint32 GetCargoGoal(TownID town_id, ScriptCargo::TownEffect towneffect_id);
/**
* Set the amount of days between town growth.
* @param town_id The index of the town.
* @param days_between_town_growth The amont of days between town growth.
* @pre IsValidTown(town_id).
* @return True if the action succeeded.
* @note If 'Fund Building' and 'economy.town_growth_rate' is active, the game will often set a new GrowthRate.
* @api -ai
*/
static bool SetGrowthRate(TownID town_id, uint16 days_between_town_growth);
/**
* Get the amount of days between town growth.
* @param town_id The index of the town.