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"

    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 "misc/autoptr.hpp"

    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

    39

#include "table/sprites.h"

    40

#include "table/strings.h"

    41

    42

/**

    43

 * Describes the behaviour of a tile during flooding.

    44

 */

    45

enum FloodingBehaviour {

    46

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

    47

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

    48

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

    49

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

    50

};

    51

    52

/**

    53

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

    54

 */

    55

static const uint8 _flood_from_dirs[] = {

    56

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

    57

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

    58

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

    59

	(1 << DIR_NE),                                                 // SLOPE_SW

    60

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

    61

	0,                                                             // SLOPE_EW

    62

	(1 << DIR_NW),                                                 // SLOPE_SE

    63

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

    64

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

    65

	(1 << DIR_SE),                                                 // SLOPE_NW

    66

	0,                                                             // SLOPE_NS

    67

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

    68

	(1 << DIR_SW),                                                 // SLOPE_NE

    69

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

    70

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

    71

};

    72

    73

/**

    74

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

    75

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

    76

 *

    77

 * @param tile tile to check

    78

 */

    79

static inline void MarkTileDirtyIfCanalOrRiver(TileIndex tile)

    80

{

    81

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

    82

}

    83

    84

/**

    85

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

    86

 *

    87

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

    88

 * @ingroup dirty

    89

 */

    90

static void MarkCanalsAndRiversAroundDirty(TileIndex tile)

    91

{

    92

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

    93

		MarkTileDirtyIfCanalOrRiver(tile + TileOffsByDir(dir));

    94

	}

    95

}

    96

    97

/**

    98

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

    99

 *

   100

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

   101

 *

   102

 * This as for example docks and shipdepots do not store

   103

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

   104

 * @param t the tile to change.

   105

 * @param o the owner of the new tile.

   106

 */

   107

void SetWaterClassDependingOnSurroundings(TileIndex t)

   108

{

   109

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

   110

   111

	/* Mark tile dirty in all cases */

   112

	MarkTileDirtyByTile(t);

   113

   114

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

   115

		/* tiles at map borders are always WATER_CLASS_SEA */

   116

		SetWaterClass(t, WATER_CLASS_SEA);

   117

		return;

   118

	}

   119

   120

	bool has_water = false;

   121

	bool has_canal = false;

   122

	bool has_river = false;

   123

   124

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

   125

		TileIndex neighbour = TileAddByDiagDir(t, dir);

   126

		switch (GetTileType(neighbour)) {

   127

			case MP_WATER:

   128

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

   129

				if (IsCoast(neighbour)) {

   130

					has_water = true;

   131

				} else if (!IsLock(neighbour)) {

   132

					switch (GetWaterClass(neighbour)) {

   133

						case WATER_CLASS_SEA:   has_water = true; break;

   134

						case WATER_CLASS_CANAL: has_canal = true; break;

   135

						case WATER_CLASS_RIVER: has_river = true; break;

   136

						default: NOT_REACHED();

   137

					}

   138

				}

   139

				break;

   140

   141

			case MP_RAILWAY:

   142

				/* Shore or flooded halftile */

   143

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

   144

				break;

   145

   146

			case MP_TREES:

   147

				/* trees on shore */

   148

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

   149

				break;

   150

   151

			default: break;

   152

		}

   153

	}

   154

   155

	if (has_river && !has_canal) {

   156

		SetWaterClass(t, WATER_CLASS_RIVER);

   157

	} else if (has_canal || !has_water) {

   158

		SetWaterClass(t, WATER_CLASS_CANAL);

   159

	} else {

   160

		SetWaterClass(t, WATER_CLASS_SEA);

   161

	}

   162

}

   163

   164

   165

/** Build a ship depot.

   166

 * @param tile tile where ship depot is built

   167

 * @param flags type of operation

   168

 * @param p1 bit 0 depot orientation (Axis)

   169

 * @param p2 unused

   170

 */

   171

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

   172

