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

    38

#include "table/sprites.h"

    39

#include "table/strings.h"

    40

    41

/**

    42

 * Describes the behaviour of a tile during flooding.

    43

 */

    44

enum FloodingBehaviour {

    45

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

    46

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

    47

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

    48

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

    49

};

    50

    51

/**

    52

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

    53

 */

    54

static const uint8 _flood_from_dirs[] = {

    55

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

    56

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

    57

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

    58

	(1 << DIR_NE),                                                 // SLOPE_SW

    59

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

    60

	0,                                                             // SLOPE_EW

    61

	(1 << DIR_NW),                                                 // SLOPE_SE

    62

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

    63

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

    64

	(1 << DIR_SE),                                                 // SLOPE_NW

    65

	0,                                                             // SLOPE_NS

    66

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

    67

	(1 << DIR_SW),                                                 // SLOPE_NE

    68

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

    69

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

    70

};

    71

    72

/**

    73

 * Slopes that contain flat water and not only shore.

    74

 */

    75

static const uint32 _active_water_slopes = (1 << SLOPE_FLAT) | (1 << SLOPE_W) | (1 << SLOPE_S) | (1 << SLOPE_E) | (1 << SLOPE_N);

    76

    77

/**

    78

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

    79

 * This as for example docks and shipdepots do not store

    80

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

    81

 * @param t the tile to change.

    82

 * @param o the owner of the new tile.

    83

 */

    84

void MakeWaterOrCanalDependingOnSurroundings(TileIndex t, Owner o)

    85

{

    86

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

    87

    88

	/* Mark tile dirty in all cases */

    89

	MarkTileDirtyByTile(t);

    90

    91

	/* Non-sealevel -> canal */

    92

	if (TileHeight(t) != 0) {

    93

		MakeCanal(t, o, Random());

    94

		return;

    95

	}

    96

    97

	bool has_water = false;

    98

	bool has_canal = false;

    99

   100

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

   101

		TileIndex neighbour = TileAddByDiagDir(t, dir);

   102

		if (IsTileType(neighbour, MP_WATER)) {

   103

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

   104

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

   105

		}

   106

	}

   107

	if (has_canal || !has_water) {

   108

		MakeCanal(t, o, Random());

   109

	} else {

   110

		MakeWater(t);

   111

	}

   112

}

   113

   114

   115

/** Build a ship depot.

   116

 * @param tile tile where ship depot is built

   117

 * @param flags type of operation

   118

 * @param p1 bit 0 depot orientation (Axis)

   119

 * @param p2 unused

   120

 */

   121

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

   122

{

   123

	TileIndex tile2;

   124

   125

	CommandCost ret;

   126

   127

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

   128

   129

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

   130

   131

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

   132

		return_cmd_error(STR_3801_MUST_BE_BUILT_ON_WATER);

   133

   134

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

   135

   136

	Owner o1 = GetTileOwner(tile);

   137

	Owner o2 = GetTileOwner(tile2);

   138

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

   139

	if (CmdFailed(ret)) return CMD_ERROR;

   140

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

   141

	if (CmdFailed(ret)) return CMD_ERROR;

   142

   143

	Depot *depot = new Depot(tile);

   144

	if (depot == NULL) return CMD_ERROR;

   145

	AutoPtrT<Depot> d_auto_delete = depot;

   146

   147

	if (flags & DC_EXEC) {

   148

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

   149

   150

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

   151

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

   152

		MarkTileDirtyByTile(tile);

   153

		MarkTileDirtyByTile(tile2);

   154

		d_auto_delete.Detach();

   155

	}

   156

   157

	return CommandCost(EXPENSES_CONSTRUCTION, _price.build_ship_depot);

   158

}

   159

   160

void MakeWaterOrCanalDependingOnOwner(TileIndex tile, Owner o)

   161

{

   162

	if (o == OWNER_WATER) {

   163

		MakeWater(tile);

   164

	} else {

   165

		MakeCanal(tile, o, Random());

   166

	}

   167

}

   168

   169

