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 "transparency.h"

    27

#include "strings_func.h"

    28

#include "functions.h"

    29

#include "window_func.h"

    30

#include "vehicle_func.h"

    31

#include "sound_func.h"

    32

#include "variables.h"

    33

#include "player_func.h"

    34

#include "settings_type.h"

    35

#include "clear_map.h"

    36

#include "tree_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

 * Marks tile dirty if it is a canal or river tile.

    74

 * Called to avoid glitches when flooding tiles next to canal tile.

    75

 *

    76

 * @param tile tile to check

    77

 */

    78

static inline void MarkTileDirtyIfCanalOrRiver(TileIndex tile)

    79

{

    80

	if (IsTileType(tile, MP_WATER) && (IsCanal(tile) || IsRiver(tile))) MarkTileDirtyByTile(tile);

    81

}

    82

    83

/**

    84

 * Marks the tiles around a tile as dirty, if they are canals or rivers.

    85

 *

    86

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

    87

 * @ingroup dirty

    88

 */

    89

static void MarkCanalsAndRiversAroundDirty(TileIndex tile)

    90

{

    91

	for (Direction dir = DIR_BEGIN; dir < DIR_END; dir++) {

    92

		MarkTileDirtyIfCanalOrRiver(tile + TileOffsByDir(dir));

    93

	}

    94

}

    95

    96

/**

    97

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

    98

 *

    99

 * Must only be used for converting old savegames. Use WaterClass now.

   100

 *

   101

 * This as for example docks and shipdepots do not store

   102

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

   103

 * @param t the tile to change.

   104

 * @param o the owner of the new tile.

   105

 */

   106

void SetWaterClassDependingOnSurroundings(TileIndex t)

   107

{

   108

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

   109

   110

	/* Mark tile dirty in all cases */

   111

	MarkTileDirtyByTile(t);

   112

   113

	if (TileX(t) == 0 || TileY(t) == 0 || TileX(t) == MapMaxX() - 1 || TileY(t) == MapMaxY() - 1) {

   114

		/* tiles at map borders are always WATER_CLASS_SEA */

   115

		SetWaterClass(t, WATER_CLASS_SEA);

   116

		return;

   117

	}

   118

   119

	bool has_water = false;

   120

	bool has_canal = false;

   121

	bool has_river = false;

   122

   123

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

   124

		TileIndex neighbour = TileAddByDiagDir(t, dir);

   125

		switch (GetTileType(neighbour)) {

   126

			case MP_WATER:

   127

				/* clear water and shipdepots have already a WaterClass associated */

   128

				if (IsCoast(neighbour)) {

   129

					has_water = true;

   130

				} else if (!IsLock(neighbour)) {

   131

					switch (GetWaterClass(neighbour)) {

   132

						case WATER_CLASS_SEA:   has_water = true; break;

   133

						case WATER_CLASS_CANAL: has_canal = true; break;

   134

						case WATER_CLASS_RIVER: has_river = true; break;

   135

						default: NOT_REACHED();

   136

					}

   137

				}

   138

				break;

   139

   140

			case MP_RAILWAY:

   141

				/* Shore or flooded halftile */

   142

				has_water |= (GetRailGroundType(neighbour) == RAIL_GROUND_WATER);

   143

				break;

   144

   145

			case MP_TREES:

   146

				/* trees on shore */

   147

				has_water |= (GetTreeGround(neighbour) == TREE_GROUND_SHORE);

   148

				break;

   149

   150

			default: break;

   151

		}

   152

	}

   153

   154

	if (has_river && !has_canal) {

   155

		SetWaterClass(t, WATER_CLASS_RIVER);

   156

	} else if (has_canal || !has_water) {

   157

		SetWaterClass(t, WATER_CLASS_CANAL);

   158

	} else {

   159

		SetWaterClass(t, WATER_CLASS_SEA);

   160

	}

   161

}

   162

   163

   164