{

   173

	TileIndex tile2;

   174

   175

	CommandCost ret;

   176

   177

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

   178

   179

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

   180

   181

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

   182

		return_cmd_error(STR_3801_MUST_BE_BUILT_ON_WATER);

   183

	}

   184

   185

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

   186

   187

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

   188

		/* Prevent depots on rapids */

   189

		return_cmd_error(STR_0239_SITE_UNSUITABLE);

   190

	}

   191

   192

	WaterClass wc1 = GetWaterClass(tile);

   193

	WaterClass wc2 = GetWaterClass(tile2);

   194

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

   195

	if (CmdFailed(ret)) return CMD_ERROR;

   196

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

   197

	if (CmdFailed(ret)) return CMD_ERROR;

   198

   199

	Depot *depot = new Depot(tile);

   200

	if (depot == NULL) return CMD_ERROR;

   201

	AutoPtrT<Depot> d_auto_delete = depot;

   202

   203

	if (flags & DC_EXEC) {

   204

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

   205

   206

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

   207

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

   208

		MarkTileDirtyByTile(tile);

   209

		MarkTileDirtyByTile(tile2);

   210

		d_auto_delete.Detach();

   211

	}

   212

   213

	return CommandCost(EXPENSES_CONSTRUCTION, _price.build_ship_depot);

   214

}

   215

   216

void MakeWaterKeepingClass(TileIndex tile, Owner o)

   217

{

   218

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

   219

   220

	switch (GetWaterClass(tile)) {

   221

		case WATER_CLASS_SEA:   MakeWater(tile);              break;

   222

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

   223

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

   224

	}

   225

}

   226

   227

static CommandCost RemoveShipDepot(TileIndex tile, uint32 flags)

   228

{

   229

	if (!IsShipDepot(tile)) return CMD_ERROR;

   230

	if (!CheckTileOwnership(tile)) return CMD_ERROR;

   231

   232

	TileIndex tile2 = GetOtherShipDepotTile(tile);

   233

   234

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

   235

	if (!(flags & DC_BANKRUPT)) {

   236

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

   237

	}

   238

   239

	if (flags & DC_EXEC) {

   240

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

   241

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

   242

   243

		MakeWaterKeepingClass(tile,  GetTileOwner(tile));

   244

		MakeWaterKeepingClass(tile2, GetTileOwner(tile2));

   245

		MarkTileDirtyByTile(tile);

   246

		MarkTileDirtyByTile(tile2);

   247

	}

   248

   249

	return CommandCost(EXPENSES_CONSTRUCTION, _price.remove_ship_depot);

   250

}

   251

   252

/** build a shiplift */

   253

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

   254

{

   255

	CommandCost ret;

   256

	int delta;

   257

   258

	/* middle tile */

   259

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

   260

	if (CmdFailed(ret)) return CMD_ERROR;

   261

   262

	delta = TileOffsByDiagDir(dir);

   263

	/* lower tile */

   264

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

   265

   266

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

   267

	if (CmdFailed(ret)) return CMD_ERROR;

   268

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

   269

		return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   270

	}

   271

   272

	/* upper tile */

   273

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

   274

   275

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

   276

	if (CmdFailed(ret)) return CMD_ERROR;

   277

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

   278

		return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   279

	}

   280

   281

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

   282

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

   283

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

   284

		return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   285

	}

   286

   287

	if (flags & DC_EXEC) {

   288

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

   289

		MarkTileDirtyByTile(tile);

   290

		MarkTileDirtyByTile(tile - delta);

   291

		MarkTileDirtyByTile(tile + delta);

   292

		MarkCanalsAndRiversAroundDirty(tile - delta);

   293

		MarkCanalsAndRiversAroundDirty(tile + delta);

   294

	}

   295

   296

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

   297

}

   298

   299

static CommandCost RemoveShiplift(TileIndex tile, uint32 flags)

   300

{

   301

	TileIndexDiff delta = TileOffsByDiagDir(GetLockDirection(tile));

   302

   303

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

   304

   305

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

   306

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

   307

		return CMD_ERROR;

   308

   309

	if (flags & DC_EXEC) {

   310

		DoClearSquare(tile);

   311

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

   312

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

   313

		MarkTileDirtyByTile(tile - delta);

   314

		MarkTileDirtyByTile(tile + delta);

   315

		MarkCanalsAndRiversAroundDirty(tile - delta);

   316

		MarkCanalsAndRiversAroundDirty(tile + delta);

   317

	}

   318

   319

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

   320

}

   321

   322

/** Builds a lock (ship-lift)

   323

 * @param tile tile where to place the lock

   324

 * @param flags type of operation

   325

 * @param p1 unused

   326

 * @param p2 unused

   327

 */

   328

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

   329

{

   330

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

   331

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

   332

   333

	/* Disallow building of locks on river rapids */

   334

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

   335

   336

	return DoBuildShiplift(tile, dir, flags);

   337

}

   338

   339

/** Build a piece of canal.

   340

 * @param tile end tile of stretch-dragging

   341

 * @param flags type of operation

   342

 * @param p1 start tile of stretch-dragging

   343

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

   344

 */

   345

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

   346