static CommandCost RemoveShipDepot(TileIndex tile, uint32 flags)

   170

{

   171

	TileIndex tile2;

   172

   173

	if (!IsShipDepot(tile)) return CMD_ERROR;

   174

	if (!CheckTileOwnership(tile)) return CMD_ERROR;

   175

	if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   176

   177

	tile2 = GetOtherShipDepotTile(tile);

   178

   179

	if (!EnsureNoVehicleOnGround(tile2)) return CMD_ERROR;

   180

   181

	if (flags & DC_EXEC) {

   182

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

   183

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

   184

   185

		MakeWaterOrCanalDependingOnOwner(tile,  GetShipDepotWaterOwner(tile));

   186

		MakeWaterOrCanalDependingOnOwner(tile2, GetShipDepotWaterOwner(tile2));

   187

		MarkTileDirtyByTile(tile);

   188

		MarkTileDirtyByTile(tile2);

   189

	}

   190

   191

	return CommandCost(EXPENSES_CONSTRUCTION, _price.remove_ship_depot);

   192

}

   193

   194

/** build a shiplift */

   195

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

   196

{

   197

	CommandCost ret;

   198

	int delta;

   199

   200

	/* middle tile */

   201

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

   202

	if (CmdFailed(ret)) return CMD_ERROR;

   203

   204

	delta = TileOffsByDiagDir(dir);

   205

	/* lower tile */

   206

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

   207

	if (CmdFailed(ret)) return CMD_ERROR;

   208

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

   209

		return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   210

	}

   211

   212

	/* upper tile */

   213

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

   214

	if (CmdFailed(ret)) return CMD_ERROR;

   215

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

   216

		return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   217

	}

   218

   219

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

   220

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

   221

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

   222

		return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   223

	}

   224

   225

	if (flags & DC_EXEC) {

   226

		MakeLock(tile, _current_player, dir);

   227

		MarkTileDirtyByTile(tile);

   228

		MarkTileDirtyByTile(tile - delta);

   229

		MarkTileDirtyByTile(tile + delta);

   230

	}

   231

   232

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

   233

}

   234

   235

static CommandCost RemoveShiplift(TileIndex tile, uint32 flags)

   236

{

   237

	TileIndexDiff delta = TileOffsByDiagDir(GetLockDirection(tile));

   238

   239

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

   240

   241

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

   242

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

   243

		return CMD_ERROR;

   244

   245

	if (flags & DC_EXEC) {

   246

		DoClearSquare(tile);

   247

		MakeWaterOrCanalDependingOnSurroundings(tile + delta, _current_player);

   248

		MakeWaterOrCanalDependingOnSurroundings(tile - delta, _current_player);

   249

	}

   250

   251

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

   252

}

   253

   254

/**

   255

 * Marks the tiles around a tile as dirty.

   256

 *

   257

 * This functions marks the tiles around a given tile as dirty for repaint.

   258

 *

   259

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

   260

 * @ingroup dirty

   261

 * @see TerraformAddDirtyTileAround

   262

 */

   263

static void MarkTilesAroundDirty(TileIndex tile)

   264

{

   265

	MarkTileDirtyByTile(TILE_ADDXY(tile, 0, 1));

   266

	MarkTileDirtyByTile(TILE_ADDXY(tile, 0, -1));

   267

	MarkTileDirtyByTile(TILE_ADDXY(tile, 1, 0));

   268

	MarkTileDirtyByTile(TILE_ADDXY(tile, -1, 0));

   269

}

   270

   271

/** Builds a lock (ship-lift)

   272

 * @param tile tile where to place the lock

   273

 * @param flags type of operation

   274

 * @param p1 unused

   275

 * @param p2 unused

   276

 */

   277

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

   278

