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"

    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

 */

   113

void SetWaterClassDependingOnSurroundings(TileIndex t)

   114

{

   115

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

   116

   117

	/* Mark tile dirty in all cases */

   118

	MarkTileDirtyByTile(t);

   119

   120

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

   121

		/* tiles at map borders are always WATER_CLASS_SEA */

   122

		SetWaterClass(t, WATER_CLASS_SEA);

   123

		return;

   124

	}

   125

   126

	bool has_water = false;

   127

	bool has_canal = false;

   128

	bool has_river = false;

   129

   130

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

   131

		TileIndex neighbour = TileAddByDiagDir(t, dir);

   132

		switch (GetTileType(neighbour)) {

   133

			case MP_WATER:

   134

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

   135

				if (IsCoast(neighbour)) {

   136

					has_water = true;

   137

				} else if (!IsLock(neighbour)) {

   138

					switch (GetWaterClass(neighbour)) {

   139

						case WATER_CLASS_SEA:   has_water = true; break;

   140

						case WATER_CLASS_CANAL: has_canal = true; break;

   141

						case WATER_CLASS_RIVER: has_river = true; break;

   142

						default: NOT_REACHED();

   143

					}

   144

				}

   145

				break;

   146

   147

			case MP_RAILWAY:

   148

				/* Shore or flooded halftile */

   149

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

   150

				break;

   151

   152

			case MP_TREES:

   153

				/* trees on shore */

   154

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

   155

				break;

   156

   157

			default: break;

   158

		}

   159

	}

   160

   161

	if (has_river && !has_canal) {

   162

		SetWaterClass(t, WATER_CLASS_RIVER);

   163

	} else if (has_canal || !has_water) {

   164

		SetWaterClass(t, WATER_CLASS_CANAL);

   165

	} else {

   166

		SetWaterClass(t, WATER_CLASS_SEA);

   167

	}

   168

}

   169

   170

   171

/** Build a ship depot.

   172

 * @param tile tile where ship depot is built

   173

 * @param flags type of operation

   174

 * @param p1 bit 0 depot orientation (Axis)

   175

 * @param p2 unused

   176

 */

   177

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

   178

{

   179

	TileIndex tile2;

   180

   181

	CommandCost ret;

   182

   183

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

   184

   185

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

   186

   187

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

   188

		return_cmd_error(STR_3801_MUST_BE_BUILT_ON_WATER);

   189

	}

   190

   191

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

   192

   193

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

   194

		/* Prevent depots on rapids */

   195

		return_cmd_error(STR_0239_SITE_UNSUITABLE);

   196

	}

   197

   198

	WaterClass wc1 = GetWaterClass(tile);

   199

	WaterClass wc2 = GetWaterClass(tile2);

   200

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

   201

	if (CmdFailed(ret)) return CMD_ERROR;

   202

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

   203

	if (CmdFailed(ret)) return CMD_ERROR;

   204

   205

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

   206

   207

	if (flags & DC_EXEC) {

   208

		Depot *depot = new Depot(tile);

   209

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

   210

   211

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

   212

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

   213

		MarkTileDirtyByTile(tile);

   214

		MarkTileDirtyByTile(tile2);

   215

	}

   216

   217

	return CommandCost(EXPENSES_CONSTRUCTION, _price.build_ship_depot);

   218

}

   219

   220

void MakeWaterKeepingClass(TileIndex tile, Owner o)

   221

{

   222

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

   223

   224

	switch (GetWaterClass(tile)) {

   225

		case WATER_CLASS_SEA:   MakeWater(tile);              break;

   226

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

   227

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

   228

	}

   229

}

   230

   231

static CommandCost RemoveShipDepot(TileIndex tile, uint32 flags)

   232

{

   233

	if (!IsShipDepot(tile)) return CMD_ERROR;

   234

	if (!CheckTileOwnership(tile)) return CMD_ERROR;

   235

   236

	TileIndex tile2 = GetOtherShipDepotTile(tile);

   237

   238

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

   239

	if (!(flags & DC_BANKRUPT)) {

   240

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

   241

	}

   242

   243

	if (flags & DC_EXEC) {

   244

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

   245

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

   246

   247

		MakeWaterKeepingClass(tile,  GetTileOwner(tile));

   248

		MakeWaterKeepingClass(tile2, GetTileOwner(tile2));

   249

		MarkTileDirtyByTile(tile);

   250

		MarkTileDirtyByTile(tile2);

   251

	}

   252

   253

	return CommandCost(EXPENSES_CONSTRUCTION, _price.remove_ship_depot);

   254

}

   255

   256

/** build a shiplift */

   257

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

   258

{

   259

	CommandCost ret;

   260

	int delta;

   261

   262

	/* middle tile */

   263

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

   264

	if (CmdFailed(ret)) return CMD_ERROR;

   265

   266

	delta = TileOffsByDiagDir(dir);

   267

	/* lower tile */

   268

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

   269

   270

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

   271

	if (CmdFailed(ret)) return CMD_ERROR;

   272

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

   273

		return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   274

	}

   275

   276

	/* upper tile */

   277

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

   278

   279

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

   280

	if (CmdFailed(ret)) return CMD_ERROR;

   281

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

   282

		return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   283

	}

   284

   285

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

   286

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

   287

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

   288

		return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   289

	}

   290

   291

	if (flags & DC_EXEC) {

   292

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

   293

		MarkTileDirtyByTile(tile);

   294

		MarkTileDirtyByTile(tile - delta);

   295

		MarkTileDirtyByTile(tile + delta);

   296

		MarkCanalsAndRiversAroundDirty(tile - delta);

   297

		MarkCanalsAndRiversAroundDirty(tile + delta);

   298

	}

   299

   300

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

   301

}

   302

   303

