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

#include "tunnelbridge_map.h"

    44

    45

#include "table/sprites.h"

    46

#include "table/strings.h"

    47

    48

/**

    49

 * Describes the behaviour of a tile during flooding.

    50

 */

    51

enum FloodingBehaviour {

    52

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

    53

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

    54

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

    55

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

    56

};

    57

    58

/**

    59

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

    60

 */

    61

static const uint8 _flood_from_dirs[] = {

    62

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

    63

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

    64

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

    65

	(1 << DIR_NE),                                                 // SLOPE_SW

    66

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

    67

	0,                                                             // SLOPE_EW

    68

	(1 << DIR_NW),                                                 // SLOPE_SE

    69

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

    70

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

    71

	(1 << DIR_SE),                                                 // SLOPE_NW

    72

	0,                                                             // SLOPE_NS

    73

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

    74

	(1 << DIR_SW),                                                 // SLOPE_NE

    75

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

    76

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

    77

};

    78

    79

/**

    80

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

    81

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

    82

 *

    83

 * @param tile tile to check

    84

 */

    85

static inline void MarkTileDirtyIfCanalOrRiver(TileIndex tile)

    86

{

    87

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

    88

}

    89

    90

/**

    91

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

    92

 *

    93

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

    94

 * @ingroup dirty

    95

 */

    96

static void MarkCanalsAndRiversAroundDirty(TileIndex tile)

    97

{

    98

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

    99

		MarkTileDirtyIfCanalOrRiver(tile + TileOffsByDir(dir));

   100

	}

   101

}

   102

   103

/**

   104

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

   105

 *

   106

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

   107

 *

   108

 * This as for example docks and shipdepots do not store

   109

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

   110

 * @param t the tile to change.

   111

 * @param o the owner of the new tile.

   112

 * @param include_invalid_water_class Also consider WATER_CLASS_INVALID, i.e. industry tiles on land

   113

 */

   114

void SetWaterClassDependingOnSurroundings(TileIndex t, bool include_invalid_water_class)

   115

{

   116

	/* If the slope is not flat, we always assume 'land' (if allowed). Also for one-corner-raised-shores.

   117

	 * Note: Wrt. autosloping under industry tiles this is the most fool-proof behaviour. */

   118

	if (GetTileSlope(t, NULL) != SLOPE_FLAT) {

   119

		if (include_invalid_water_class) {

   120

			SetWaterClass(t, WATER_CLASS_INVALID);

   121

			return;

   122

		} else {

   123

			NOT_REACHED();

   124

		}

   125

	}

   126

   127

	/* Mark tile dirty in all cases */

   128

	MarkTileDirtyByTile(t);

   129

   130

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

   131

		/* tiles at map borders are always WATER_CLASS_SEA */

   132

		SetWaterClass(t, WATER_CLASS_SEA);

   133

		return;

   134

	}

   135

   136

	bool has_water = false;

   137

	bool has_canal = false;

   138

	bool has_river = false;

   139

   140

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

   141

		TileIndex neighbour = TileAddByDiagDir(t, dir);

   142

		switch (GetTileType(neighbour)) {

   143

			case MP_WATER:

   144

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

   145

				if (IsCoast(neighbour)) {

   146

					has_water = true;

   147

				} else if (!IsLock(neighbour)) {

   148

					switch (GetWaterClass(neighbour)) {

   149

						case WATER_CLASS_SEA:   has_water = true; break;

   150

						case WATER_CLASS_CANAL: has_canal = true; break;

   151

						case WATER_CLASS_RIVER: has_river = true; break;

   152

						default: NOT_REACHED();

   153

					}

   154

				}

   155

				break;

   156

   157

			case MP_RAILWAY:

   158

				/* Shore or flooded halftile */

   159

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

   160

				break;

   161

   162

			case MP_TREES:

   163

				/* trees on shore */

   164

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

   165

				break;

   166

   167

			default: break;

   168

		}

   169

	}

   170

   171

	if (!has_water && !has_canal && !has_river && include_invalid_water_class) {

   172

		SetWaterClass(t, WATER_CLASS_INVALID);

   173

		return;

   174

	}

   175

   176

	if (has_river && !has_canal) {

   177

		SetWaterClass(t, WATER_CLASS_RIVER);

   178

	} else if (has_canal || !has_water) {

   179

		SetWaterClass(t, WATER_CLASS_CANAL);

   180

	} else {

   181

		SetWaterClass(t, WATER_CLASS_SEA);

   182

	}

   183

}

   184

   185

   186

