summaryrefslogtreecommitdiff
path: root/src/script/api/script_company.hpp
diff options
context:
space:
mode:
authortruebrain <truebrain@openttd.org>2011-12-19 21:05:36 +0000
committertruebrain <truebrain@openttd.org>2011-12-19 21:05:36 +0000
commit9b6b2cabc187f3cb72a53d396418ab1b9ebd2933 (patch)
treeac5d34e3837adcdf45c69ab844bd823dc740900a /src/script/api/script_company.hpp
parentcc3f42794d134b9f4b6c7efecb07d4b3366887c1 (diff)
downloadopenttd-9b6b2cabc187f3cb72a53d396418ab1b9ebd2933.tar.xz
(svn r23633) -Add: allow most build commands from GameScript given a CompanyMode is active in that scope
Diffstat (limited to 'src/script/api/script_company.hpp')
-rw-r--r--src/script/api/script_company.hpp6
1 files changed, 3 insertions, 3 deletions
diff --git a/src/script/api/script_company.hpp b/src/script/api/script_company.hpp
index c49b0ee00..de15b7ab2 100644
--- a/src/script/api/script_company.hpp
+++ b/src/script/api/script_company.hpp
@@ -123,8 +123,8 @@ public:
* @pre GetLoanInterval() must be a multiplier of 'loan'.
* @pre 'loan' must be below GetMaxLoanAmount().
* @pre 'loan' - GetLoanAmount() + GetBankBalance() must be non-negative.
+ * @game @pre Valid ScriptCompanyMode active in scope.
* @return True if the loan could be set to your requested amount.
- * @api -game
*/
static bool SetLoanAmount(int32 loan);
@@ -133,8 +133,8 @@ public:
* @param loan The amount to loan (any positive number).
* @pre 'loan' must be non-negative.
* @pre 'loan' must be below GetMaxLoanAmount().
+ * @game @pre Valid ScriptCompanyMode active in scope.
* @return True if we could allocate a minimum of 'loan' loan.
- * @api -game
*/
static bool SetMinimumLoanAmount(int32 loan);
@@ -223,12 +223,12 @@ public:
* Build your company's HQ on the given tile.
* @param tile The tile to build your HQ on, this tile is the most nothern tile of your HQ.
* @pre ScriptMap::IsValidTile(tile).
+ * @game @pre Valid ScriptCompanyMode active in scope.
* @exception ScriptError::ERR_AREA_NOT_CLEAR
* @exception ScriptError::ERR_FLAT_LAND_REQUIRED
* @return True if the HQ could be build.
* @note An HQ can not be removed, only by water or rebuilding; If an HQ is
* build again, the old one is removed.
- * @api -game
*/
static bool BuildCompanyHQ(TileIndex tile);