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 "company_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 "aircraft.h"

    41

#include "newgrf_cargo.h"

    42

#include "effectvehicle_func.h"

    43

#include "oldpool_func.h"

    44

#include "tunnelbridge_map.h"

    45

    46

#include "table/sprites.h"

    47

#include "table/strings.h"

    48

    49

/**

    50

 * Describes the behaviour of a tile during flooding.

    51

 */

    52

enum FloodingBehaviour {

    53

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

    54

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

    55

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

    56

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

    57

};

    58

    59

/**

    60

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

    61

 */

    62

static const uint8 _flood_from_dirs[] = {

    63

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

    64

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

    65

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

    66

	(1 << DIR_NE),                                                 // SLOPE_SW

    67

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

    68

	0,                                                             // SLOPE_EW

    69

	(1 << DIR_NW),                                                 // SLOPE_SE

    70

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

    71

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

    72

	(1 << DIR_SE),                                                 // SLOPE_NW

    73

	0,                                                             // SLOPE_NS

    74

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

    75

	(1 << DIR_SW),                                                 // SLOPE_NE

    76

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

    77

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

    78

};

    79

    80

/**

    81

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

    82

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

    83

 *

    84

 * @param tile tile to check

    85

 */

    86

static inline void MarkTileDirtyIfCanalOrRiver(TileIndex tile)

    87

{

    88

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

    89

}

    90

    91

/**

    92

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

    93

 *

    94

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

    95

 * @ingroup dirty

    96

 */

    97

static void MarkCanalsAndRiversAroundDirty(TileIndex tile)

    98

{

    99

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

   100

		MarkTileDirtyIfCanalOrRiver(tile + TileOffsByDir(dir));

   101

	}

   102

}

   103

   104

/**

   105

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

   106

 *

   107

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

   108

 *

   109

 * This as for example docks and shipdepots do not store

   110

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

   111

 * @param t the tile to change.

   112

 * @param o the owner of the new tile.

   113

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

   114

 */

   115

void SetWaterClassDependingOnSurroundings(TileIndex t, bool include_invalid_water_class)

   116

{

   117

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

   118

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

   119

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

   120

		if (include_invalid_water_class) {

   121

			SetWaterClass(t, WATER_CLASS_INVALID);

   122

			return;

   123

		} else {

   124

			NOT_REACHED();

   125

		}

   126

	}

   127

   128

	/* Mark tile dirty in all cases */

   129

	MarkTileDirtyByTile(t);

   130

   131

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

   132

		/* tiles at map borders are always WATER_CLASS_SEA */

   133

		SetWaterClass(t, WATER_CLASS_SEA);

   134

		return;

   135

	}

   136

   137

	bool has_water = false;

   138

	bool has_canal = false;

   139

	bool has_river = false;

   140

   141

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

   142

		TileIndex neighbour = TileAddByDiagDir(t, dir);

   143

		switch (GetTileType(neighbour)) {

   144

			case MP_WATER:

   145

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

   146

				if (IsCoast(neighbour)) {

   147

					has_water = true;

   148

				} else if (!IsLock(neighbour)) {

   149

					switch (GetWaterClass(neighbour)) {

   150

						case WATER_CLASS_SEA:   has_water = true; break;

   151

						case WATER_CLASS_CANAL: has_canal = true; break;

   152

						case WATER_CLASS_RIVER: has_river = true; break;

   153

						default: NOT_REACHED();

   154

					}

   155

				}

   156

				break;

   157

   158

			case MP_RAILWAY:

   159

				/* Shore or flooded halftile */

   160

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

   161

				break;

   162

   163

			case MP_TREES:

   164

				/* trees on shore */

   165

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

   166

				break;

   167

   168

			default: break;

   169

		}

   170

	}

   171

   172

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

   173

		SetWaterClass(t, WATER_CLASS_INVALID);

   174

		return;

   175

	}

   176

   177

	if (has_river && !has_canal) {

   178

		SetWaterClass(t, WATER_CLASS_RIVER);

   179

	} else if (has_canal || !has_water) {

   180

		SetWaterClass(t, WATER_CLASS_CANAL);

   181

	} else {

   182

		SetWaterClass(t, WATER_CLASS_SEA);

   183

	}

   184

}

   185

   186

   187