/** Build a ship depot.

   187

 * @param tile tile where ship depot is built

   188

 * @param flags type of operation

   189

 * @param p1 bit 0 depot orientation (Axis)

   190

 * @param p2 unused

   191

 */

   192

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

   193

{

   194

	TileIndex tile2;

   195

   196

	CommandCost ret;

   197

   198

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

   199

   200

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

   201

   202

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

   203

		return_cmd_error(STR_3801_MUST_BE_BUILT_ON_WATER);

   204

	}

   205

   206

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

   207

   208

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

   209

		/* Prevent depots on rapids */

   210

		return_cmd_error(STR_0239_SITE_UNSUITABLE);

   211

	}

   212

   213

	WaterClass wc1 = GetWaterClass(tile);

   214

	WaterClass wc2 = GetWaterClass(tile2);

   215

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

   216

	if (CmdFailed(ret)) return CMD_ERROR;

   217

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

   218

	if (CmdFailed(ret)) return CMD_ERROR;

   219

   220

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

   221

   222

	if (flags & DC_EXEC) {

   223

		Depot *depot = new Depot(tile);

   224

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

   225

   226

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

   227

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

   228

		MarkTileDirtyByTile(tile);

   229

		MarkTileDirtyByTile(tile2);

   230

	}

   231

   232

	return CommandCost(EXPENSES_CONSTRUCTION, _price.build_ship_depot);

   233

}

   234

   235

void MakeWaterKeepingClass(TileIndex tile, Owner o)

   236

{

   237

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

   238

   239

	WaterClass wc = GetWaterClass(tile);

   240

   241

	/* Autoslope might turn an originally canal or river tile into land */

   242

	uint z;

   243

	if (GetTileSlope(tile, &z) != SLOPE_FLAT) wc = WATER_CLASS_INVALID;

   244

   245

	if (wc == WATER_CLASS_SEA && z > 0) wc = WATER_CLASS_CANAL;

   246

   247

	switch (wc) {

   248

		case WATER_CLASS_SEA:   MakeWater(tile);              break;

   249

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

   250

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

   251

		default:                DoClearSquare(tile);          break;

   252

	}

   253

}

   254

   255

static CommandCost RemoveShipDepot(TileIndex tile, uint32 flags)

   256

{

   257

	if (!IsShipDepot(tile)) return CMD_ERROR;

   258

	if (!CheckTileOwnership(tile)) return CMD_ERROR;

   259

   260

	TileIndex tile2 = GetOtherShipDepotTile(tile);

   261

   262

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

   263

	if (!(flags & DC_BANKRUPT)) {

   264

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

   265

	}

   266

   267

	if (flags & DC_EXEC) {

   268

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

   269

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

   270

   271

		MakeWaterKeepingClass(tile,  GetTileOwner(tile));

   272

		MakeWaterKeepingClass(tile2, GetTileOwner(tile2));

   273

		MarkTileDirtyByTile(tile);

   274

		MarkTileDirtyByTile(tile2);

   275

	}

   276

   277

	return CommandCost(EXPENSES_CONSTRUCTION, _price.remove_ship_depot);

   278

}

   279

   280

/** build a shiplift */

   281

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

   282

{

   283

	CommandCost ret;

   284

	int delta;

   285

   286

	/* middle tile */

   287

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

   288

	if (CmdFailed(ret)) return CMD_ERROR;

   289

   290

	delta = TileOffsByDiagDir(dir);

   291

	/* lower tile */

   292

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

   293

   294

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

   295

	if (CmdFailed(ret)) return CMD_ERROR;

   296

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

   297

		return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   298

	}

   299

   300

	/* upper tile */

   301

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

   302

   303

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

   304

	if (CmdFailed(ret)) return CMD_ERROR;

   305

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

   306

		return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   307

	}

   308

   309

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

   310

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

   311

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

   312

		return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   313

	}

   314

   315

	if (flags & DC_EXEC) {

   316

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

   317

		MarkTileDirtyByTile(tile);

   318

		MarkTileDirtyByTile(tile - delta);

   319

		MarkTileDirtyByTile(tile + delta);

   320

		MarkCanalsAndRiversAroundDirty(tile - delta);

   321

		MarkCanalsAndRiversAroundDirty(tile + delta);

   322

	}

   323

   324

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

   325

}

   326

   327

static CommandCost RemoveShiplift(TileIndex tile, uint32 flags)

   328

