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

(svn r25968) -Add: [Script] ScriptTown::TOWN_GROWTH_NONE to indicate no town growth via ScriptTown::SetGrowthRate and GetGrowthRate.

Browse Source
This commit is contained in:
frosch
2013-11-12 17:57:12 +00:00
parent b1f41a0afb
commit 9a41aefcc4
8 changed files with 22 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -120,6 +120,7 @@ public:
* Special values for SetGrowthRate.
*/
enum TownGrowth {
TOWN_GROWTH_NONE = 0xFFFF, ///< Town does not grow at all.
TOWN_GROWTH_NORMAL = 0x10000, ///< Use default town growth algorithm instead of custom growth rate.
};
@@ -256,9 +257,9 @@ public:
/**
* Set the amount of days between town growth.
* @param town_id The index of the town.
* @param days_between_town_growth The amount of days between town growth, or TOWN_GROWTH_NORMAL.
* @param days_between_town_growth The amount of days between town growth, TOWN_GROWTH_NONE or TOWN_GROWTH_NORMAL.
* @pre IsValidTown(town_id).
* @pre days_between_town_growth <= 30000 || days_between_town_growth == TOWN_GROWTH_NORMAL.
* @pre days_between_town_growth <= 30000 || days_between_town_growth == TOWN_GROWTH_NONE || days_between_town_growth == TOWN_GROWTH_NORMAL.
* @return True if the action succeeded.
* @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.
@@ -270,7 +271,7 @@ public:
* Get the amount of days between town growth.
* @param town_id The index of the town.
* @pre IsValidTown(town_id).
* @return Amount of days between town growth.
* @return Amount of days between town growth, or TOWN_GROWTH_NONE.
* @note This function does not indicate when it will grow next. It only tells you the time between growths.
*/
static int32 GetGrowthRate(TownID town_id);