1

/* $Id$ */

     2

     3

/** @file water_cmd.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "bridge_map.h"

     8

#include "bridge.h"

     9

#include "cmd_helper.h"

    10

#include "station_map.h"

    11

#include "tile_cmd.h"

    12

#include "landscape.h"

    13

#include "viewport_func.h"

    14

#include "command_func.h"

    15

#include "town.h"

    16

#include "news.h"

    17

#include "depot.h"

    18

#include "vehicle_gui.h"

    19

#include "train.h"

    20

#include "roadveh.h"

    21

#include "water.h"

    22

#include "water_map.h"

    23

#include "industry_map.h"

    24

#include "newgrf.h"

    25

#include "newgrf_canal.h"

    26

#include "misc/autoptr.hpp"

    27

#include "transparency.h"

    28

#include "strings_func.h"

    29

#include "functions.h"

    30

#include "window_func.h"

    31

#include "vehicle_func.h"

    32

#include "sound_func.h"

    33

#include "variables.h"

    34

#include "player_func.h"

    35

#include "settings_type.h"

    36

#include "clear_map.h"

    37

    38

#include "table/sprites.h"

    39

#include "table/strings.h"

    40

    41

/**

    42

 * Describes the behaviour of a tile during flooding.

    43

 */

    44

enum FloodingBehaviour {

    45

	FLOOD_NONE,    ///< The tile does not flood neighboured tiles.

    46

	FLOOD_ACTIVE,  ///< The tile floods neighboured tiles.

    47

	FLOOD_PASSIVE, ///< The tile does not actively flood neighboured tiles, but it prevents them from drying up.

    48

	FLOOD_DRYUP,   ///< The tile drys up if it is not constantly flooded from neighboured tiles.

    49

};

    50

    51

/**

    52

 * Describes from which directions a specific slope can be flooded (if the tile is floodable at all).

    53

 */

    54

static const uint8 _flood_from_dirs[] = {

    55

	(1 << DIR_NW) | (1 << DIR_SW) | (1 << DIR_SE) | (1 << DIR_NE), // SLOPE_FLAT

    56

	(1 << DIR_NE) | (1 << DIR_SE),                                 // SLOPE_W

    57

	(1 << DIR_NW) | (1 << DIR_NE),                                 // SLOPE_S

    58

	(1 << DIR_NE),                                                 // SLOPE_SW

    59

	(1 << DIR_NW) | (1 << DIR_SW),                                 // SLOPE_E

    60

	0,                                                             // SLOPE_EW

    61

	(1 << DIR_NW),                                                 // SLOPE_SE

    62

	(1 << DIR_N ) | (1 << DIR_NW) | (1 << DIR_NE),                 // SLOPE_WSE, SLOPE_STEEP_S

    63

	(1 << DIR_SW) | (1 << DIR_SE),                                 // SLOPE_N

    64

	(1 << DIR_SE),                                                 // SLOPE_NW

    65

	0,                                                             // SLOPE_NS

    66

	(1 << DIR_E ) | (1 << DIR_NE) | (1 << DIR_SE),                 // SLOPE_NWS, SLOPE_STEEP_W

    67

	(1 << DIR_SW),                                                 // SLOPE_NE

    68

	(1 << DIR_S ) | (1 << DIR_SW) | (1 << DIR_SE),                 // SLOPE_ENW, SLOPE_STEEP_N

    69

	(1 << DIR_W ) | (1 << DIR_SW) | (1 << DIR_NW),                 // SLOPE_SEN, SLOPE_STEEP_E

    70

};

    71

    72

/**

    73

 * Makes a tile canal or water depending on the surroundings.

    74

 * This as for example docks and shipdepots do not store

    75

 * whether the tile used to be canal or 'normal' water.

    76

 * @param t the tile to change.

    77

 * @param o the owner of the new tile.

    78

 */

    79

void MakeWaterOrCanalDependingOnSurroundings(TileIndex t, Owner o)

    80

{

    81

	assert(GetTileSlope(t, NULL) == SLOPE_FLAT);

    82

    83

	/* Mark tile dirty in all cases */

    84

	MarkTileDirtyByTile(t);

    85

    86

	/* Non-sealevel -> canal */

    87

	if (TileHeight(t) != 0) {

    88

		MakeCanal(t, o, Random());

    89

		return;

    90

	}

    91

    92

	bool has_water = false;

    93

	bool has_canal = false;

    94

    95

	for (DiagDirection dir = DIAGDIR_BEGIN; dir < DIAGDIR_END; dir++) {

    96

		TileIndex neighbour = TileAddByDiagDir(t, dir);

    97

		if (IsTileType(neighbour, MP_WATER)) {

    98

			has_water |= IsSea(neighbour) || IsCoast(neighbour) || (IsShipDepot(neighbour) && GetShipDepotWaterOwner(neighbour) == OWNER_WATER);

    99

			has_canal |= IsCanal(neighbour) || (IsShipDepot(neighbour) && GetShipDepotWaterOwner(neighbour) != OWNER_WATER);

   100

		}

   101

	}

   102

	if (has_canal || !has_water) {

   103

		MakeCanal(t, o, Random());

   104

	} else {

   105

		MakeWater(t);

   106

	}

   107

}

   108

   109

   110