{

   279

	DiagDirection dir;

   280

   281

	switch (GetTileSlope(tile, NULL)) {

   282

		case SLOPE_SW: dir = DIAGDIR_SW; break;

   283

		case SLOPE_SE: dir = DIAGDIR_SE; break;

   284

		case SLOPE_NW: dir = DIAGDIR_NW; break;

   285

		case SLOPE_NE: dir = DIAGDIR_NE; break;

   286

		default: return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   287

	}

   288

   289

	/* Disallow building of locks on river rapids */

   290

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

   291

   292

	return DoBuildShiplift(tile, dir, flags);

   293

}

   294

   295

/** Build a piece of canal.

   296

 * @param tile end tile of stretch-dragging

   297

 * @param flags type of operation

   298

 * @param p1 start tile of stretch-dragging

   299

 * @param p2 ctrl pressed - toggles ocean / canals at sealevel (ocean only allowed in the scenario editor)

   300

 */

   301

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

   302

{

   303

	CommandCost cost(EXPENSES_CONSTRUCTION);

   304

	int size_x, size_y;

   305

	int x;

   306

	int y;

   307

	int sx, sy;

   308

   309

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

   310

   311

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

   312

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

   313

   314

	x = TileX(tile);

   315

	y = TileY(tile);

   316

	sx = TileX(p1);

   317

	sy = TileY(p1);

   318

   319

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

   320

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

   321

	size_x = (x - sx) + 1;

   322

	size_y = (y - sy) + 1;

   323

   324

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

   325

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

   326

   327

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

   328

		CommandCost ret;

   329

   330

		Slope slope = GetTileSlope(tile, NULL);

   331

		if (slope != SLOPE_FLAT && (p2 != 2 || (slope != SLOPE_NW && slope != SLOPE_NE && slope != SLOPE_SW && slope != SLOPE_SE))) {

   332

			return_cmd_error(STR_0007_FLAT_LAND_REQUIRED);

   333

		}

   334

   335

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

   336

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

   337

   338

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

   339

		if (CmdFailed(ret)) return ret;

   340

		cost.AddCost(ret);

   341

   342

		if (flags & DC_EXEC) {

   343

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

   344

				MakeWater(tile);

   345

			} else if (p2 == 2) {

   346

				MakeRiver(tile, Random());

   347

			} else {

   348

				MakeCanal(tile, _current_player, Random());

   349

			}

   350

			MarkTileDirtyByTile(tile);

   351

			MarkTilesAroundDirty(tile);

   352

		}

   353

   354

		cost.AddCost(_price.clear_water);

   355

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

   356

   357

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

   358

		return_cmd_error(STR_1007_ALREADY_BUILT);

   359

	} else {

   360

		return cost;

   361

	}

   362

}

   363

   364

static CommandCost ClearTile_Water(TileIndex tile, byte flags)

   365

{

   366

	switch (GetWaterTileType(tile)) {

   367

		case WATER_TILE_CLEAR:

   368

		case WATER_TILE_RIVER:

   369

			if (flags & DC_NO_WATER) return_cmd_error(STR_3807_CAN_T_BUILD_ON_WATER);

   370

   371

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

   372

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

   373

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

   374

				return_cmd_error(STR_0002_TOO_CLOSE_TO_EDGE_OF_MAP);

   375

			}

   376

   377

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

   378

			if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   379

   380

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

   381

   382

			if (flags & DC_EXEC) DoClearSquare(tile);

   383

			return CommandCost(EXPENSES_CONSTRUCTION, _price.clear_water);

   384

   385

		case WATER_TILE_COAST: {

   386

			Slope slope = GetTileSlope(tile, NULL);

   387

   388

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

   389

			if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   390

   391

			if (flags & DC_EXEC) DoClearSquare(tile);

   392

			if (slope == SLOPE_N || slope == SLOPE_E || slope == SLOPE_S || slope == SLOPE_W) {

   393

				return CommandCost(EXPENSES_CONSTRUCTION, _price.clear_water);

   394

			} else {

   395

				return CommandCost(EXPENSES_CONSTRUCTION, _price.clear_roughland);

   396

			}

   397

		}

   398

   399

		case WATER_TILE_LOCK: {

   400

			static const TileIndexDiffC _shiplift_tomiddle_offs[] = {

   401

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

   402

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

   403

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

   404

			};

   405

   406

			if (flags & DC_AUTO) return_cmd_error(STR_2004_BUILDING_MUST_BE_DEMOLISHED);

   407

			if (_current_player == OWNER_WATER) return CMD_ERROR;

   408

			/* move to the middle tile.. */

   409

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

   410

		}

   411

   412

		case WATER_TILE_DEPOT:

   413

			if (flags & DC_AUTO) return_cmd_error(STR_2004_BUILDING_MUST_BE_DEMOLISHED);

   414

			return RemoveShipDepot(tile, flags);

   415

   416

		default:

   417

			NOT_REACHED();

   418

	}

   419

}

   420

   421

