From 9b6b2cabc187f3cb72a53d396418ab1b9ebd2933 Mon Sep 17 00:00:00 2001 From: truebrain Date: Mon, 19 Dec 2011 21:05:36 +0000 Subject: (svn r23633) -Add: allow most build commands from GameScript given a CompanyMode is active in that scope --- src/script/api/script_marine.hpp | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) (limited to 'src/script/api/script_marine.hpp') diff --git a/src/script/api/script_marine.hpp b/src/script/api/script_marine.hpp index 95e7041e0..d70121029 100644 --- a/src/script/api/script_marine.hpp +++ b/src/script/api/script_marine.hpp @@ -99,13 +99,13 @@ public: * @param front A tile on the same axis with 'tile' as the depot shall be oriented. * @pre ScriptMap::IsValidTile(tile). * @pre ScriptMap::IsValidTile(front). + * @game @pre Valid ScriptCompanyMode active in scope. * @exception ScriptError::ERR_AREA_NOT_CLEAR * @exception ScriptError::ERR_SITE_UNSUITABLE * @exception ScriptMarine::ERR_MARINE_MUST_BE_BUILT_ON_WATER * @return Whether the water depot has been/can be build or not. * @note A WaterDepot is 1 tile in width, and 2 tiles in length. * @note The depot will be built towards the south from 'tile', not necessarily towards 'front'. - * @api -game */ static bool BuildWaterDepot(TileIndex tile, TileIndex front); @@ -115,12 +115,12 @@ public: * @param station_id The station to join, ScriptStation::STATION_NEW or ScriptStation::STATION_JOIN_ADJACENT. * @pre ScriptMap::IsValidTile(tile). * @pre station_id == ScriptStation::STATION_NEW || station_id == ScriptStation::STATION_JOIN_ADJACENT || ScriptStation::IsValidStation(station_id). + * @game @pre Valid ScriptCompanyMode active in scope. * @exception ScriptError::ERR_AREA_NOT_CLEAR * @exception ScriptError::ERR_SITE_UNSUITABLE * @exception ScriptStation::ERR_STATION_TOO_CLOSE_TO_ANOTHER_STATION * @exception ScriptStation::ERR_STATION_TOO_MANY_STATIONS * @return Whether the dock has been/can be build or not. - * @api -game */ static bool BuildDock(TileIndex tile, StationID station_id); @@ -128,11 +128,11 @@ public: * Builds a buoy on tile. * @param tile The tile where the buoy will be build. * @pre ScriptMap::IsValidTile(tile). + * @game @pre Valid ScriptCompanyMode active in scope. * @exception ScriptError::ERR_AREA_NOT_CLEAR * @exception ScriptError::ERR_SITE_UNSUITABLE * @exception ScriptStation::ERR_STATION_TOO_MANY_STATIONS * @return Whether the buoy has been/can be build or not. - * @api -game */ static bool BuildBuoy(TileIndex tile); @@ -140,10 +140,10 @@ public: * Builds a lock on tile. * @param tile The tile where the lock will be build. * @pre ScriptMap::IsValidTile(tile). + * @game @pre Valid ScriptCompanyMode active in scope. * @exception ScriptError::ERR_LAND_SLOPED_WRONG * @exception ScriptError::ERR_SITE_UNSUITABLE * @return Whether the lock has been/can be build or not. - * @api -game */ static bool BuildLock(TileIndex tile); @@ -151,12 +151,12 @@ public: * Builds a canal on tile. * @param tile The tile where the canal will be build. * @pre ScriptMap::IsValidTile(tile). + * @game @pre Valid ScriptCompanyMode active in scope. * @exception ScriptError::ERR_AREA_NOT_CLEAR * @exception ScriptError::ERR_LAND_SLOPED_WRONG * @exception ScriptError::ERR_OWNED_BY_ANOTHER_COMPANY * @exception ScriptError::ERR_ALREADY_BUILT * @return Whether the canal has been/can be build or not. - * @api -game */ static bool BuildCanal(TileIndex tile); @@ -164,9 +164,9 @@ public: * Removes a water depot. * @param tile Any tile of the water depot. * @pre ScriptMap::IsValidTile(tile). + * @game @pre Valid ScriptCompanyMode active in scope. * @exception ScriptError::ERR_OWNED_BY_ANOTHER_COMPANY * @return Whether the water depot has been/can be removed or not. - * @api -game */ static bool RemoveWaterDepot(TileIndex tile); @@ -174,9 +174,9 @@ public: * Removes a dock. * @param tile Any tile of the dock. * @pre ScriptMap::IsValidTile(tile). + * @game @pre Valid ScriptCompanyMode active in scope. * @exception ScriptError::ERR_OWNED_BY_ANOTHER_COMPANY * @return Whether the dock has been/can be removed or not. - * @api -game */ static bool RemoveDock(TileIndex tile); @@ -184,9 +184,9 @@ public: * Removes a buoy. * @param tile Any tile of the buoy. * @pre ScriptMap::IsValidTile(tile). + * @game @pre Valid ScriptCompanyMode active in scope. * @exception ScriptError::ERR_OWNED_BY_ANOTHER_COMPANY * @return Whether the buoy has been/can be removed or not. - * @api -game */ static bool RemoveBuoy(TileIndex tile); @@ -194,9 +194,9 @@ public: * Removes a lock. * @param tile Any tile of the lock. * @pre ScriptMap::IsValidTile(tile). + * @game @pre Valid ScriptCompanyMode active in scope. * @exception ScriptError::ERR_OWNED_BY_ANOTHER_COMPANY * @return Whether the lock has been/can be removed or not. - * @api -game */ static bool RemoveLock(TileIndex tile); @@ -204,9 +204,9 @@ public: * Removes a canal. * @param tile Any tile of the canal. * @pre ScriptMap::IsValidTile(tile). + * @game @pre Valid ScriptCompanyMode active in scope. * @exception ScriptError::ERR_OWNED_BY_ANOTHER_COMPANY * @return Whether the canal has been/can be removed or not. - * @api -game */ static bool RemoveCanal(TileIndex tile); -- cgit v1.2.3-54-g00ecf