summaryrefslogtreecommitdiff
path: root/src/script/api/script_marine.hpp
diff options
context:
space:
mode:
authortruebrain <truebrain@openttd.org>2011-12-19 20:57:23 +0000
committertruebrain <truebrain@openttd.org>2011-12-19 20:57:23 +0000
commit436cf09923d881f3c11c8a4b6262c0a89ad1ee73 (patch)
tree8c96fbae532958e5cecfd0370387f26fcb837037 /src/script/api/script_marine.hpp
parent1616961ea2c1fa84c41d7df9af535fbb190d2c41 (diff)
downloadopenttd-436cf09923d881f3c11c8a4b6262c0a89ad1ee73.tar.xz
(svn r23614) -Add: more API functions exposed to NoGo (part 1)
Diffstat (limited to 'src/script/api/script_marine.hpp')
-rw-r--r--src/script/api/script_marine.hpp12
1 files changed, 11 insertions, 1 deletions
diff --git a/src/script/api/script_marine.hpp b/src/script/api/script_marine.hpp
index 97e1fd6d4..95e7041e0 100644
--- a/src/script/api/script_marine.hpp
+++ b/src/script/api/script_marine.hpp
@@ -16,7 +16,7 @@
/**
* Class that handles all marine related functions.
- * @api ai
+ * @api ai game
*/
class ScriptMarine : public ScriptObject {
public:
@@ -105,6 +105,7 @@ public:
* @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);
@@ -119,6 +120,7 @@ public:
* @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);
@@ -130,6 +132,7 @@ public:
* @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,6 +143,7 @@ public:
* @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);
@@ -152,6 +156,7 @@ public:
* @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);
@@ -161,6 +166,7 @@ public:
* @pre ScriptMap::IsValidTile(tile).
* @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);
@@ -170,6 +176,7 @@ public:
* @pre ScriptMap::IsValidTile(tile).
* @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);
@@ -179,6 +186,7 @@ public:
* @pre ScriptMap::IsValidTile(tile).
* @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);
@@ -188,6 +196,7 @@ public:
* @pre ScriptMap::IsValidTile(tile).
* @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);
@@ -197,6 +206,7 @@ public:
* @pre ScriptMap::IsValidTile(tile).
* @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);