static CommandCost RemoveShiplift(TileIndex tile, uint32 flags)

   304

{

   305

	TileIndexDiff delta = TileOffsByDiagDir(GetLockDirection(tile));

   306

   307

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

   308

   309

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

   310

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

   311

		return CMD_ERROR;

   312

   313

	if (flags & DC_EXEC) {

   314

		DoClearSquare(tile);

   315

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

   316

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

   317

		MarkTileDirtyByTile(tile - delta);

   318

		MarkTileDirtyByTile(tile + delta);

   319

		MarkCanalsAndRiversAroundDirty(tile - delta);

   320

		MarkCanalsAndRiversAroundDirty(tile + delta);

   321

	}

   322

   323

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

   324

}

   325

   326

/** Builds a lock (ship-lift)

   327

 * @param tile tile where to place the lock

   328

 * @param flags type of operation

   329

 * @param p1 unused

   330

 * @param p2 unused

   331

 */

   332

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

   333

{

   334

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

   335

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

   336

   337

	/* Disallow building of locks on river rapids */

   338

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

   339

   340

	return DoBuildShiplift(tile, dir, flags);

   341

}

   342

   343

/** Build a piece of canal.

   344

 * @param tile end tile of stretch-dragging

   345

 * @param flags type of operation

   346

 * @param p1 start tile of stretch-dragging

   347

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

   348

 */

   349

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

   350

{

   351

	CommandCost cost(EXPENSES_CONSTRUCTION);

   352

	int size_x, size_y;

   353

	int x;

   354

	int y;

   355

	int sx, sy;

   356

   357

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

   358

   359

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

   360

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

   361

   362

	x = TileX(tile);

   363

	y = TileY(tile);

   364

	sx = TileX(p1);

   365

	sy = TileY(p1);

   366

   367

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

   368

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

   369

	size_x = (x - sx) + 1;

   370

	size_y = (y - sy) + 1;

   371

   372

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

   373

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

   374

   375

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

   376

		CommandCost ret;

   377

   378

		Slope slope = GetTileSlope(tile, NULL);

   379

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

   380

			return_cmd_error(STR_0007_FLAT_LAND_REQUIRED);

   381

		}

   382

   383

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

   384

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

   385

   386

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

   387

		if (CmdFailed(ret)) return ret;

   388

		cost.AddCost(ret);

   389

   390

		if (flags & DC_EXEC) {

   391

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

   392

				MakeWater(tile);

   393

			} else if (p2 == 2) {

   394

				MakeRiver(tile, Random());

   395

			} else {

   396

				MakeCanal(tile, _current_player, Random());

   397

			}

   398

			MarkTileDirtyByTile(tile);

   399

			MarkCanalsAndRiversAroundDirty(tile);

   400

		}

   401

   402

		cost.AddCost(_price.clear_water);

   403

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

   404

   405

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

   406

		return_cmd_error(STR_1007_ALREADY_BUILT);

   407

	} else {

   408

		return cost;

   409

	}

   410

}

   411

   412

static CommandCost ClearTile_Water(TileIndex tile, byte flags)

   413

{

   414

	switch (GetWaterTileType(tile)) {

   415

		case WATER_TILE_CLEAR:

   416

			if (flags & DC_NO_WATER) return_cmd_error(STR_3807_CAN_T_BUILD_ON_WATER);

   417

   418

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

   419

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

   420

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

   421

				return_cmd_error(STR_0002_TOO_CLOSE_TO_EDGE_OF_MAP);

   422

			}

   423

   424

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

   425

			if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   426

   427

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

   428

   429

			if (flags & DC_EXEC) {

   430

				DoClearSquare(tile);

   431

				MarkCanalsAndRiversAroundDirty(tile);

   432

			}

   433

			return CommandCost(EXPENSES_CONSTRUCTION, _price.clear_water);

   434

   435

		case WATER_TILE_COAST: {

   436

			Slope slope = GetTileSlope(tile, NULL);

   437

   438

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

   439

			if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   440

   441

			if (flags & DC_EXEC) {

   442

				DoClearSquare(tile);

   443

				MarkCanalsAndRiversAroundDirty(tile);

   444

			}

   445

			if (IsSlopeWithOneCornerRaised(slope)) {

   446

				return CommandCost(EXPENSES_CONSTRUCTION, _price.clear_water);

   447

			} else {

   448

				return CommandCost(EXPENSES_CONSTRUCTION, _price.clear_roughland);

   449

			}

   450

		}

   451

   452

		case WATER_TILE_LOCK: {

   453

			static const TileIndexDiffC _shiplift_tomiddle_offs[] = {

   454

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

   455

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

   456

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

   457

			};

   458

   459

			if (flags & DC_AUTO) return_cmd_error(STR_2004_BUILDING_MUST_BE_DEMOLISHED);

   460

			if (_current_player == OWNER_WATER) return CMD_ERROR;

   461

			/* move to the middle tile.. */

   462

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

   463

		}

   464

   465

		case WATER_TILE_DEPOT:

   466

			if (flags & DC_AUTO) return_cmd_error(STR_2004_BUILDING_MUST_BE_DEMOLISHED);

   467

			return RemoveShipDepot(tile, flags);

   468

   469

		default:

   470

			NOT_REACHED();

   471

	}

   472

}

   473

   474

/**

   475

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

   476

 *

   477

 * @param tile The tile of interest.

   478

 * @param from The direction of interest.

   479

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

   480

 *

   481

 */

   482

static bool IsWateredTile(TileIndex tile, Direction from)

   483

{

   484

	switch (GetTileType(tile)) {