summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorfrosch <frosch@openttd.org>2009-05-10 15:23:08 +0000
committerfrosch <frosch@openttd.org>2009-05-10 15:23:08 +0000
commitc6f08e1247867a2518431696c89aba49ccd46199 (patch)
tree70104d3dd8d1efd39d33270ab907321fbdcc6706
parentd4971a22d0b68405345e543893469eb9ed399796 (diff)
downloadopenttd-c6f08e1247867a2518431696c89aba49ccd46199.tar.xz
(svn r16266) -Documentation: [NoAI] Add details to AITile::(Raise|Lower)Tile wrt. modifiing multiple corners at once.
-rw-r--r--src/ai/api/ai_tile.hpp10
1 files changed, 8 insertions, 2 deletions
diff --git a/src/ai/api/ai_tile.hpp b/src/ai/api/ai_tile.hpp
index c979549f2..1083c8aa1 100644
--- a/src/ai/api/ai_tile.hpp
+++ b/src/ai/api/ai_tile.hpp
@@ -340,7 +340,10 @@ public:
/**
* Raise the given corners of the tile. The corners can be combined,
- * for example: SLOPE_N | SLOPE_W (= SLOPE_NW)
+ * for example: SLOPE_N | SLOPE_W (= SLOPE_NW) will raise the west and the north corner.
+ * @note The corners will be modified in the order west (first), south, east, north (last).
+ * Changing one corner might cause another corner to be changed too. So modifiing
+ * multiple corners may result in changing some corners by multiple steps.
* @param tile The tile to raise.
* @param slope Corners to raise (SLOPE_xxx).
* @pre tile < AIMap::GetMapSize().
@@ -353,7 +356,10 @@ public:
/**
* Lower the given corners of the tile. The corners can be combined,
- * for example: SLOPE_N | SLOPE_W (= SLOPE_NW)
+ * for example: SLOPE_N | SLOPE_W (= SLOPE_NW) will lower the west and the north corner.
+ * @note The corners will be modified in the order west (first), south, east, north (last).
+ * Changing one corner might cause another corner to be changed too. So modifiing
+ * multiple corners may result in changing some corners by multiple steps.
* @param tile The tile to lower.
* @param slope Corners to lower (SLOPE_xxx).
* @pre tile < AIMap::GetMapSize().