/** Build a ship depot.

   111

 * @param tile tile where ship depot is built

   112

 * @param flags type of operation

   113

 * @param p1 bit 0 depot orientation (Axis)

   114

 * @param p2 unused

   115

 */

   116

CommandCost CmdBuildShipDepot(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)

   117

{

   118

	TileIndex tile2;

   119

   120

	CommandCost ret;

   121

   122

	Axis axis = Extract<Axis, 0>(p1);

   123

   124

	tile2 = tile + (axis == AXIS_X ? TileDiffXY(1, 0) : TileDiffXY(0, 1));

   125

   126

	if (!IsWaterTile(tile) || !IsWaterTile(tile2))

   127

		return_cmd_error(STR_3801_MUST_BE_BUILT_ON_WATER);

   128

   129

	if (IsBridgeAbove(tile) || IsBridgeAbove(tile2)) return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   130

   131

	Owner o1 = GetTileOwner(tile);

   132

	Owner o2 = GetTileOwner(tile2);

   133

	ret = DoCommand(tile, 0, 0, flags, CMD_LANDSCAPE_CLEAR);

   134

	if (CmdFailed(ret)) return CMD_ERROR;

   135

	ret = DoCommand(tile2, 0, 0, flags, CMD_LANDSCAPE_CLEAR);

   136

	if (CmdFailed(ret)) return CMD_ERROR;

   137

   138

	Depot *depot = new Depot(tile);

   139

	if (depot == NULL) return CMD_ERROR;

   140

	AutoPtrT<Depot> d_auto_delete = depot;

   141

   142

	if (flags & DC_EXEC) {

   143

		depot->town_index = ClosestTownFromTile(tile, (uint)-1)->index;

   144

   145

		MakeShipDepot(tile,  _current_player, DEPOT_NORTH, axis, o1);

   146

		MakeShipDepot(tile2, _current_player, DEPOT_SOUTH, axis, o2);

   147

		MarkTileDirtyByTile(tile);

   148

		MarkTileDirtyByTile(tile2);

   149

		d_auto_delete.Detach();

   150

	}

   151

   152

	return CommandCost(EXPENSES_CONSTRUCTION, _price.build_ship_depot);

   153

}

   154

   155

void MakeWaterOrCanalDependingOnOwner(TileIndex tile, Owner o)

   156

{

   157

	if (o == OWNER_WATER) {

   158

		MakeWater(tile);

   159

	} else {

   160

		MakeCanal(tile, o, Random());

   161

	}

   162

}

   163

   164

static CommandCost RemoveShipDepot(TileIndex tile, uint32 flags)

   165

{

   166

	TileIndex tile2;

   167

   168

	if (!IsShipDepot(tile)) return CMD_ERROR;

   169

	if (!CheckTileOwnership(tile)) return CMD_ERROR;

   170

	if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   171

   172

	tile2 = GetOtherShipDepotTile(tile);

   173

   174

	if (!EnsureNoVehicleOnGround(tile2)) return CMD_ERROR;

   175

   176

	if (flags & DC_EXEC) {

   177

		/* Kill the depot, which is registered at the northernmost tile. Use that one */

   178

		delete GetDepotByTile(tile2 < tile ? tile2 : tile);

   179

   180

		MakeWaterOrCanalDependingOnOwner(tile,  GetShipDepotWaterOwner(tile));

   181

		MakeWaterOrCanalDependingOnOwner(tile2, GetShipDepotWaterOwner(tile2));

   182

		MarkTileDirtyByTile(tile);

   183

		MarkTileDirtyByTile(tile2);

   184

	}

   185

   186

	return CommandCost(EXPENSES_CONSTRUCTION, _price.remove_ship_depot);

   187

}

   188

   189

/** build a shiplift */

   190

static CommandCost DoBuildShiplift(TileIndex tile, DiagDirection dir, uint32 flags)

   191

