1

/* $Id$ */

     2

     3

/** @file water_cmd.cpp Handling of water tiles. */

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

    17

#include "depot_base.h"

    18

#include "depot_func.h"

    19

#include "vehicle_gui.h"

    20

#include "train.h"

    21

#include "roadveh.h"

    22

#include "water.h"

    23

#include "water_map.h"

    24

#include "industry_map.h"

    25

#include "newgrf.h"

    26

#include "newgrf_canal.h"

    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

#include "tree_map.h"

    38

#include "station_base.h"

    39

#include "airport.h"

    40

#include "newgrf_cargo.h"

    41

#include "effectvehicle_func.h"

    42

#include "oldpool_func.h"

    43

    44

#include "table/sprites.h"

    45

#include "table/strings.h"

    46

    47

/**

    48

 * Describes the behaviour of a tile during flooding.

    49

 */

    50

enum FloodingBehaviour {

    51

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

    52

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

    53

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

    54

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

    55

};

    56

    57

/**

    58

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

    59

 */

    60

static const uint8 _flood_from_dirs[] = {

    61

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

    62

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

    63

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

    64

	(1 << DIR_NE),                                                 // SLOPE_SW

    65

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

    66

	0,                                                             // SLOPE_EW

    67

	(1 << DIR_NW),                                                 // SLOPE_SE

    68

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

    69

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

    70

	(1 << DIR_SE),                                                 // SLOPE_NW

    71

	0,                                                             // SLOPE_NS

    72

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

    73

	(1 << DIR_SW),                                                 // SLOPE_NE

    74

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

    75

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

    76

};

    77

    78

/**

    79

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

    80

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

    81

 *

    82

 * @param tile tile to check

    83

 */

    84

static inline void MarkTileDirtyIfCanalOrRiver(TileIndex tile)

    85

{

    86

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

    87

}

    88

    89

/**

    90

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

    91

 *

    92

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

    93

 * @ingroup dirty

    94

 */

    95

static void MarkCanalsAndRiversAroundDirty(TileIndex tile)

    96

{

    97

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

    98

		MarkTileDirtyIfCanalOrRiver(tile + TileOffsByDir(dir));

    99

	}

   100

}

   101

   102

/**

   103

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

   104

 *

   105

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

   106

 *

   107

 * This as for example docks and shipdepots do not store

   108

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

   109

 * @param t the tile to change.

   110

 * @param o the owner of the new tile.

   111

 */

   112

void SetWaterClassDependingOnSurroundings(TileIndex t)

   113

{

   114

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

   115

   116

	/* Mark tile dirty in all cases */

   117

	MarkTileDirtyByTile(t);

   118

   119

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

   120

		/* tiles at map borders are always WATER_CLASS_SEA */

   121

		SetWaterClass(t, WATER_CLASS_SEA);

   122

		return;

   123

	}

   124

   125

	bool has_water = false;

   126

	bool has_canal = false;

   127

	bool has_river = false;

   128

   129

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

   130

		TileIndex neighbour = TileAddByDiagDir(t, dir);

   131

		switch (GetTileType(neighbour)) {

   132

			case MP_WATER:

   133

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

   134

				if (IsCoast(neighbour)) {

   135

					has_water = true;

   136

				} else if (!IsLock(neighbour)) {

   137

					switch (GetWaterClass(neighbour)) {

   138

						case WATER_CLASS_SEA:   has_water = true; break;

   139

						case WATER_CLASS_CANAL: has_canal = true; break;

   140

						case WATER_CLASS_RIVER: has_river = true; break;

   141

						default: NOT_REACHED();

   142

					}

   143

				}

   144

				break;

   145

   146

			case MP_RAILWAY:

   147

				/* Shore or flooded halftile */

   148

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

   149

				break;

   150

   151

			case MP_TREES:

   152

				/* trees on shore */

   153

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

   154

				break;

   155

   156

			default: break;

   157

		}

   158

	}

   159

   160

	if (has_river && !has_canal) {

   161

		SetWaterClass(t, WATER_CLASS_RIVER);

   162

	} else if (has_canal || !has_water) {

   163

		SetWaterClass(t, WATER_CLASS_CANAL);

   164

	} else {

   165

		SetWaterClass(t, WATER_CLASS_SEA);

   166

	}

   167

}

   168

   169

   170

/** Build a ship depot.

   171

 * @param tile tile where ship depot is built

   172

 * @param flags type of operation

   173

 * @param p1 bit 0 depot orientation (Axis)

   174

 * @param p2 unused

   175

 */

   176

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

   177

