diff options
| author | truebrain <truebrain@openttd.org> | 2011-12-19 21:06:06 +0000 |
|---|---|---|
| committer | truebrain <truebrain@openttd.org> | 2011-12-19 21:06:06 +0000 |
| commit | 102f811d0277afefe5c90762c0c4cc11ab69713c (patch) | |
| tree | 1c7343e8031eab2c764cff974bd9df9a814c3dd9 /src/script/api/script_company.hpp | |
| parent | b0ac529a6ff4e087520a14d2a0169f445952e7e0 (diff) | |
| download | openttd-102f811d0277afefe5c90762c0c4cc11ab69713c.tar.xz | |
(svn r23636) -Add: introduce ScriptText in parameters where it can be used
Diffstat (limited to 'src/script/api/script_company.hpp')
| -rw-r--r-- | src/script/api/script_company.hpp | 16 |
1 files changed, 7 insertions, 9 deletions
diff --git a/src/script/api/script_company.hpp b/src/script/api/script_company.hpp index de15b7ab2..04c3a5abc 100644 --- a/src/script/api/script_company.hpp +++ b/src/script/api/script_company.hpp @@ -13,6 +13,7 @@ #define SCRIPT_COMPANY_HPP #include "script_object.hpp" +#include "script_text.hpp" /** * Class that handles all company related functions. @@ -64,14 +65,12 @@ public: /** * Set the name of your company. - * @param name The new name of the company. - * @pre 'name' must have at least one character. - * @pre 'name' must have at most 30 characters. + * @param name The new name of the company (can be either a raw string, or a ScriptText object). + * @pre name != NULL && len(name) != 0. * @exception ScriptError::ERR_NAME_IS_NOT_UNIQUE * @return True if the name was changed. - * @api -game */ - static bool SetName(const char *name); + static bool SetName(Text *name); /** * Get the name of the given company. @@ -83,13 +82,12 @@ public: /** * Set the name of your president. - * @param name The new name of the president. - * @pre 'name' must have at least one character. + * @param name The new name of the president (can be either a raw string, or a ScriptText object). + * @pre name != NULL && len(name) != 0. * @exception ScriptError::ERR_NAME_IS_NOT_UNIQUE * @return True if the name was changed. - * @api -game */ - static bool SetPresidentName(const char *name); + static bool SetPresidentName(Text *name); /** * Get the name of the president of the given company. |