{

   329

	TileIndexDiff delta = TileOffsByDiagDir(GetLockDirection(tile));

   330

   331

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

   332

   333

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

   334

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

   335

		return CMD_ERROR;

   336

   337

	if (flags & DC_EXEC) {

   338

		DoClearSquare(tile);

   339

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

   340

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

   341

		MarkTileDirtyByTile(tile - delta);

   342

		MarkTileDirtyByTile(tile + delta);

   343

		MarkCanalsAndRiversAroundDirty(tile - delta);

   344

		MarkCanalsAndRiversAroundDirty(tile + delta);

   345

	}

   346

   347

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

   348

}

   349

   350

/** Builds a lock (ship-lift)

   351

 * @param tile tile where to place the lock

   352

 * @param flags type of operation

   353

 * @param p1 unused

   354

 * @param p2 unused

   355

 */

   356

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

   357

{

   358

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

   359

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

   360

   361

	/* Disallow building of locks on river rapids */

   362

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

   363

   364

	return DoBuildShiplift(tile, dir, flags);

   365

}

   366

   367

/** Build a piece of canal.

   368

 * @param tile end tile of stretch-dragging

   369

 * @param flags type of operation

   370

 * @param p1 start tile of stretch-dragging

   371

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

   372

 */

   373

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

   374

{

   375

	CommandCost cost(EXPENSES_CONSTRUCTION);

   376

	int size_x, size_y;

   377

	int x;

   378

	int y;

   379

	int sx, sy;

   380

   381

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

   382

   383

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

   384

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

   385

   386

	x = TileX(tile);

   387

	y = TileY(tile);

   388

	sx = TileX(p1);

   389

	sy = TileY(p1);

   390

   391

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

   392

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

   393

	size_x = (x - sx) + 1;

   394

	size_y = (y - sy) + 1;

   395

   396

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

   397

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

   398

   399

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

   400

		CommandCost ret;

   401

   402

		Slope slope = GetTileSlope(tile, NULL);

   403

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

   404

			return_cmd_error(STR_0007_FLAT_LAND_REQUIRED);

   405

		}

   406

   407

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

   408

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

   409

   410

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

   411

		if (CmdFailed(ret)) return ret;

   412

		cost.AddCost(ret);

   413

   414

		if (flags & DC_EXEC) {

   415

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

   416

				MakeWater(tile);

   417

			} else if (p2 == 2) {

   418

				MakeRiver(tile, Random());

   419

			} else {

   420

				MakeCanal(tile, _current_player, Random());

   421

			}

   422

			MarkTileDirtyByTile(tile);

   423

			MarkCanalsAndRiversAroundDirty(tile);

   424

		}

   425

   426

		cost.AddCost(_price.clear_water);

   427

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

   428

   429

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

   430

		return_cmd_error(STR_1007_ALREADY_BUILT);

   431

	} else {

   432

		return cost;

   433

	}

   434

}

   435

   436

static CommandCost ClearTile_Water(TileIndex tile, byte flags)

   437

{

   438

	switch (GetWaterTileType(tile)) {

   439

		case WATER_TILE_CLEAR:

   440

			if (flags & DC_NO_WATER) return_cmd_error(STR_3807_CAN_T_BUILD_ON_WATER);

   441

   442

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

   443

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

   444

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

   445

				return_cmd_error(STR_0002_TOO_CLOSE_TO_EDGE_OF_MAP);

   446

			}

   447

   448

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

   449

			if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   450

   451

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

   452

   453

			if (flags & DC_EXEC) {

   454

				DoClearSquare(tile);

   455

				MarkCanalsAndRiversAroundDirty(tile);

   456

			}

   457

			return CommandCost(EXPENSES_CONSTRUCTION, _price.clear_water);

   458

   459

		case WATER_TILE_COAST: {

   460

			Slope slope = GetTileSlope(tile, NULL);

   461

   462

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

   463

			if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   464

   465

			if (flags & DC_EXEC) {

   466

				DoClearSquare(tile);

   467

				MarkCanalsAndRiversAroundDirty(tile);

   468

			}

   469

			if (IsSlopeWithOneCornerRaised(slope)) {

   470

				return CommandCost(EXPENSES_CONSTRUCTION, _price.clear_water);

   471

			} else {

   472

				return CommandCost(EXPENSES_CONSTRUCTION, _price.clear_roughland);

   473

			}

   474

		}

   475

   476

		case WATER_TILE_LOCK: {

   477

			static const TileIndexDiffC _shiplift_tomiddle_offs[] = {

   478

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

   479

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

   480

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

   481

			};

   482

   483