{

   192

	CommandCost ret;

   193

	int delta;

   194

   195

	/* middle tile */

   196

	ret = DoCommand(tile, 0, 0, flags, CMD_LANDSCAPE_CLEAR);

   197

	if (CmdFailed(ret)) return CMD_ERROR;

   198

   199

	delta = TileOffsByDiagDir(dir);

   200

	/* lower tile */

   201

	ret = DoCommand(tile - delta, 0, 0, flags, CMD_LANDSCAPE_CLEAR);

   202

	if (CmdFailed(ret)) return CMD_ERROR;

   203

	if (GetTileSlope(tile - delta, NULL) != SLOPE_FLAT) {

   204

		return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   205

	}

   206

   207

	/* upper tile */

   208

	ret = DoCommand(tile + delta, 0, 0, flags, CMD_LANDSCAPE_CLEAR);

   209

	if (CmdFailed(ret)) return CMD_ERROR;

   210

	if (GetTileSlope(tile + delta, NULL) != SLOPE_FLAT) {

   211

		return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   212

	}

   213

   214

	if ((MayHaveBridgeAbove(tile) && IsBridgeAbove(tile)) ||

   215

	    (MayHaveBridgeAbove(tile - delta) && IsBridgeAbove(tile - delta)) ||

   216

	    (MayHaveBridgeAbove(tile + delta) && IsBridgeAbove(tile + delta))) {

   217

		return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   218

	}

   219

   220

	if (flags & DC_EXEC) {

   221

		MakeLock(tile, _current_player, dir);

   222

		MarkTileDirtyByTile(tile);

   223

		MarkTileDirtyByTile(tile - delta);

   224

		MarkTileDirtyByTile(tile + delta);

   225

	}

   226

   227

	return CommandCost(EXPENSES_CONSTRUCTION, _price.clear_water * 22 >> 3);

   228

}

   229

   230

static CommandCost RemoveShiplift(TileIndex tile, uint32 flags)

   231

{

   232

	TileIndexDiff delta = TileOffsByDiagDir(GetLockDirection(tile));

   233

   234

	if (!CheckTileOwnership(tile) && GetTileOwner(tile) != OWNER_NONE) return CMD_ERROR;

   235

   236

	/* make sure no vehicle is on the tile. */

   237

	if (!EnsureNoVehicleOnGround(tile) || !EnsureNoVehicleOnGround(tile + delta) || !EnsureNoVehicleOnGround(tile - delta))

   238

		return CMD_ERROR;

   239

   240

	if (flags & DC_EXEC) {

   241

		DoClearSquare(tile);

   242

		MakeWaterOrCanalDependingOnSurroundings(tile + delta, _current_player);

   243

		MakeWaterOrCanalDependingOnSurroundings(tile - delta, _current_player);

   244

	}

   245

   246

	return CommandCost(EXPENSES_CONSTRUCTION, _price.clear_water * 2);

   247

}

   248

   249

/**

   250

 * Marks the tiles around a tile as dirty.

   251

 *

   252

 * This functions marks the tiles around a given tile as dirty for repaint.

   253

 *

   254

 * @param tile The center of the tile where all other tiles are marked as dirty

   255

 * @ingroup dirty

   256

 * @see TerraformAddDirtyTileAround

   257

 */

   258

static void MarkTilesAroundDirty(TileIndex tile)

   259

{

   260

	MarkTileDirtyByTile(TILE_ADDXY(tile, 0, 1));

   261

	MarkTileDirtyByTile(TILE_ADDXY(tile, 0, -1));

   262

	MarkTileDirtyByTile(TILE_ADDXY(tile, 1, 0));

   263

	MarkTileDirtyByTile(TILE_ADDXY(tile, -1, 0));

   264

}

   265

   266

/** Builds a lock (ship-lift)

   267

 * @param tile tile where to place the lock

   268

 * @param flags type of operation

   269

 * @param p1 unused

   270

 * @param p2 unused

   271

 */

   272

CommandCost CmdBuildLock(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)

   273

{

   276

   277

	/* Disallow building of locks on river rapids */

   278

	if (IsRiverTile(tile)) return_cmd_error(STR_0239_SITE_UNSUITABLE);

   279

   280

	return DoBuildShiplift(tile, dir, flags);

   281

}

   282

   283

/** Build a piece of canal.

   284

 * @param tile end tile of stretch-dragging

   285

 * @param flags type of operation

   286

 * @param p1 start tile of stretch-dragging

   288

 */

   289

CommandCost CmdBuildCanal(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)

   290

