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

 * This as for example docks and shipdepots do not store

   100

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

   101

 * @param t the tile to change.

   102

 * @param o the owner of the new tile.

   103

 */

   104

void MakeWaterOrCanalDependingOnSurroundings(TileIndex t, Owner o)

   105

{

   106

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

   107

   108

	/* Mark tile dirty in all cases */

   109

	MarkTileDirtyByTile(t);

   110

   111

	/* Non-sealevel -> canal */

   112

	if (TileHeight(t) != 0) {

   113

		MakeCanal(t, o, Random());

   114

		return;

   115

	}

   116

   117

	bool has_water = false;

   118

	bool has_canal = false;

   119

   120

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

   121

		TileIndex neighbour = TileAddByDiagDir(t, dir);

   122

		switch (GetTileType(neighbour)) {

   123

			case MP_WATER:

   124

				has_water |= IsSea(neighbour) || IsCoast(neighbour) || (IsShipDepot(neighbour) && GetShipDepotWaterOwner(neighbour) == OWNER_WATER);

   125

				has_canal |= IsCanal(neighbour) || (IsShipDepot(neighbour) && GetShipDepotWaterOwner(neighbour) != OWNER_WATER);

   126

				break;

   127

   128

			case MP_RAILWAY:

   129

				/* Shore or flooded halftile */

   130

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

   131

				break;

   132

   133

			case MP_TREES:

   134

				/* trees on shore */

   135

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

   136

				break;

   137

   138

			default: break;

   139

		}

   140

	}

   141

	if (has_canal || !has_water) {

   142

		MakeCanal(t, o, Random());

   143

	} else {

   144

		MakeWater(t);

   145

	}

   146

}

   147

   148

   149

/** Build a ship depot.

   150

 * @param tile tile where ship depot is built

   151

 * @param flags type of operation

   152

 * @param p1 bit 0 depot orientation (Axis)

   153

 * @param p2 unused

   154

 */

   155

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

   156

{

   157

	TileIndex tile2;

   158

   159

	CommandCost ret;

   160

   161

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

   162

   163

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

   164

   165

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

   166

		return_cmd_error(STR_3801_MUST_BE_BUILT_ON_WATER);

   167

   168

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

   169

   170

	Owner o1 = GetTileOwner(tile);

   171

	Owner o2 = GetTileOwner(tile2);

   172

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

   173

	if (CmdFailed(ret)) return CMD_ERROR;

   174

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

   175

	if (CmdFailed(ret)) return CMD_ERROR;

   176

   177

	Depot *depot = new Depot(tile);

   178

	if (depot == NULL) return CMD_ERROR;

   179

	AutoPtrT<Depot> d_auto_delete = depot;

   180

   181

	if (flags & DC_EXEC) {

   182

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

   183

   184

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

   185

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

   186

		MarkTileDirtyByTile(tile);

   187

		MarkTileDirtyByTile(tile2);

   188

		d_auto_delete.Detach();

   189

	}

   190

   191

	return CommandCost(EXPENSES_CONSTRUCTION, _price.build_ship_depot);

   192

}

   193

   194

void MakeWaterOrCanalDependingOnOwner(TileIndex tile, Owner o)

   195

{

   196

	if (o == OWNER_WATER) {

   197

		MakeWater(tile);

   198

	} else {

   199

		MakeCanal(tile, o, Random());

   200

	}

   201

}

   202

   203

static CommandCost RemoveShipDepot(TileIndex tile, uint32 flags)

   204

{

   205

	TileIndex tile2;

   206

   207

	if (!IsShipDepot(tile)) return CMD_ERROR;

   208

	if (!CheckTileOwnership(tile)) return CMD_ERROR;

   209

	if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   210

   211

	tile2 = GetOtherShipDepotTile(tile);

   212

   213

	if (!EnsureNoVehicleOnGround(tile2)) return CMD_ERROR;

   214

   215

	if (flags & DC_EXEC) {

   216

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

   217

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

   218

   219

		MakeWaterOrCanalDependingOnOwner(tile,  GetShipDepotWaterOwner(tile));

   220

		MakeWaterOrCanalDependingOnOwner(tile2, GetShipDepotWaterOwner(tile2));

   221

		MarkTileDirtyByTile(tile);

   222

		MarkTileDirtyByTile(tile2);

   223

	}

   224

   225

	return CommandCost(EXPENSES_CONSTRUCTION, _price.remove_ship_depot);

   226

}

   227

   228

