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"

    16

#include "news.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

	bool has_water = false;

   115

	bool has_canal = false;

   116

	bool has_river = false;

   117

   118

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

   119

		TileIndex neighbour = TileAddByDiagDir(t, dir);

   120

		switch (GetTileType(neighbour)) {

   121

			case MP_WATER:

   122

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

   123

				if (IsCoast(neighbour)) {

   124

					has_water = true;

   125

				} else if (!IsLock(neighbour)) {

   126

					switch (GetWaterClass(neighbour)) {

   127

						case WATER_CLASS_SEA:   has_water = true; break;

   128

						case WATER_CLASS_CANAL: has_canal = true; break;

   129

						case WATER_CLASS_RIVER: has_river = true; break;

   130

						default: NOT_REACHED();

   131

					}

   132

				}

   133

				break;

   134

   135

			case MP_RAILWAY:

   136

				/* Shore or flooded halftile */

   137

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

   138

				break;

   139

   140

			case MP_TREES:

   141

				/* trees on shore */

   142

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

   143

				break;

   144

   145

			default: break;

   146

		}

   147

	}

   148

   149

	if (has_river && !has_canal) {

   150

		SetWaterClass(t, WATER_CLASS_RIVER);

   151

	} else if (has_canal || !has_water) {

   152

		SetWaterClass(t, WATER_CLASS_CANAL);

   153

	} else {

   154

		SetWaterClass(t, WATER_CLASS_SEA);

   155

	}

   156

}

   157

   158

   159

/** Build a ship depot.

   160

 * @param tile tile where ship depot is built

   161

 * @param flags type of operation

   162

 * @param p1 bit 0 depot orientation (Axis)

   163

 * @param p2 unused

   164

 */

   165

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

   166

{

   167

	TileIndex tile2;

   168

   169

	CommandCost ret;

   170

   171

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

   172

   173

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

   174

   175

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

   176

		return_cmd_error(STR_3801_MUST_BE_BUILT_ON_WATER);

   177

	}

   178

   179

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

   180

   181

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

   182

		/* Prevent depots on rapids */

   183

		return_cmd_error(STR_0239_SITE_UNSUITABLE);

   184

	}

   185

   186

	WaterClass wc1 = GetWaterClass(tile);

   187

	WaterClass wc2 = GetWaterClass(tile2);

   188

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

   189

	if (CmdFailed(ret)) return CMD_ERROR;

   190

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

   191

	if (CmdFailed(ret)) return CMD_ERROR;

   192

   193

	Depot *depot = new Depot(tile);

   194

	if (depot == NULL) return CMD_ERROR;

   195

	AutoPtrT<Depot> d_auto_delete = depot;

   196

   197

	if (flags & DC_EXEC) {

   198

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

   199

   200

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

   201

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

   202

		MarkTileDirtyByTile(tile);

   203

		MarkTileDirtyByTile(tile2);

   204

		d_auto_delete.Detach();

   205

	}

   206

   207

	return CommandCost(EXPENSES_CONSTRUCTION, _price.build_ship_depot);

   208

}

   209

   210

void MakeWaterKeepingClass(TileIndex tile, Owner o)

   211

{

   212

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

   213

   214

	switch (GetWaterClass(tile)) {

   215

		case WATER_CLASS_SEA:   MakeWater(tile);              break;

   216

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

   217

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

   218

	}

   219

}

   220

   221

static CommandCost RemoveShipDepot(TileIndex tile, uint32 flags)

   222

{

   223

	TileIndex tile2;

   224

   225

	if (!IsShipDepot(tile)) return CMD_ERROR;

   226

	if (!CheckTileOwnership(tile)) return CMD_ERROR;

   227

	if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   228

   229

	tile2 = GetOtherShipDepotTile(tile);

   230

   231

	if (!EnsureNoVehicleOnGround(tile2)) return CMD_ERROR;

   232

   233

	if (flags & DC_EXEC) {

   234

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

   235

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

   236

   237

		MakeWaterKeepingClass(tile,  GetTileOwner(tile));

   238

		MakeWaterKeepingClass(tile2, GetTileOwner(tile2));

   239

		MarkTileDirtyByTile(tile);

   240

		MarkTileDirtyByTile(tile2);

   241

	}

   242

   243

	return CommandCost(EXPENSES_CONSTRUCTION, _price.remove_ship_depot);

   244

}

   245

   246

/** build a shiplift */

   247

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

   248

{

   249

	CommandCost ret;

   250

	int delta;

   251

   252

	/* middle tile */

   253

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

   254

	if (CmdFailed(ret)) return CMD_ERROR;

   255

   256

	delta = TileOffsByDiagDir(dir);

   257

	/* lower tile */

   258

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

   259

   260

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

   261

	if (CmdFailed(ret)) return CMD_ERROR;

   262

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

   263

		return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   264

	}

   265

   266

	/* upper tile */

   267

	WaterClass wc_upper = 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

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

   276

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

   277

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

   278

		return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   279

	}

   280

   281

	if (flags & DC_EXEC) {

   282

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

   283

		MarkTileDirtyByTile(tile);

   284

		MarkTileDirtyByTile(tile - delta);

   285

		MarkTileDirtyByTile(tile + delta);

   286

		MarkCanalsAndRiversAroundDirty(tile - delta);

   287

		MarkCanalsAndRiversAroundDirty(tile + delta);

   288

	}

   289

   290

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

   291

}

   292

   293

static CommandCost RemoveShiplift(TileIndex tile, uint32 flags)

   294