/** return true if a tile is a water tile. */

   422

static bool IsWateredTile(TileIndex tile)

   423

{

   424

	switch (GetTileType(tile)) {

   425

		case MP_WATER:

   426

			if (!IsCoast(tile)) return true;

   427

   428

			switch (GetTileSlope(tile, NULL)) {

   429

				case SLOPE_W:

   430

				case SLOPE_S:

   431

				case SLOPE_E:

   432

				case SLOPE_N:

   433

					return true;

   434

   435

				default:

   436

					return false;

   437

			}

   438

   439

		case MP_RAILWAY:  return GetRailGroundType(tile) == RAIL_GROUND_WATER;

   440

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

   441

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

   442

		default:          return false;

   443

	}

   444

}

   445

   446

static void DrawWaterEdges(SpriteID base, TileIndex tile)

   447

{

   448

	uint wa;

   449

   450

	/* determine the edges around with water. */

   451

	wa  = IsWateredTile(TILE_ADDXY(tile, -1,  0)) << 0;

   452

	wa += IsWateredTile(TILE_ADDXY(tile,  0,  1)) << 1;

   453

	wa += IsWateredTile(TILE_ADDXY(tile,  1,  0)) << 2;

   454

	wa += IsWateredTile(TILE_ADDXY(tile,  0, -1)) << 3;

   455

   456

	if (!(wa & 1)) DrawGroundSprite(base,     PAL_NONE);

   457

	if (!(wa & 2)) DrawGroundSprite(base + 1, PAL_NONE);

   458

	if (!(wa & 4)) DrawGroundSprite(base + 2, PAL_NONE);

   459

	if (!(wa & 8)) DrawGroundSprite(base + 3, PAL_NONE);

   460

   461

	/* right corner */

   462

	switch (wa & 0x03) {

   463

		case 0: DrawGroundSprite(base + 4, PAL_NONE); break;

   464

		case 3: if (!IsWateredTile(TILE_ADDXY(tile, -1, 1))) DrawGroundSprite(base + 8, PAL_NONE); break;

   465

	}

   466

   467

	/* bottom corner */

   468

	switch (wa & 0x06) {

   469

		case 0: DrawGroundSprite(base + 5, PAL_NONE); break;

   470

		case 6: if (!IsWateredTile(TILE_ADDXY(tile, 1, 1))) DrawGroundSprite(base + 9, PAL_NONE); break;

   471

	}

   472

   473

	/* left corner */

   474

	switch (wa & 0x0C) {

   475

		case  0: DrawGroundSprite(base + 6, PAL_NONE); break;

   476

		case 12: if (!IsWateredTile(TILE_ADDXY(tile, 1, -1))) DrawGroundSprite(base + 10, PAL_NONE); break;

   477

	}

   478

   479

	/* upper corner */

   480

	switch (wa & 0x09) {

   481

		case 0: DrawGroundSprite(base + 7, PAL_NONE); break;

   482

		case 9: if (!IsWateredTile(TILE_ADDXY(tile, -1, -1))) DrawGroundSprite(base + 11, PAL_NONE); break;

   483

	}