/** Build a ship depot.

   165

 * @param tile tile where ship depot is built

   166

 * @param flags type of operation

   167

 * @param p1 bit 0 depot orientation (Axis)

   168

 * @param p2 unused

   169

 */

   170

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

   171

{

   172

	TileIndex tile2;

   173

   174

	CommandCost ret;

   175

   176

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

   177

   178

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

   179

   180

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

   181

		return_cmd_error(STR_3801_MUST_BE_BUILT_ON_WATER);

   182

	}

   183

   184

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

   185

   186

	if (GetTileSlope(tile, NULL) != SLOPE_FLAT || GetTileSlope(tile2, NULL) != SLOPE_FLAT) {

   187

		/* Prevent depots on rapids */

   188

		return_cmd_error(STR_0239_SITE_UNSUITABLE);

   189

	}

   190

   191

	WaterClass wc1 = GetWaterClass(tile);

   192

	WaterClass wc2 = GetWaterClass(tile2);

   193

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

   194

	if (CmdFailed(ret)) return CMD_ERROR;

   195

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

   196

	if (CmdFailed(ret)) return CMD_ERROR;

   197

   199

   200

	if (flags & DC_EXEC) {

   202

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

   203

   204

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

   205

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

   206

		MarkTileDirtyByTile(tile);

   207

		MarkTileDirtyByTile(tile2);

   208

	}

   209

   210

	return CommandCost(EXPENSES_CONSTRUCTION, _price.build_ship_depot);

   211

}

   212

   213

void MakeWaterKeepingClass(TileIndex tile, Owner o)

   214

{

   215

	assert(IsTileType(tile, MP_WATER) || (IsTileType(tile, MP_STATION) && (IsBuoy(tile) || IsDock(tile))));

   216

   217

	switch (GetWaterClass(tile)) {

   218

		case WATER_CLASS_SEA:   MakeWater(tile);              break;

   219

		case WATER_CLASS_CANAL: MakeCanal(tile, o, Random()); break;

   220

		case WATER_CLASS_RIVER: MakeRiver(tile, Random());    break;

   221

	}

   222

}

   223

   224

static CommandCost RemoveShipDepot(TileIndex tile, uint32 flags)

   225

{

   226

	if (!IsShipDepot(tile)) return CMD_ERROR;

   227

	if (!CheckTileOwnership(tile)) return CMD_ERROR;

   228

   229

	TileIndex tile2 = GetOtherShipDepotTile(tile);

   230

   231

	/* do not check for ship on tile when company goes bankrupt */

   232

	if (!(flags & DC_BANKRUPT)) {

   233

		if (!EnsureNoVehicleOnGround(tile) || !EnsureNoVehicleOnGround(tile2)) return CMD_ERROR;

   234

	}

   235

   236

	if (flags & DC_EXEC) {

   237

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

   238

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

   239

   240

		MakeWaterKeepingClass(tile,  GetTileOwner(tile));

   241

		MakeWaterKeepingClass(tile2, GetTileOwner(tile2));

   242

		MarkTileDirtyByTile(tile);

   243

		MarkTileDirtyByTile(tile2);

   244

	}

   245

   246

	return CommandCost(EXPENSES_CONSTRUCTION, _price.remove_ship_depot);

   247

}

   248

   249

/** build a shiplift */

   250

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

   251