/** build a shiplift */

   229

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

   230

{

   231

	CommandCost ret;

   232

	int delta;

   233

   234

	/* middle tile */

   235

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

   236

	if (CmdFailed(ret)) return CMD_ERROR;

   237

   238

	delta = TileOffsByDiagDir(dir);

   239

	/* lower tile */

   240

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

   241

	if (CmdFailed(ret)) return CMD_ERROR;

   242

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

   243

		return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   244

	}

   245

   246

	/* upper tile */

   247

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

   248

	if (CmdFailed(ret)) return CMD_ERROR;

   249

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

   250

		return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   251

	}

   252

   253

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

   254

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

   255

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

   256

		return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   257

	}

   258

   259

	if (flags & DC_EXEC) {

   260

		MakeLock(tile, _current_player, dir);

   261

		MarkTileDirtyByTile(tile);

   262

		MarkTileDirtyByTile(tile - delta);

   263

		MarkTileDirtyByTile(tile + delta);

   264

		MarkCanalsAndRiversAroundDirty(tile - delta);

   265

		MarkCanalsAndRiversAroundDirty(tile + delta);

   266

	}

   267

   268

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

   269

}

   270

   271

static CommandCost RemoveShiplift(TileIndex tile, uint32 flags)

   272

{

   273

	TileIndexDiff delta = TileOffsByDiagDir(GetLockDirection(tile));

   274

   275

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

   276

   277

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

   278

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

   279

		return CMD_ERROR;

   280

   281

	if (flags & DC_EXEC) {

   282

		DoClearSquare(tile);

   283

		MakeWaterOrCanalDependingOnSurroundings(tile + delta, _current_player);

   284

		MakeWaterOrCanalDependingOnSurroundings(tile - delta, _current_player);

   285

		MarkCanalsAndRiversAroundDirty(tile - delta);

   286

		MarkCanalsAndRiversAroundDirty(tile + delta);

   287

	}

   288

   289

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

   290

}

   291

   292

/** Builds a lock (ship-lift)

   293

 * @param tile tile where to place the lock

   294

 * @param flags type of operation

   295

 * @param p1 unused

   296

 * @param p2 unused

   297

 */

   298

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

   299

{

   300

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

   301

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

   302

   303

	/* Disallow building of locks on river rapids */

   304

	if (IsRiverTile(tile)) return_cmd_error(STR_0239_SITE_UNSUITABLE);

   305

   306

	return DoBuildShiplift(tile, dir, flags);

   307

}

   308

   309

/** Build a piece of canal.

   310

 * @param tile end tile of stretch-dragging

   311

 * @param flags type of operation

   312

 * @param p1 start tile of stretch-dragging

   313

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

   314

 */

   315

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

   316

{

   317

	CommandCost cost(EXPENSES_CONSTRUCTION);

   318

	int size_x, size_y;

   319

	int x;

   320

	int y;

   321

	int sx, sy;

   322

   323

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

   324

   325

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

   326

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

   327

   328

	x = TileX(tile);

   329

	y = TileY(tile);

   330

	sx = TileX(p1);

   331

	sy = TileY(p1);

   332

   333

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

   334

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

   335

	size_x = (x - sx) + 1;

   336

	size_y = (y - sy) + 1;

   337

   338

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

   339

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

   340

   341

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

   342

		CommandCost ret;

   343

   344

		Slope slope = GetTileSlope(tile, NULL);

   345

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

   346

			return_cmd_error(STR_0007_FLAT_LAND_REQUIRED);

   347

		}

   348

   349

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

   350

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

   351

   352

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

   353

		if (CmdFailed(ret)) return ret;

   354

		cost.AddCost(ret);

   355

   356

		if (flags & DC_EXEC) {

   357

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

   358

				MakeWater(tile);

   359

			} else if (p2 == 2) {

   360

				MakeRiver(tile, Random());

   361

			} else {

   362

				MakeCanal(tile, _current_player, Random());

   363

			}

   364

			MarkTileDirtyByTile(tile);

   365

			MarkCanalsAndRiversAroundDirty(tile);

   366

		}

   367

   368

		cost.AddCost(_price.clear_water);

   369

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

   370

   371

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

   372

		return_cmd_error(STR_1007_ALREADY_BUILT);

   373

	} else {

   374

		return cost;

   375

	}

   376

}

   377

   378