{

   291

	CommandCost cost(EXPENSES_CONSTRUCTION);

   292

	int size_x, size_y;

   293

	int x;

   294

	int y;

   295

	int sx, sy;

   296

   297

	if (p1 >= MapSize()) return CMD_ERROR;

   298

   299

	/* Outside of the editor you can only build canals, not oceans */

   300

	if (p2 != 0 && _game_mode != GM_EDITOR) return CMD_ERROR;

   301

   302

	x = TileX(tile);

   303

	y = TileY(tile);

   304

	sx = TileX(p1);

   305

	sy = TileY(p1);

   306

   307

	if (x < sx) Swap(x, sx);

   308

	if (y < sy) Swap(y, sy);

   309

	size_x = (x - sx) + 1;

   310

	size_y = (y - sy) + 1;

   311

   312

	/* Outside the editor you can only drag canals, and not areas */

   313

	if (_game_mode != GM_EDITOR && (sx != x && sy != y)) return CMD_ERROR;

   314

   315

	BEGIN_TILE_LOOP(tile, size_x, size_y, TileXY(sx, sy)) {

   316

		CommandCost ret;

   317

   318

		Slope slope = GetTileSlope(tile, NULL);

   320

			return_cmd_error(STR_0007_FLAT_LAND_REQUIRED);

   321

		}

   322

   323

		/* can't make water of water! */

   324

		if (IsTileType(tile, MP_WATER) && (!IsTileOwner(tile, OWNER_WATER) || p2 == 1)) continue;

   325

   326

		ret = DoCommand(tile, 0, 0, flags, CMD_LANDSCAPE_CLEAR);

   327

		if (CmdFailed(ret)) return ret;

   328

		cost.AddCost(ret);

   329

   330

		if (flags & DC_EXEC) {

   331

			if (TileHeight(tile) == 0 && p2 == 1) {

   332

				MakeWater(tile);

   333

			} else if (p2 == 2) {

   334

				MakeRiver(tile, Random());

   335

			} else {

   336

				MakeCanal(tile, _current_player, Random());

   337

			}

   338

			MarkTileDirtyByTile(tile);

   339

			MarkTilesAroundDirty(tile);

   340

		}

   341

   342

		cost.AddCost(_price.clear_water);

   343

	} END_TILE_LOOP(tile, size_x, size_y, 0);

   344

   345

	if (cost.GetCost() == 0) {

   346

		return_cmd_error(STR_1007_ALREADY_BUILT);

   347

	} else {

   348

		return cost;

   349

	}

   350

}

   351

   352

static CommandCost ClearTile_Water(TileIndex tile, byte flags)

   353

{

   354

	switch (GetWaterTileType(tile)) {

   355

		case WATER_TILE_CLEAR:

   356

		case WATER_TILE_RIVER:

   357

			if (flags & DC_NO_WATER) return_cmd_error(STR_3807_CAN_T_BUILD_ON_WATER);

   358

   359

			/* Make sure it's not an edge tile. */

   360

			if (!IsInsideMM(TileX(tile), 1, MapMaxX() - 1) ||

   361

					!IsInsideMM(TileY(tile), 1, MapMaxY() - 1)) {

   362

				return_cmd_error(STR_0002_TOO_CLOSE_TO_EDGE_OF_MAP);

   363

			}

   364

   365

			/* Make sure no vehicle is on the tile */

   366

			if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   367

   368

			if (GetTileOwner(tile) != OWNER_WATER && GetTileOwner(tile) != OWNER_NONE && !CheckTileOwnership(tile)) return CMD_ERROR;

   369

   370

			if (flags & DC_EXEC) DoClearSquare(tile);

   371

			return CommandCost(EXPENSES_CONSTRUCTION, _price.clear_water);

   372

   373

		case WATER_TILE_COAST: {

   374

			Slope slope = GetTileSlope(tile, NULL);

   375

   376

			/* Make sure no vehicle is on the tile */

   377

			if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   378

   379

			if (flags & DC_EXEC) DoClearSquare(tile);

   381

				return CommandCost(EXPENSES_CONSTRUCTION, _price.clear_water);

   382

			} else {

   383

				return CommandCost(EXPENSES_CONSTRUCTION, _price.clear_roughland);

   384

			}

   385

		}

   386

   387

		case WATER_TILE_LOCK: {

   388

			static const TileIndexDiffC _shiplift_tomiddle_offs[] = {

   389

				{ 0,  0}, {0,  0}, { 0, 0}, {0,  0}, // middle

   390

				{-1,  0}, {0,  1}, { 1, 0}, {0, -1}, // lower

   391

				{ 1,  0}, {0, -1}, {-1, 0}, {0,  1}, // upper

   392

			};

   393

   394

			if (flags & DC_AUTO) return_cmd_error(STR_2004_BUILDING_MUST_BE_DEMOLISHED);

   395

			if (_current_player == OWNER_WATER) return CMD_ERROR;

   396

			/* move to the middle tile.. */

   397

			return RemoveShiplift(tile + ToTileIndexDiff(_shiplift_tomiddle_offs[GetSection(tile)]), flags);

   398

		}

   399

   400

		case WATER_TILE_DEPOT:

   401

			if (flags & DC_AUTO) return_cmd_error(STR_2004_BUILDING_MUST_BE_DEMOLISHED);

   402

			return RemoveShipDepot(tile, flags);

   403

   404

		default:

   405

			NOT_REACHED();

   406

	}

   407

}

   408

   409

