From 46589fa8270516b476cbafd3b1df490ec4106dce Mon Sep 17 00:00:00 2001
From: frosch <frosch@openttd.org>
Date: Wed, 30 Jan 2008 17:22:06 +0000
Subject: [PATCH] (svn r12020) -Documentation: Correct description of
 TropicZone.

---
 src/landscape.cpp     |  2 +-
 src/terraform_gui.cpp |  2 +-
 src/tile_type.h       | 15 ++++++++++++---
 src/tree_cmd.cpp      |  2 +-
 4 files changed, 15 insertions(+), 6 deletions(-)

diff --git a/src/landscape.cpp b/src/landscape.cpp
index 74161c7b88..8745fa19f1 100644
--- a/src/landscape.cpp
+++ b/src/landscape.cpp
@@ -636,7 +636,7 @@ void InitializeLandscape()
 		for (x = 0; x < maxx; x++) {
 			MakeClear(sizex * y + x, CLEAR_GRASS, 3);
 			SetTileHeight(sizex * y + x, 0);
-			SetTropicZone(sizex * y + x, TROPICZONE_INVALID);
+			SetTropicZone(sizex * y + x, TROPICZONE_NORMAL);
 			ClearBridgeMiddle(sizex * y + x);
 		}
 		MakeVoid(sizex * y + x);
diff --git a/src/terraform_gui.cpp b/src/terraform_gui.cpp
index b0d8cfee59..858aa85bc2 100644
--- a/src/terraform_gui.cpp
+++ b/src/terraform_gui.cpp
@@ -56,7 +56,7 @@ static void GenerateDesertArea(TileIndex end, TileIndex start)
 	_generating_world = true;
 	BEGIN_TILE_LOOP(tile, size_x, size_y, TileXY(sx, sy)) {
 		if (GetTileType(tile) != MP_WATER) {
-			SetTropicZone(tile, (_ctrl_pressed) ? TROPICZONE_INVALID : TROPICZONE_DESERT);
+			SetTropicZone(tile, (_ctrl_pressed) ? TROPICZONE_NORMAL : TROPICZONE_DESERT);
 			DoCommandP(tile, 0, 0, NULL, CMD_LANDSCAPE_CLEAR);
 			MarkTileDirtyByTile(tile);
 		}
diff --git a/src/tile_type.h b/src/tile_type.h
index e954aa1fb6..2d46a74d54 100644
--- a/src/tile_type.h
+++ b/src/tile_type.h
@@ -41,11 +41,20 @@ enum TileType {
 /**
  * Additional infos of a tile on a tropic game.
  *
- * Each non-water tile in a tropic game is either a rainforest tile or a
- * desert one.
+ * The tropiczone is not modified during gameplay. It mainly affects tree growth. (desert tiles are visible though)
+ *
+ * In randomly generated maps:
+ *  TROPICZONE_DESERT: Generated everywhere, if there is neither water nor mountains (TileHeight >= 4) in a certain distance from the tile.
+ *  TROPICZONE_RAINFOREST: Genereated everywhere, if there is no desert in a certain distance from the tile.
+ *  TROPICZONE_NORMAL: Everywhere else, i.e. between desert and rainforest and on sea (if you clear the water).
+ *
+ * In scenarios:
+ *  TROPICZONE_NORMAL: Default value.
+ *  TROPICZONE_DESERT: Placed manually.
+ *  TROPICZONE_RAINFOREST: Placed if you plant certain rainforest-trees.
  */
 enum TropicZone {
-	TROPICZONE_INVALID    = 0,      ///< Invalid tropiczone-type
+	TROPICZONE_NORMAL     = 0,      ///< Normal tropiczone
 	TROPICZONE_DESERT     = 1,      ///< Tile is desert
 	TROPICZONE_RAINFOREST = 2,      ///< Rainforest tile
 };
diff --git a/src/tree_cmd.cpp b/src/tree_cmd.cpp
index 7fc9c133cb..890243ed66 100644
--- a/src/tree_cmd.cpp
+++ b/src/tree_cmd.cpp
@@ -58,7 +58,7 @@ static TreeType GetRandomTreeType(TileIndex tile, uint seed)
 
 		case LT_TROPIC:
 			switch (GetTropicZone(tile)) {
-				case TROPICZONE_INVALID: return (TreeType)(seed * TREE_COUNT_SUB_TROPICAL / 256 + TREE_SUB_TROPICAL);
+				case TROPICZONE_NORMAL:  return (TreeType)(seed * TREE_COUNT_SUB_TROPICAL / 256 + TREE_SUB_TROPICAL);
 				case TROPICZONE_DESERT:  return (TreeType)((seed > 12) ? TREE_INVALID : TREE_CACTUS);
 				default:                 return (TreeType)(seed * TREE_COUNT_RAINFOREST / 256 + TREE_RAINFOREST);
 			}