{

   295

	TileIndexDiff delta = TileOffsByDiagDir(GetLockDirection(tile));

   296

   297

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

   298

   299

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

   300

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

   301

		return CMD_ERROR;

   302

   303

	if (flags & DC_EXEC) {

   304

		DoClearSquare(tile);

   305

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

   306

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

   307

		MarkTileDirtyByTile(tile - delta);

   308

		MarkTileDirtyByTile(tile + delta);

   309

		MarkCanalsAndRiversAroundDirty(tile - delta);

   310

		MarkCanalsAndRiversAroundDirty(tile + delta);

   311

	}

   312

   313

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

   314

}

   315

   316

/** Builds a lock (ship-lift)

   317

 * @param tile tile where to place the lock

   318

 * @param flags type of operation

   319

 * @param p1 unused

   320

 * @param p2 unused

   321

 */

   322

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

   323

{

   324

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

   325

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

   326

   327

	/* Disallow building of locks on river rapids */

   328

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

   329

   330

	return DoBuildShiplift(tile, dir, flags);

   331

}

   332

   333

/** Build a piece of canal.

   334

 * @param tile end tile of stretch-dragging

   335

 * @param flags type of operation

   336

 * @param p1 start tile of stretch-dragging

   337

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

   338

 */

   339

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

   340

{

   341

	CommandCost cost(EXPENSES_CONSTRUCTION);

   342

	int size_x, size_y;

   343

	int x;

   344

	int y;

   345

	int sx, sy;

   346

   347

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

   348

   349

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

   350

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

   351

   352

	x = TileX(tile);

   353

	y = TileY(tile);

   354

	sx = TileX(p1);

   355

	sy = TileY(p1);

   356

   357

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

   358

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

   359

	size_x = (x - sx) + 1;

   360

	size_y = (y - sy) + 1;

   361

   362

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

   363

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

   364

   365

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

   366

		CommandCost ret;

   367

   368

		Slope slope = GetTileSlope(tile, NULL);

   369

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

   370

			return_cmd_error(STR_0007_FLAT_LAND_REQUIRED);

   371

		}

   372

   373

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

   374

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

   375

   376

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

   377

		if (CmdFailed(ret)) return ret;

   378

		cost.AddCost(ret);

   379

   380

		if (flags & DC_EXEC) {

   381

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

   382

				MakeWater(tile);

   383

			} else if (p2 == 2) {

   384

				MakeRiver(tile, Random());

   385

			} else {

   386

				MakeCanal(tile, _current_player, Random());

   387

			}

   388

			MarkTileDirtyByTile(tile);

   389

			MarkCanalsAndRiversAroundDirty(tile);

   390

		}

   391

   392

		cost.AddCost(_price.clear_water);

   393

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

   394

   395

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

   396

		return_cmd_error(STR_1007_ALREADY_BUILT);

   397

	} else {

   398

		return cost;

   399

	}

   400

}

   401

   402

static CommandCost ClearTile_Water(TileIndex tile, byte flags)

   403

{

   404

	switch (GetWaterTileType(tile)) {

   405

		case WATER_TILE_CLEAR:

   406

			if (flags & DC_NO_WATER) return_cmd_error(STR_3807_CAN_T_BUILD_ON_WATER);

   407

   408

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

   409

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

   410

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

   411

				return_cmd_error(STR_0002_TOO_CLOSE_TO_EDGE_OF_MAP);

   412

			}

   413

   414

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

   415

			if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   416

   417

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

   418

   419

			if (flags & DC_EXEC) {

   420

				DoClearSquare(tile);

   421

				MarkCanalsAndRiversAroundDirty(tile);

   422

			}

   423

			return CommandCost(EXPENSES_CONSTRUCTION, _price.clear_water);

   424

   425

		case WATER_TILE_COAST: {

   426

			Slope slope = GetTileSlope(tile, NULL);

   427

   428

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

   429

			if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   430

   431

			if (flags & DC_EXEC) {

   432

				DoClearSquare(tile);

   433

				MarkCanalsAndRiversAroundDirty(tile);

   434

			}

   435

			if (IsSlopeWithOneCornerRaised(slope)) {

   436

				return CommandCost(EXPENSES_CONSTRUCTION, _price.clear_water);

   437

			} else {

   438

				return CommandCost(EXPENSES_CONSTRUCTION, _price.clear_roughland);

   439

			}

   440

		}

   441

   442

		case WATER_TILE_LOCK: {

   443

			static const TileIndexDiffC _shiplift_tomiddle_offs[] = {

   444

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

   445

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

   446

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

   447

			};

   448

   449

			if (flags & DC_AUTO) return_cmd_error(STR_2004_BUILDING_MUST_BE_DEMOLISHED);

   450

			if (_current_player == OWNER_WATER) return CMD_ERROR;

   451

			/* move to the middle tile.. */

   452

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

   453

		}

   454

   455

		case WATER_TILE_DEPOT:

   456

			if (flags & DC_AUTO) return_cmd_error(STR_2004_BUILDING_MUST_BE_DEMOLISHED);

   457

			return RemoveShipDepot(tile, flags);

   458

   459

		default:

   460

			NOT_REACHED();

   461

	}

   462

}

   463

   464

/**

   465

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

   466

 *

   467

 * @param tile The tile of interest.

   468

 * @param from The direction of interest.

   469

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

   470

 *

   471

 */

   472

static bool IsWateredTile(TileIndex tile, Direction from)

   473

{

   474

	switch (GetTileType(tile)) {

   475

		case MP_WATER:

   476

			if (!IsCoast(tile)) return true;

   477

			switch (GetTileSlope(tile, NULL)) {

   478

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

   479

				case SLOPE_S: return (from == DIR_NE) || (from == DIR_N) || (from == DIR_NW);

   480

				case SLOPE_E: return (from == DIR_NW) || (from == DIR_W) || (from == DIR_SW);

   481

				case SLOPE_N: return (from == DIR_SW) || (from == DIR_S) || (from == DIR_SE);

   482

				default: return false;

   483

			}