{

   252

	CommandCost ret;

   253

	int delta;

   254

   255

	/* middle tile */

   256

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

   257

	if (CmdFailed(ret)) return CMD_ERROR;

   258

   259

	delta = TileOffsByDiagDir(dir);

   260

	/* lower tile */

   261

	WaterClass wc_lower = IsWaterTile(tile - delta) ? GetWaterClass(tile - delta) : WATER_CLASS_CANAL;

   262

   263

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

   264

	if (CmdFailed(ret)) return CMD_ERROR;

   265

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

   266

		return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   267

	}

   268

   269

	/* upper tile */

   270

	WaterClass wc_upper = IsWaterTile(tile + delta) ? GetWaterClass(tile + delta) : WATER_CLASS_CANAL;

   271

   272

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

   273

	if (CmdFailed(ret)) return CMD_ERROR;

   274

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

   275

		return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   276

	}

   277

   278

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

   279

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

   280

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

   281

		return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   282

	}

   283

   284

	if (flags & DC_EXEC) {

   285

		MakeLock(tile, _current_player, dir, wc_lower, wc_upper);

   286

		MarkTileDirtyByTile(tile);

   287

		MarkTileDirtyByTile(tile - delta);

   288

		MarkTileDirtyByTile(tile + delta);

   289

		MarkCanalsAndRiversAroundDirty(tile - delta);

   290

		MarkCanalsAndRiversAroundDirty(tile + delta);

   291

	}

   292

   293

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

   294

}

   295

   296

static CommandCost RemoveShiplift(TileIndex tile, uint32 flags)

   297

{

   298

	TileIndexDiff delta = TileOffsByDiagDir(GetLockDirection(tile));

   299

   300

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

   301

   302

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

   303

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

   304

		return CMD_ERROR;

   305

   306

	if (flags & DC_EXEC) {

   307

		DoClearSquare(tile);

   308

		MakeWaterKeepingClass(tile + delta, GetTileOwner(tile));

   309

		MakeWaterKeepingClass(tile - delta, GetTileOwner(tile));

   310

		MarkTileDirtyByTile(tile - delta);

   311

		MarkTileDirtyByTile(tile + delta);

   312

		MarkCanalsAndRiversAroundDirty(tile - delta);

   313

		MarkCanalsAndRiversAroundDirty(tile + delta);

   314

	}

   315

   316

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

   317

}

   318

   319

/** Builds a lock (ship-lift)

   320

 * @param tile tile where to place the lock

   321

 * @param flags type of operation

   322

 * @param p1 unused

   323

 * @param p2 unused

   324

 */

   325

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

   326

{

   327

	DiagDirection dir = GetInclinedSlopeDirection(GetTileSlope(tile, NULL));

   328

	if (dir == INVALID_DIAGDIR) return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   329

   330

	/* Disallow building of locks on river rapids */

   331

	if (IsWaterTile(tile)) return_cmd_error(STR_0239_SITE_UNSUITABLE);

   332

   333

	return DoBuildShiplift(tile, dir, flags);

   334

}

   335

   336

/** Build a piece of canal.

   337

 * @param tile end tile of stretch-dragging

   338

 * @param flags type of operation

   339

 * @param p1 start tile of stretch-dragging

   340

 * @param p2 specifies canal (0), water (1) or river (2); last two can only be built in scenario editor

   341

 */

   342

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

   343

{

   344

	CommandCost cost(EXPENSES_CONSTRUCTION);

   345

	int size_x, size_y;

   346

	int x;

   347

	int y;

   348

	int sx, sy;

   349

   350

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

   351

   352

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

   353

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

   354

   355

	x = TileX(tile);

   356

	y = TileY(tile);

   357

	sx = TileX(p1);

   358

	sy = TileY(p1);

   359

   360

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

   361

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

   362

	size_x = (x - sx) + 1;

   363

	size_y = (y - sy) + 1;

   364

   365

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

   366

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

   367

   368

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

   369

		CommandCost ret;

   370

   371

		Slope slope = GetTileSlope(tile, NULL);

   372

		if (slope != SLOPE_FLAT && (p2 != 2 || !IsInclinedSlope(slope))) {

   373

			return_cmd_error(STR_0007_FLAT_LAND_REQUIRED);

   374

		}

   375

   376

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

   377

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

   378

   379

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

   380

		if (CmdFailed(ret)) return ret;

   381

		cost.AddCost(ret);

   382

   383

		if (flags & DC_EXEC) {

   384

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

   385

				MakeWater(tile);

   386

			} else if (p2 == 2) {

   387

				MakeRiver(tile, Random());

   388

			} else {

   389

				MakeCanal(tile, _current_player, Random());

   390

			}

   391

			MarkTileDirtyByTile(tile);

   392

			MarkCanalsAndRiversAroundDirty(tile);

   393

		}

   394

   395

		cost.AddCost(_price.clear_water);

   396

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

   397

   398

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

   399

		return_cmd_error(STR_1007_ALREADY_BUILT);

   400

	} else {

   401

		return cost;

   402

	}

   403

}

   404

   405

