summaryrefslogtreecommitdiff
path: root/src/script/api
diff options
context:
space:
mode:
authorfrosch <frosch@openttd.org>2013-10-28 11:09:02 +0000
committerfrosch <frosch@openttd.org>2013-10-28 11:09:02 +0000
commita249db1374c0eca31f93f9ced91168cc7de4bc6a (patch)
treea3f9b1bf2db0b5578b3878863aa97299a66f064f /src/script/api
parent28f60095092081967535aa69e3fb8c8dfe7d132b (diff)
downloadopenttd-a249db1374c0eca31f93f9ced91168cc7de4bc6a.tar.xz
(svn r25924) -Fix: [Script] Documentation for ScriptTown::GetGrowthRate.
Diffstat (limited to 'src/script/api')
-rw-r--r--src/script/api/script_town.cpp2
-rw-r--r--src/script/api/script_town.hpp2
2 files changed, 2 insertions, 2 deletions
diff --git a/src/script/api/script_town.cpp b/src/script/api/script_town.cpp
index 3b9a4b7b6..c098039fd 100644
--- a/src/script/api/script_town.cpp
+++ b/src/script/api/script_town.cpp
@@ -166,7 +166,7 @@
/* static */ int32 ScriptTown::GetGrowthRate(TownID town_id)
{
- if (!IsValidTown(town_id)) return false;
+ if (!IsValidTown(town_id)) return -1;
const Town *t = ::Town::Get(town_id);
diff --git a/src/script/api/script_town.hpp b/src/script/api/script_town.hpp
index d301cbe56..df02f18ac 100644
--- a/src/script/api/script_town.hpp
+++ b/src/script/api/script_town.hpp
@@ -262,7 +262,7 @@ public:
* Get the amount of days between town growth.
* @param town_id The index of the town.
* @pre IsValidTown(town_id).
- * @return True if the action succeeded.
+ * @return Amount of days between town growth.
* @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);