diff options
| author | truebrain <truebrain@openttd.org> | 2011-12-19 21:00:55 +0000 |
|---|---|---|
| committer | truebrain <truebrain@openttd.org> | 2011-12-19 21:00:55 +0000 |
| commit | ad48ab923764087bf66153d1c26ed0eb05a19989 (patch) | |
| tree | 7851cc098dee7c0e5c5ea0ffe183711342b2a283 /src/script/api/script_town.hpp | |
| parent | 894216083d3f0b7c01ad705c253723e948297138 (diff) | |
| download | openttd-ad48ab923764087bf66153d1c26ed0eb05a19989.tar.xz | |
(svn r23626) -Add: ScriptTown::SetText, which adds custom text to the Town GUI
Diffstat (limited to 'src/script/api/script_town.hpp')
| -rw-r--r-- | src/script/api/script_town.hpp | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/src/script/api/script_town.hpp b/src/script/api/script_town.hpp index 0cee78694..d7f0c44f3 100644 --- a/src/script/api/script_town.hpp +++ b/src/script/api/script_town.hpp @@ -128,6 +128,16 @@ public: static char *GetName(TownID town_id); /** + * Set the custom text of a town, shown in the GUI. + * @param town_id The town to set the custom text of. + * @param text The text to set it to. + * @pre IsValidTown(town_id). + * @return True if the action succeeded. + * @api -ai + */ + static bool SetText(TownID town_id, const char *text); + + /** * Gets the number of inhabitants in the town. * @param town_id The town to get the population of. * @pre IsValidTown(town_id). |