From 33ab403be83997f4afb78aaf250a447c12c424cb Mon Sep 17 00:00:00 2001
From: michi_cc <michi_cc@openttd.org>
Date: Tue, 3 Aug 2010 17:48:03 +0000
Subject: [PATCH] (svn r20352) -Add: [NewGRF] Support for property 09, feature
 05, i.e alternate canal sprite layout.

---
 src/newgrf_canal.h | 13 +++++++++----
 src/water_cmd.cpp  | 44 +++++++++++++++++++++++++++++++++-----------
 2 files changed, 42 insertions(+), 15 deletions(-)

diff --git a/src/newgrf_canal.h b/src/newgrf_canal.h
index e98015addb..fba0979b58 100644
--- a/src/newgrf_canal.h
+++ b/src/newgrf_canal.h
@@ -31,12 +31,17 @@ enum CanalFeature {
 	CF_END,
 };
 
+/** Flags controlling the display of canals. */
+enum CanalFeatureFlag {
+	CFF_HAS_FLAT_SPRITE = 0, ///< Additional flat ground sprite in the beginning.
+};
 
+/** Information about a water feature. */
 struct WaterFeature {
-	const SpriteGroup *group;
-	const GRFFile *grffile;   ///< newgrf where 'group' belongs to
-	uint8 callback_mask;       ///< Bitmask of canal callbacks that have to be called
-	uint8 flags;
+	const SpriteGroup *group; ///< Sprite group to start resolving.
+	const GRFFile *grffile;   ///< NewGRF where 'group' belongs to.
+	uint8 callback_mask;      ///< Bitmask of canal callbacks that have to be called.
+	uint8 flags;              ///< Flags controlling display.
 };
 
 
diff --git a/src/water_cmd.cpp b/src/water_cmd.cpp
index 0ea4dfa6d9..4f73105997 100644
--- a/src/water_cmd.cpp
+++ b/src/water_cmd.cpp
@@ -556,7 +556,13 @@ static void DrawSeaWater(TileIndex tile)
 /** draw a canal styled water tile with dikes around */
 static void DrawCanalWater(TileIndex tile)
 {
-	DrawGroundSprite(SPR_FLAT_WATER_TILE, PAL_NONE);
+	SpriteID image = SPR_FLAT_WATER_TILE;
+	if (HasBit(_water_feature[CF_WATERSLOPE].flags, CFF_HAS_FLAT_SPRITE)) {
+		/* First water slope sprite is flat water. */
+		image = GetCanalSprite(CF_WATERSLOPE, tile);
+		if (image == 0) image = SPR_FLAT_WATER_TILE;
+	}
+	DrawGroundSprite(image, PAL_NONE);
 
 	/* Test for custom graphics, else use the default */
 	SpriteID dikes_base = GetCanalSprite(CF_DIKES, tile);
@@ -602,11 +608,22 @@ static void DrawWaterLock(const TileInfo *ti)
 	const WaterDrawTileStruct *wdts = _lock_display_seq[GetSection(ti->tile)];
 
 	/* Draw ground sprite. */
-	SpriteID water_base = GetCanalSprite(CF_WATERSLOPE, ti->tile);
-	if (water_base == 0) water_base = SPR_CANALS_BASE;
-
 	SpriteID image = wdts++->image;
-	if (image < 4) image += water_base;
+
+	SpriteID water_base = GetCanalSprite(CF_WATERSLOPE, ti->tile);
+	if (water_base == 0) {
+		/* Use default sprites. */
+		water_base = SPR_CANALS_BASE;
+	} else if (HasBit(_water_feature[CF_WATERSLOPE].flags, CFF_HAS_FLAT_SPRITE)) {
+		/* NewGRF supplies a flat sprite as first sprite. */
+		if (image == SPR_FLAT_WATER_TILE) {
+			image = water_base;
+		} else {
+			image++;
+		}
+	}
+
+	if (image < 5) image += water_base;
 	DrawGroundSprite(image, PAL_NONE);
 
 	/* Draw structures. */
@@ -635,7 +652,7 @@ static void DrawRiverWater(const TileInfo *ti)
 	SpriteID image = SPR_FLAT_WATER_TILE;
 	SpriteID edges_base = GetCanalSprite(CF_RIVER_EDGE, ti->tile);
 
-	if (ti->tileh != SLOPE_FLAT) {
+	if (ti->tileh != SLOPE_FLAT || HasBit(_water_feature[CF_RIVER_SLOPE].flags, CFF_HAS_FLAT_SPRITE)) {
 		image = GetCanalSprite(CF_RIVER_SLOPE, ti->tile);
 		if (image == 0) {
 			switch (ti->tileh) {
@@ -646,13 +663,18 @@ static void DrawRiverWater(const TileInfo *ti)
 				default:       image = SPR_FLAT_WATER_TILE;    break;
 			}
 		} else {
+			/* Flag bit 0 indicates that the first sprite is flat water. */
+			uint offset = HasBit(_water_feature[CF_RIVER_SLOPE].flags, CFF_HAS_FLAT_SPRITE) ? 1 : 0;
+
 			switch (ti->tileh) {
-				default: NOT_REACHED();
-				case SLOPE_SE:             edges_base += 12; break;
-				case SLOPE_NE: image += 1; edges_base += 24; break;
-				case SLOPE_SW: image += 2; edges_base += 36; break;
-				case SLOPE_NW: image += 3; edges_base += 48; break;
+				case SLOPE_SE:              edges_base += 12; break;
+				case SLOPE_NE: offset += 1; edges_base += 24; break;
+				case SLOPE_SW: offset += 2; edges_base += 36; break;
+				case SLOPE_NW: offset += 3; edges_base += 48; break;
+				default:       offset  = 0; break;
 			}
+
+			image += offset;
 		}
 	}