summaryrefslogtreecommitdiff
path: root/src/script/api/script_bridge.hpp
diff options
context:
space:
mode:
authortruebrain <truebrain@openttd.org>2011-12-19 21:02:33 +0000
committertruebrain <truebrain@openttd.org>2011-12-19 21:02:33 +0000
commit084f4e6aacc9b3ad8f6ac319a55027307cfa5f00 (patch)
tree604b1fc3becb05539705904ff59a465e2641ac54 /src/script/api/script_bridge.hpp
parent5858c534202ef45039293e3a6020993621cc55a8 (diff)
downloadopenttd-084f4e6aacc9b3ad8f6ac319a55027307cfa5f00.tar.xz
(svn r23629) -Add: allow ScriptRoad::BuildRoad, ScriptBridge::BuildBridge (for roads) and ScriptTunnel:BuildTunnel (for roads) to work for GameScript
Diffstat (limited to 'src/script/api/script_bridge.hpp')
-rw-r--r--src/script/api/script_bridge.hpp3
1 files changed, 2 insertions, 1 deletions
diff --git a/src/script/api/script_bridge.hpp b/src/script/api/script_bridge.hpp
index 16fe8d6b8..267782603 100644
--- a/src/script/api/script_bridge.hpp
+++ b/src/script/api/script_bridge.hpp
@@ -135,6 +135,7 @@ public:
* ScriptMap::GetTileY(start) == ScriptMap::GetTileY(end).
* @pre vehicle_type == ScriptVehicle::VT_ROAD || vehicle_type == ScriptVehicle::VT_WATER ||
* (vehicle_type == ScriptVehicle::VT_RAIL && ScriptRail::IsRailTypeAvailable(ScriptRail::GetCurrentRailType())).
+ * @game @pre Outside CompanyMode: vehicle_type == ScriptVehicle::VT_ROAD.
* @exception ScriptError::ERR_ALREADY_BUILT
* @exception ScriptError::ERR_AREA_NOT_CLEAR
* @exception ScriptError::ERR_LAND_SLOPED_WRONG
@@ -143,9 +144,9 @@ public:
* @exception ScriptBridge::ERR_BRIDGE_CANNOT_END_IN_WATER
* @exception ScriptBridge::ERR_BRIDGE_HEADS_NOT_ON_SAME_HEIGHT
* @return Whether the bridge has been/can be build or not.
+ * @game @note Building a bridge (without CompanyMode) results in a bridge owned by towns.
* @note No matter if the road pieces were build or not, if building the
* bridge succeeded, this function returns true.
- * @api -game
*/
static bool BuildBridge(ScriptVehicle::VehicleType vehicle_type, BridgeID bridge_id, TileIndex start, TileIndex end);