/** Build a ship depot.

   188

 * @param tile tile where ship depot is built

   189

 * @param flags type of operation

   190

 * @param p1 bit 0 depot orientation (Axis)

   191

 * @param p2 unused

   192

 */

   193

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

   194

{

   195

	TileIndex tile2;

   196

   197

	CommandCost ret;

   198

   199

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

   200

   201

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

   202

   203

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

   204

		return_cmd_error(STR_3801_MUST_BE_BUILT_ON_WATER);

   205

	}

   206

   207

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

   208

   209

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

   210

		/* Prevent depots on rapids */

   211

		return_cmd_error(STR_0239_SITE_UNSUITABLE);

   212

	}

   213

   214

	WaterClass wc1 = GetWaterClass(tile);

   215

	WaterClass wc2 = GetWaterClass(tile2);

   216

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

   217

	if (CmdFailed(ret)) return CMD_ERROR;

   218

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

   219

	if (CmdFailed(ret)) return CMD_ERROR;

   220

   221

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

   222

   223

	if (flags & DC_EXEC) {

   224

		Depot *depot = new Depot(tile);

   225

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

   226

   227

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

   228

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

   229

		MarkTileDirtyByTile(tile);

   230

		MarkTileDirtyByTile(tile2);

   231

	}

   232

   233

	return CommandCost(EXPENSES_CONSTRUCTION, _price.build_ship_depot);

   234

}

   235

   236

void MakeWaterKeepingClass(TileIndex tile, Owner o)

   237

{

   238

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

   239

   240

	WaterClass wc = GetWaterClass(tile);

   241

   242

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

   243

	uint z;

   244

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

   245

   246

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

   247

   248

	switch (wc) {

   249

		case WATER_CLASS_SEA:   MakeWater(tile);              break;

   250

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

   251

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

   252

		default:                DoClearSquare(tile);          break;

   253

	}

   254

}

   255

   256

static CommandCost RemoveShipDepot(TileIndex tile, uint32 flags)

   257

{

   258

	if (!IsShipDepot(tile)) return CMD_ERROR;

   259

	if (!CheckTileOwnership(tile)) return CMD_ERROR;

   260

   261

	TileIndex tile2 = GetOtherShipDepotTile(tile);

   262

   263

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

   264

	if (!(flags & DC_BANKRUPT)) {

   265

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

   266

	}

   267

   268

	if (flags & DC_EXEC) {

   269

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

   270

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

   271

   272

		MakeWaterKeepingClass(tile,  GetTileOwner(tile));

   273

		MakeWaterKeepingClass(tile2, GetTileOwner(tile2));

   274

		MarkTileDirtyByTile(tile);

   275

		MarkTileDirtyByTile(tile2);

   276

	}

   277

   278

	return CommandCost(EXPENSES_CONSTRUCTION, _price.remove_ship_depot);

   279

}

   280

   281

/** build a shiplift */

   282

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

   283

{

   284

	CommandCost ret;

   285

	int delta;

   286

   287

	/* middle tile */

   288

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

   289

	if (CmdFailed(ret)) return CMD_ERROR;

   290

   291

	delta = TileOffsByDiagDir(dir);

   292

	/* lower tile */

   293

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

   294

   295

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

   296

	if (CmdFailed(ret)) return CMD_ERROR;

   297

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

   298

		return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   299

	}

   300

   301

	/* upper tile */

   302

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

   303

   304

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

   305

	if (CmdFailed(ret)) return CMD_ERROR;

   306

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

   307

		return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   308

	}

   309

   310

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

   311

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

   312

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

   313

		return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   314

	}

   315

   316

	if (flags & DC_EXEC) {

   317

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

   318

		MarkTileDirtyByTile(tile);

   319

		MarkTileDirtyByTile(tile - delta);

   320

		MarkTileDirtyByTile(tile + delta);

   321

		MarkCanalsAndRiversAroundDirty(tile - delta);

   322

		MarkCanalsAndRiversAroundDirty(tile + delta);

   323

	}

   324

   325

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

   326

}

   327

   328

static CommandCost RemoveShiplift(TileIndex tile, uint32 flags)

   329