static CommandCost ClearTile_Water(TileIndex tile, byte flags)

   406

{

   407

	switch (GetWaterTileType(tile)) {

   408

		case WATER_TILE_CLEAR:

   409

			if (flags & DC_NO_WATER) return_cmd_error(STR_3807_CAN_T_BUILD_ON_WATER);

   410

   411

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

   412

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

   413

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

   414

				return_cmd_error(STR_0002_TOO_CLOSE_TO_EDGE_OF_MAP);

   415

			}

   416

   417

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

   418

			if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   419

   420

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

   421

   422

			if (flags & DC_EXEC) {

   423

				DoClearSquare(tile);

   424

				MarkCanalsAndRiversAroundDirty(tile);

   425

			}

   426

			return CommandCost(EXPENSES_CONSTRUCTION, _price.clear_water);

   427

   428

		case WATER_TILE_COAST: {

   429

			Slope slope = GetTileSlope(tile, NULL);

   430

   431

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

   432

			if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   433

   434

			if (flags & DC_EXEC) {

   435

				DoClearSquare(tile);

   436

				MarkCanalsAndRiversAroundDirty(tile);

   437

			}

   438

			if (IsSlopeWithOneCornerRaised(slope)) {

   439

				return CommandCost(EXPENSES_CONSTRUCTION, _price.clear_water);

   440

			} else {

   441

				return CommandCost(EXPENSES_CONSTRUCTION, _price.clear_roughland);

   442

			}

   443

		}

   444

   445

		case WATER_TILE_LOCK: {

   446

			static const TileIndexDiffC _shiplift_tomiddle_offs[] = {

   447

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

   448

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

   449

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

   450

			};

   451

   452

			if (flags & DC_AUTO) return_cmd_error(STR_2004_BUILDING_MUST_BE_DEMOLISHED);

   453

			if (_current_player == OWNER_WATER) return CMD_ERROR;

   454

			/* move to the middle tile.. */

   455

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

   456

		}

   457

   458

		case WATER_TILE_DEPOT:

   459

			if (flags & DC_AUTO) return_cmd_error(STR_2004_BUILDING_MUST_BE_DEMOLISHED);

   460

			return RemoveShipDepot(tile, flags);

   461

   462

		default:

   463

			NOT_REACHED();

   464

	}

   465

}

   466

   467

/**

   468

 * return true if a tile is a water tile wrt. a certain direction.

   469

 *

   470

 * @param tile The tile of interest.

   471

 * @param from The direction of interest.

   472

 * @return true iff the tile is water in the view of 'from'.

   473

 *

   474

 */

   475

static bool IsWateredTile(TileIndex tile, Direction from)

   476

{

   477

	switch (GetTileType(tile)) {

   478

		case MP_WATER:

   479

			if (!IsCoast(tile)) return true;

   480

			switch (GetTileSlope(tile, NULL)) {

   481

				case SLOPE_W: return (from == DIR_SE) || (from == DIR_E) || (from == DIR_NE);

   482

				case SLOPE_S: return (from == DIR_NE) || (from == DIR_N) || (from == DIR_NW);

   483

				case SLOPE_E: return (from == DIR_NW) || (from == DIR_W) || (from == DIR_SW);