{

   178

	TileIndex tile2;

   179

   180

	CommandCost ret;

   181

   182

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

   183

   184

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

   185

   186

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

   187

		return_cmd_error(STR_3801_MUST_BE_BUILT_ON_WATER);

   188

	}

   189

   190

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

   191

   192

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

   193

		/* Prevent depots on rapids */

   194

		return_cmd_error(STR_0239_SITE_UNSUITABLE);

   195

	}

   196

   197

	WaterClass wc1 = GetWaterClass(tile);

   198

	WaterClass wc2 = GetWaterClass(tile2);

   199

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

   200

	if (CmdFailed(ret)) return CMD_ERROR;

   201

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

   202

	if (CmdFailed(ret)) return CMD_ERROR;

   203

   204

	if (!Depot::CanAllocateItem()) return CMD_ERROR;

   205

   206

	if (flags & DC_EXEC) {

   207

		Depot *depot = new Depot(tile);

   208

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

   209

   210

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

   211

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

   212

		MarkTileDirtyByTile(tile);

   213

		MarkTileDirtyByTile(tile2);

   214

	}

   215

   216

	return CommandCost(EXPENSES_CONSTRUCTION, _price.build_ship_depot);

   217

}

   218

   219

void MakeWaterKeepingClass(TileIndex tile, Owner o)

   220

{

   221

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

   222

   223

	switch (GetWaterClass(tile)) {

   224

		case WATER_CLASS_SEA:   MakeWater(tile);              break;

   225

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

   226

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

   227

	}

   228

}

   229

   230

static CommandCost RemoveShipDepot(TileIndex tile, uint32 flags)

   231

{

   232

	if (!IsShipDepot(tile)) return CMD_ERROR;

   233

	if (!CheckTileOwnership(tile)) return CMD_ERROR;

   234

   235

	TileIndex tile2 = GetOtherShipDepotTile(tile);

   236

   237

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

   238

	if (!(flags & DC_BANKRUPT)) {

   239

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

   240

	}

   241

   242

	if (flags & DC_EXEC) {

   243

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

   244

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

   245

   246

		MakeWaterKeepingClass(tile,  GetTileOwner(tile));

   247

		MakeWaterKeepingClass(tile2, GetTileOwner(tile2));

   248

		MarkTileDirtyByTile(tile);

   249

		MarkTileDirtyByTile(tile2);

   250

	}

   251

   252

	return CommandCost(EXPENSES_CONSTRUCTION, _price.remove_ship_depot);

   253

}

   254

   255

/** build a shiplift */

   256

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

   257

{

   258

	CommandCost ret;

   259

	int delta;

   260

   261

	/* middle tile */

   262

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

   263

	if (CmdFailed(ret)) return CMD_ERROR;

   264

   265

	delta = TileOffsByDiagDir(dir);

   266

	/* lower tile */

   267

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

   268

   269

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

   270

	if (CmdFailed(ret)) return CMD_ERROR;

   271

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

   272

		return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   273

	}

   274

   275

	/* upper tile */

   276

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

   277

   278

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

   279

	if (CmdFailed(ret)) return CMD_ERROR;

   280

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

   281

		return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   282

	}

   283

   284

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

   285

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

   286

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

   287

		return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   288

	}

   289

   290

	if (flags & DC_EXEC) {

   291

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

   292

		MarkTileDirtyByTile(tile);

   293

		MarkTileDirtyByTile(tile - delta);

   294

		MarkTileDirtyByTile(tile + delta);

   295

		MarkCanalsAndRiversAroundDirty(tile - delta);

   296

		MarkCanalsAndRiversAroundDirty(tile + delta);

   297

	}

   298

   299

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

   300

}

   301

   302

static CommandCost RemoveShiplift(TileIndex tile, uint32 flags)

   303

{

   304

	TileIndexDiff delta = TileOffsByDiagDir(GetLockDirection(tile));

   305

   306

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

   307

   308

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

   309

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

   310

		return CMD_ERROR;

   311

   312

	if (flags & DC_EXEC) {

   313

		DoClearSquare(tile);

   314

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

   315

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

   316

		MarkTileDirtyByTile(tile - delta);

   317

		MarkTileDirtyByTile(tile + delta);

   318

		MarkCanalsAndRiversAroundDirty(tile - delta);

   319

		MarkCanalsAndRiversAroundDirty(tile + delta);

   320

	}

   321

   322

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

   323

}

   324

   325

/** Builds a lock (ship-lift)

   326

 * @param tile tile where to place the lock

   327

 * @param flags type of operation

   328

 * @param p1 unused

   329

 * @param p2 unused

   330

 */

   331

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

   332