static CommandCost ClearTile_Water(TileIndex tile, byte flags)

   379

{

   380

	switch (GetWaterTileType(tile)) {

   381

		case WATER_TILE_CLEAR:

   382

		case WATER_TILE_RIVER:

   383

			if (flags & DC_NO_WATER) return_cmd_error(STR_3807_CAN_T_BUILD_ON_WATER);

   384

   385

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

   386

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

   387

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

   388

				return_cmd_error(STR_0002_TOO_CLOSE_TO_EDGE_OF_MAP);

   389

			}

   390

   391

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

   392

			if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   393

   394

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

   395

   396

			if (flags & DC_EXEC) {

   397

				DoClearSquare(tile);

   398

				MarkCanalsAndRiversAroundDirty(tile);

   399

			}

   400

			return CommandCost(EXPENSES_CONSTRUCTION, _price.clear_water);

   401

   402

		case WATER_TILE_COAST: {

   403

			Slope slope = GetTileSlope(tile, NULL);

   404

   405

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

   406

			if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   407

   408

			if (flags & DC_EXEC) {

   409

				DoClearSquare(tile);

   410

				MarkCanalsAndRiversAroundDirty(tile);

   411

			}

   412

			if (IsSlopeWithOneCornerRaised(slope)) {

   413

				return CommandCost(EXPENSES_CONSTRUCTION, _price.clear_water);

   414

			} else {

   415

				return CommandCost(EXPENSES_CONSTRUCTION, _price.clear_roughland);

   416

			}

   417

		}

   418

   419

		case WATER_TILE_LOCK: {

   420

			static const TileIndexDiffC _shiplift_tomiddle_offs[] = {

   421

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

   422

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

   423

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

   424

			};

   425

   426

			if (flags & DC_AUTO) return_cmd_error(STR_2004_BUILDING_MUST_BE_DEMOLISHED);

   427

			if (_current_player == OWNER_WATER) return CMD_ERROR;

   428

			/* move to the middle tile.. */

   429

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

   430

		}

   431

   432

		case WATER_TILE_DEPOT:

   433

			if (flags & DC_AUTO) return_cmd_error(STR_2004_BUILDING_MUST_BE_DEMOLISHED);

   434

			return RemoveShipDepot(tile, flags);

   435

   436

		default:

   437

			NOT_REACHED();

   438

	}

   439

}

   440

   441

/**

   442

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

   443

 *

   444

 * @param tile The tile of interest.

   445

 * @param from The direction of interest.

   446

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

   447

 *

   448

 */

   449

static bool IsWateredTile(TileIndex tile, Direction from)

   450

{

   451

	switch (GetTileType(tile)) {

   452

		case MP_WATER:

   453

			if (!IsCoast(tile)) return true;

   454

			switch (GetTileSlope(tile, NULL)) {

   455

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

   456

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

   457

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

   458

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

   459

				default: return false;

   460

			}

   461

   462

		case MP_RAILWAY:

   463

			if (GetRailGroundType(tile) == RAIL_GROUND_WATER) {

   464

				assert(IsPlainRailTile(tile));

   465

				switch (GetTileSlope(tile, NULL)) {

   466

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

   467

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

   468

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

   469

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

   470

					default: return false;

   471

				}

   472

			}

   473

			return false;

   474

   475

		case MP_STATION:  return IsOilRig(tile) || IsDock(tile) || IsBuoy(tile);

   476

		case MP_INDUSTRY: return (GetIndustrySpec(GetIndustryType(tile))->behaviour & INDUSTRYBEH_BUILT_ONWATER) != 0;

   477

		default:          return false;

   478

	}

   479

}

   480

   481

static void DrawWaterEdges(SpriteID base, TileIndex tile)

   482

{

   483

	uint wa;