(svn r23614) -Add: more API functions exposed to NoGo (part 1)
This commit is contained in:
@@ -19,7 +19,7 @@
|
||||
|
||||
/**
|
||||
* Class that handles all tile related functions.
|
||||
* @api ai
|
||||
* @api ai game
|
||||
*/
|
||||
class ScriptTile : public ScriptObject {
|
||||
public:
|
||||
@@ -130,6 +130,7 @@ public:
|
||||
* as you can build tram-rails on road-tiles.
|
||||
* @note For rail you also might want to check for ScriptRoad::IsRoad(),
|
||||
* as in some cases you can build rails on road-tiles.
|
||||
* @api -game
|
||||
*/
|
||||
static bool IsBuildable(TileIndex tile);
|
||||
|
||||
@@ -376,6 +377,7 @@ public:
|
||||
* @exception ScriptError::ERR_TOO_CLOSE_TO_EDGE
|
||||
* @exception ScriptTile::ERR_TILE_TOO_HIGH
|
||||
* @return 0 means failed, 1 means success.
|
||||
* @api -game
|
||||
*/
|
||||
static bool RaiseTile(TileIndex tile, int32 slope);
|
||||
|
||||
@@ -392,6 +394,7 @@ public:
|
||||
* @exception ScriptError::ERR_TOO_CLOSE_TO_EDGE
|
||||
* @exception ScriptTile::ERR_TILE_TOO_LOW
|
||||
* @return 0 means failed, 1 means success.
|
||||
* @api -game
|
||||
*/
|
||||
static bool LowerTile(TileIndex tile, int32 slope);
|
||||
|
||||
@@ -410,6 +413,7 @@ public:
|
||||
* successfully leveled already.
|
||||
* @note This function may return true in ScriptTestMode, although it fails in
|
||||
* ScriptExecMode.
|
||||
* @api -game
|
||||
*/
|
||||
static bool LevelTiles(TileIndex start_tile, TileIndex end_tile);
|
||||
|
||||
@@ -419,6 +423,7 @@ public:
|
||||
* @pre ScriptMap::IsValidTile(tile).
|
||||
* @exception ScriptError::ERR_AREA_NOT_CLEAR
|
||||
* @return True if and only if the tile was demolished.
|
||||
* @api -game
|
||||
*/
|
||||
static bool DemolishTile(TileIndex tile);
|
||||
|
||||
@@ -427,6 +432,7 @@ public:
|
||||
* @param tile The tile to build a tree on.
|
||||
* @pre ScriptMap::IsValidTile(tile).
|
||||
* @return True if and only if a tree was added on the tile.
|
||||
* @api -game
|
||||
*/
|
||||
static bool PlantTree(TileIndex tile);
|
||||
|
||||
@@ -439,6 +445,7 @@ public:
|
||||
* @pre width >= 1 && width <= 20.
|
||||
* @pre height >= 1 && height <= 20.
|
||||
* @return True if and only if a tree was added on any of the tiles in the rectangle.
|
||||
* @api -game
|
||||
*/
|
||||
static bool PlantTreeRectangle(TileIndex tile, uint width, uint height);
|
||||
|
||||
|
Reference in New Issue
Block a user