{

   333

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

   334

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

   335

   336

	/* Disallow building of locks on river rapids */

   337

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

   338

   339

	return DoBuildShiplift(tile, dir, flags);

   340

}

   341

   342

/** Build a piece of canal.

   343

 * @param tile end tile of stretch-dragging

   344

 * @param flags type of operation

   345

 * @param p1 start tile of stretch-dragging

   346

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

   347

 */

   348

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

   349

{

   350

	CommandCost cost(EXPENSES_CONSTRUCTION);

   351

	int size_x, size_y;

   352

	int x;

   353

	int y;

   354

	int sx, sy;

   355

   356

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

   357

   358

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

   359

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

   360

   361

	x = TileX(tile);

   362

	y = TileY(tile);

   363

	sx = TileX(p1);

   364

	sy = TileY(p1);

   365

   366

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

   367

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

   368

	size_x = (x - sx) + 1;

   369

	size_y = (y - sy) + 1;

   370

   371

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

   372

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

   373

   374

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

   375

		CommandCost ret;

   376

   377

		Slope slope = GetTileSlope(tile, NULL);

   378

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

   379

			return_cmd_error(STR_0007_FLAT_LAND_REQUIRED);

   380

		}

   381

   382

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

   383

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

   384

   385

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

   386

		if (CmdFailed(ret)) return ret;

   387

		cost.AddCost(ret);

   388

   389

		if (flags & DC_EXEC) {

   390

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

   391

				MakeWater(tile);

   392

			} else if (p2 == 2) {

   393

				MakeRiver(tile, Random());

   394

			} else {

   395

				MakeCanal(tile, _current_player, Random());

   396

			}

   397

			MarkTileDirtyByTile(tile);

   398

			MarkCanalsAndRiversAroundDirty(tile);

   399

		}

   400

   401

		cost.AddCost(_price.clear_water);

   402

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

   403

   404

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

   405

		return_cmd_error(STR_1007_ALREADY_BUILT);

   406

	} else {

   407

		return cost;

   408

	}

   409

}

   410

   411

static CommandCost ClearTile_Water(TileIndex tile, byte flags)

   412

{

   413

	switch (GetWaterTileType(tile)) {

   414

		case WATER_TILE_CLEAR:

   415

			if (flags & DC_NO_WATER) return_cmd_error(STR_3807_CAN_T_BUILD_ON_WATER);

   416

   417

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

   418

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

   419

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

   420

				return_cmd_error(STR_0002_TOO_CLOSE_TO_EDGE_OF_MAP);

   421

			}

   422

   423

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

   424

			if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   425

   426

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

   427

   428

			if (flags & DC_EXEC) {

   429

				DoClearSquare(tile);

   430

				MarkCanalsAndRiversAroundDirty(tile);

   431

			}

   432

			return CommandCost(EXPENSES_CONSTRUCTION, _price.clear_water);

   433

   434

		case WATER_TILE_COAST: {

   435

			Slope slope = GetTileSlope(tile, NULL);

   436

   437

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

   438

			if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   439

   440

			if (flags & DC_EXEC) {

   441

				DoClearSquare(tile);

   442

				MarkCanalsAndRiversAroundDirty(tile);

   443

			}

   444

			if (IsSlopeWithOneCornerRaised(slope)) {

   445

				return CommandCost(EXPENSES_CONSTRUCTION, _price.clear_water);

   446

			} else {

   447

				return CommandCost(EXPENSES_CONSTRUCTION, _price.clear_roughland);

   448

			}

   449

		}

   450

   451

		case WATER_TILE_LOCK: {

   452

			static const TileIndexDiffC _shiplift_tomiddle_offs[] = {

   453

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

   454

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

   455

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

   456

			};

   457

   458

			if (flags & DC_AUTO) return_cmd_error(STR_2004_BUILDING_MUST_BE_DEMOLISHED);

   459

			if (_current_player == OWNER_WATER) return CMD_ERROR;

   460

			/* move to the middle tile.. */

   461

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

   462

		}

   463

   464

		case WATER_TILE_DEPOT:

   465

			if (flags & DC_AUTO) return_cmd_error(STR_2004_BUILDING_MUST_BE_DEMOLISHED);

   466

			return RemoveShipDepot(tile, flags);

   467

   468

		default:

   469

			NOT_REACHED();

   470

	}

   471

}

   472

   473

/**

   474

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

   475

 *

   476

 * @param tile The tile of interest.

   477

 * @param from The direction of interest.

   478

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

   479

 *

   480

 */

   481

static bool IsWateredTile(TileIndex tile, Direction from)

   482

{

   483

	switch (GetTileType(tile)) {