{

   347

	CommandCost cost(EXPENSES_CONSTRUCTION);

   348

	int size_x, size_y;

   349

	int x;

   350

	int y;

   351

	int sx, sy;

   352

   353

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

   354

   355

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

   356

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

   357

   358

	x = TileX(tile);

   359

	y = TileY(tile);

   360

	sx = TileX(p1);

   361

	sy = TileY(p1);

   362

   363

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

   364

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

   365

	size_x = (x - sx) + 1;

   366

	size_y = (y - sy) + 1;

   367

   368

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

   369

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

   370

   371

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

   372

		CommandCost ret;

   373

   374

		Slope slope = GetTileSlope(tile, NULL);

   375

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

   376

			return_cmd_error(STR_0007_FLAT_LAND_REQUIRED);

   377

		}

   378

   379

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

   380

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

   381

   382

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

   383

		if (CmdFailed(ret)) return ret;

   384

		cost.AddCost(ret);

   385

   386

		if (flags & DC_EXEC) {

   387

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

   388

				MakeWater(tile);

   389

			} else if (p2 == 2) {

   390

				MakeRiver(tile, Random());

   391

			} else {

   392

				MakeCanal(tile, _current_player, Random());

   393

			}

   394

			MarkTileDirtyByTile(tile);

   395

			MarkCanalsAndRiversAroundDirty(tile);

   396

		}

   397

   398

		cost.AddCost(_price.clear_water);

   399

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

   400

   401

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

   402

		return_cmd_error(STR_1007_ALREADY_BUILT);

   403

	} else {

   404

		return cost;

   405

	}

   406

}

   407

   408

static CommandCost ClearTile_Water(TileIndex tile, byte flags)

   409

{

   410

	switch (GetWaterTileType(tile)) {

   411

		case WATER_TILE_CLEAR:

   412

			if (flags & DC_NO_WATER) return_cmd_error(STR_3807_CAN_T_BUILD_ON_WATER);

   413

   414

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

   415

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

   416

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

   417

				return_cmd_error(STR_0002_TOO_CLOSE_TO_EDGE_OF_MAP);

   418

			}

   419

   420

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

   421

			if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   422

   423

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

   424

   425

			if (flags & DC_EXEC) {

   426

				DoClearSquare(tile);

   427

				MarkCanalsAndRiversAroundDirty(tile);

   428

			}

   429

			return CommandCost(EXPENSES_CONSTRUCTION, _price.clear_water);

   430

   431

		case WATER_TILE_COAST: {

   432

			Slope slope = GetTileSlope(tile, NULL);

   433

   434

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

   435

			if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   436

   437

			if (flags & DC_EXEC) {

   438

				DoClearSquare(tile);

   439

				MarkCanalsAndRiversAroundDirty(tile);

   440

			}

   441

			if (IsSlopeWithOneCornerRaised(slope)) {

   442

				return CommandCost(EXPENSES_CONSTRUCTION, _price.clear_water);

   443

			} else {

   444

				return CommandCost(EXPENSES_CONSTRUCTION, _price.clear_roughland);

   445

			}

   446

		}

   447

   448

		case WATER_TILE_LOCK: {

   449

			static const TileIndexDiffC _shiplift_tomiddle_offs[] = {

   450

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

   451

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

   452

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

   453

			};

   454

   455

			if (flags & DC_AUTO) return_cmd_error(STR_2004_BUILDING_MUST_BE_DEMOLISHED);

   456

			if (_current_player == OWNER_WATER) return CMD_ERROR;

   457

			/* move to the middle tile.. */

   458

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

   459

		}

   460

   461

		case WATER_TILE_DEPOT:

   462

			if (flags & DC_AUTO) return_cmd_error(STR_2004_BUILDING_MUST_BE_DEMOLISHED);

   463

			return RemoveShipDepot(tile, flags);

   464

   465

		default:

   466

			NOT_REACHED();

   467

	}

   468

}

   469

   470

/**

   471

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

   472

 *

   473

 * @param tile The tile of interest.

   474

 * @param from The direction of interest.

   475

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

   476

 *

   477

 */

   478

static bool IsWateredTile(TileIndex tile, Direction from)

   479

{

   480

	switch (GetTileType(tile)) {

   481

		case MP_WATER:

   482

			if (!IsCoast(tile)) return true;

   483

			switch (GetTileSlope(tile, NULL)) {

   484

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