{

   330

	TileIndexDiff delta = TileOffsByDiagDir(GetLockDirection(tile));

   331

   332

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

   333

   334

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

   335

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

   336

		return CMD_ERROR;

   337

   338

	if (flags & DC_EXEC) {

   339

		DoClearSquare(tile);

   340

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

   341

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

   342

		MarkTileDirtyByTile(tile - delta);

   343

		MarkTileDirtyByTile(tile + delta);

   344

		MarkCanalsAndRiversAroundDirty(tile - delta);

   345

		MarkCanalsAndRiversAroundDirty(tile + delta);

   346

	}

   347

   348

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

   349

}

   350

   351

/** Builds a lock (ship-lift)

   352

 * @param tile tile where to place the lock

   353

 * @param flags type of operation

   354

 * @param p1 unused

   355

 * @param p2 unused

   356

 */

   357

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

   358

{

   359

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

   360

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

   361

   362

	/* Disallow building of locks on river rapids */

   363

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

   364

   365

	return DoBuildShiplift(tile, dir, flags);

   366

}

   367

   368

/** Build a piece of canal.

   369

 * @param tile end tile of stretch-dragging

   370

 * @param flags type of operation

   371

 * @param p1 start tile of stretch-dragging

   372

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

   373

 */

   374

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

   375

{

   376

	CommandCost cost(EXPENSES_CONSTRUCTION);

   377

	int size_x, size_y;

   378

	int x;

   379

	int y;

   380

	int sx, sy;

   381

   382

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

   383

   384

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

   385

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

   386

   387

	x = TileX(tile);

   388

	y = TileY(tile);

   389

	sx = TileX(p1);

   390

	sy = TileY(p1);

   391

   392

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

   393

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

   394

	size_x = (x - sx) + 1;

   395

	size_y = (y - sy) + 1;

   396

   397

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

   398

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

   399

   400

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

   401

		CommandCost ret;

   402

   403

		Slope slope = GetTileSlope(tile, NULL);

   404

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

   405

			return_cmd_error(STR_0007_FLAT_LAND_REQUIRED);

   406

		}

   407

   408

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

   409

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

   410

   411

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

   412

		if (CmdFailed(ret)) return ret;

   413

		cost.AddCost(ret);

   414

   415

		if (flags & DC_EXEC) {

   416

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

   417

				MakeWater(tile);

   418

			} else if (p2 == 2) {

   419

				MakeRiver(tile, Random());

   420

			} else {

   421

				MakeCanal(tile, _current_company, Random());

   422

			}

   423

			MarkTileDirtyByTile(tile);

   424

			MarkCanalsAndRiversAroundDirty(tile);

   425

		}

   426

   427

		cost.AddCost(_price.clear_water);

   428

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

   429

   430

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

   431

		return_cmd_error(STR_1007_ALREADY_BUILT);

   432

	} else {

   433

		return cost;

   434

	}

   435

}

   436

   437

static CommandCost ClearTile_Water(TileIndex tile, byte flags)

   438

{

   439

	switch (GetWaterTileType(tile)) {

   440

		case WATER_TILE_CLEAR:

   441

			if (flags & DC_NO_WATER) return_cmd_error(STR_3807_CAN_T_BUILD_ON_WATER);

   442

   443

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

   444

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

   445

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

   446

				return_cmd_error(STR_0002_TOO_CLOSE_TO_EDGE_OF_MAP);

   447

			}

   448

   449

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

   450

			if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   451

   452

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

   453

   454

			if (flags & DC_EXEC) {

   455

				DoClearSquare(tile);

   456

				MarkCanalsAndRiversAroundDirty(tile);

   457

			}

   458

			return CommandCost(EXPENSES_CONSTRUCTION, _price.clear_water);

   459

   460

		case WATER_TILE_COAST: {

   461

			Slope slope = GetTileSlope(tile, NULL);

   462

   463

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

   464

			if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   465

   466

			if (flags & DC_EXEC) {

   467

				DoClearSquare(tile);

   468

				MarkCanalsAndRiversAroundDirty(tile);

   469

			}

   470

			if (IsSlopeWithOneCornerRaised(slope)) {

   471

				return CommandCost(EXPENSES_CONSTRUCTION, _price.clear_water);

   472

			} else {

   473

				return CommandCost(EXPENSES_CONSTRUCTION, _price.clear_roughland);

   474

			}

   475

		}

   476

   477

		case WATER_TILE_LOCK: {

   478

			static const TileIndexDiffC _shiplift_tomiddle_offs[] = {

   479

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

   480

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

   481

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

   482

			};

   483