/** return true if a tile is a water tile. */

   410

static bool IsWateredTile(TileIndex tile)

   411

{

   412

	switch (GetTileType(tile)) {

   413

		case MP_WATER:

   414

			if (!IsCoast(tile)) return true;

   416

   417

		case MP_RAILWAY:  return GetRailGroundType(tile) == RAIL_GROUND_WATER;

   418

		case MP_STATION:  return IsOilRig(tile) || IsDock(tile) || IsBuoy(tile);

   419

		case MP_INDUSTRY: return (GetIndustrySpec(GetIndustryType(tile))->behaviour & INDUSTRYBEH_BUILT_ONWATER) != 0;

   420

		default:          return false;

   421

	}

   422

}

   423

   424

static void DrawWaterEdges(SpriteID base, TileIndex tile)

   425

{

   426

	uint wa;

   427

   428

	/* determine the edges around with water. */

   429

	wa  = IsWateredTile(TILE_ADDXY(tile, -1,  0)) << 0;

   430

	wa += IsWateredTile(TILE_ADDXY(tile,  0,  1)) << 1;

   431

	wa += IsWateredTile(TILE_ADDXY(tile,  1,  0)) << 2;

   432

	wa += IsWateredTile(TILE_ADDXY(tile,  0, -1)) << 3;

   433

   434

	if (!(wa & 1)) DrawGroundSprite(base,     PAL_NONE);

   435

	if (!(wa & 2)) DrawGroundSprite(base + 1, PAL_NONE);

   436

	if (!(wa & 4)) DrawGroundSprite(base + 2, PAL_NONE);

   437

	if (!(wa & 8)) DrawGroundSprite(base + 3, PAL_NONE);

   438

   439

	/* right corner */

   440

	switch (wa & 0x03) {

   441

		case 0: DrawGroundSprite(base + 4, PAL_NONE); break;

   442

		case 3: if (!IsWateredTile(TILE_ADDXY(tile, -1, 1))) DrawGroundSprite(base + 8, PAL_NONE); break;

   443

	}

   444

   445

	/* bottom corner */

   446

	switch (wa & 0x06) {

   447

		case 0: DrawGroundSprite(base + 5, PAL_NONE); break;

   448

		case 6: if (!IsWateredTile(TILE_ADDXY(tile, 1, 1))) DrawGroundSprite(base + 9, PAL_NONE); break;

   449

	}

   450

   451

	/* left corner */

   452

	switch (wa & 0x0C) {

   453

		case  0: DrawGroundSprite(base + 6, PAL_NONE); break;

   454

		case 12: if (!IsWateredTile(TILE_ADDXY(tile, 1, -1))) DrawGroundSprite(base + 10, PAL_NONE); break;

   455

	}

   456

   457

	/* upper corner */

   458

	switch (wa & 0x09) {

   459

		case 0: DrawGroundSprite(base + 7, PAL_NONE); break;

   460

		case 9: if (!IsWateredTile(TILE_ADDXY(tile, -1, -1))) DrawGroundSprite(base + 11, PAL_NONE); break;

   461

	}

   462

}

   463

   464

/** draw a canal styled water tile with dikes around */

   465

void DrawCanalWater(TileIndex tile)

   466

{

   467

	/* Test for custom graphics, else use the default */

   468

	SpriteID dikes_base = GetCanalSprite(CF_DIKES, tile);

   469

	if (dikes_base == 0) dikes_base = SPR_CANAL_DIKES_BASE;

   470

   471

	DrawWaterEdges(dikes_base, tile);

   472

}

   473

   474

struct LocksDrawTileStruct {

   475

	int8 delta_x, delta_y, delta_z;

   476

	byte width, height, depth;

   477

	SpriteID image;

   478

};

   479

   480

#include "table/water_land.h"

   481

   482

static void DrawWaterStuff(const TileInfo *ti, const WaterDrawTileStruct *wdts,

   483

	SpriteID palette, uint base