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

    37

#include "table/sprites.h"

    38

#include "table/strings.h"

    39

    40

static Vehicle *FindFloodableVehicleOnTile(TileIndex tile);

    41

static void FloodVehicle(Vehicle *v);

    42

    43

/**

    44

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

    45

 * This as for example docks and shipdepots do not store

    46

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

    47

 * @param t the tile to change.

    48

 * @param o the owner of the new tile.

    49

 */

    50

void MakeWaterOrCanalDependingOnSurroundings(TileIndex t, Owner o)

    51

{

    52

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

    53

    54

	/* Mark tile dirty in all cases */

    55

	MarkTileDirtyByTile(t);

    56

    57

	/* Non-sealevel -> canal */

    58

	if (TileHeight(t) != 0) {

    59

		MakeCanal(t, o);

    60

		return;

    61

	}

    62

    63

	bool has_water = false;

    64

	bool has_canal = false;

    65

    66

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

    67

		TileIndex neighbour = TileAddByDiagDir(t, dir);

    68

		if (IsTileType(neighbour, MP_WATER)) {

    69

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

    70

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

    71

		}

    72

	}

    73

	if (has_canal || !has_water) {

    74

		MakeCanal(t, o);

    75

	} else {

    76

		MakeWater(t);

    77

	}

    78

}

    79

    80

    81

/** Build a ship depot.

    82

 * @param tile tile where ship depot is built

    83

 * @param flags type of operation

    84

 * @param p1 bit 0 depot orientation (Axis)

    85

 * @param p2 unused

    86

 */

    87

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

    88

{

    89

	TileIndex tile2;

    90

    91

	CommandCost ret;

    92

    93

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

    94

    95

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

    96

    97

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

    98

		return_cmd_error(STR_3801_MUST_BE_BUILT_ON_WATER);

    99

   100

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

   101

   102

	Owner o1 = GetTileOwner(tile);

   103

	Owner o2 = GetTileOwner(tile2);

   104

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

   105

	if (CmdFailed(ret)) return CMD_ERROR;

   106

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

   107

	if (CmdFailed(ret)) return CMD_ERROR;

   108

   109

	Depot *depot = new Depot(tile);

   110

	if (depot == NULL) return CMD_ERROR;

   111

	AutoPtrT<Depot> d_auto_delete = depot;

   112

   113

	if (flags & DC_EXEC) {

   114

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

   115

   116

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

   117

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

   118

		MarkTileDirtyByTile(tile);

   119

		MarkTileDirtyByTile(tile2);

   120

		d_auto_delete.Detach();

   121

	}

   122

   123

	return CommandCost(EXPENSES_CONSTRUCTION, _price.build_ship_depot);

   124

}

   125

   126

void MakeWaterOrCanalDependingOnOwner(TileIndex tile, Owner o)

   127

{

   128

	if (o == OWNER_WATER) {

   129

		MakeWater(tile);

   130

	} else {

   131

		MakeCanal(tile, o);

   132

	}

   133

}

   134

   135

static CommandCost RemoveShipDepot(TileIndex tile, uint32 flags)

   136

{

   137

	TileIndex tile2;

   138

   139

	if (!IsShipDepot(tile)) return CMD_ERROR;

   140

	if (!CheckTileOwnership(tile)) return CMD_ERROR;

   141

	if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   142

   143

	tile2 = GetOtherShipDepotTile(tile);

   144

   145

	if (!EnsureNoVehicleOnGround(tile2)) return CMD_ERROR;

   146

   147

	if (flags & DC_EXEC) {

   148

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

   149

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

   150

   151

		MakeWaterOrCanalDependingOnOwner(tile,  GetShipDepotWaterOwner(tile));

   152

		MakeWaterOrCanalDependingOnOwner(tile2, GetShipDepotWaterOwner(tile2));

   153

		MarkTileDirtyByTile(tile);

   154

		MarkTileDirtyByTile(tile2);

   155

	}

   156

   157

	return CommandCost(EXPENSES_CONSTRUCTION, _price.remove_ship_depot);

   158

}

   159

   160

/** build a shiplift */

   161

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

   162

{

   163

	CommandCost ret;

   164

	int delta;

   165

   166

	/* middle tile */

   167

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

   168

	if (CmdFailed(ret)) return CMD_ERROR;

   169

   170

	delta = TileOffsByDiagDir(dir);

   171

	/* lower tile */

   172

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

   173

	if (CmdFailed(ret)) return CMD_ERROR;

   174

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

   175

		return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   176

	}

   177

   178

	/* upper tile */

   179

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

   180

	if (CmdFailed(ret)) return CMD_ERROR;

   181

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

   182

		return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   183

	}

   184

   185

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

   186

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

   187

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

   188

		return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   189

	}

   190

   191

	if (flags & DC_EXEC) {

   192

		MakeLock(tile, _current_player, dir);

   193

		MarkTileDirtyByTile(tile);

   194

		MarkTileDirtyByTile(tile - delta);

   195

		MarkTileDirtyByTile(tile + delta);

   196

	}

   197

   198

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

   199

}

   200

   201

static CommandCost RemoveShiplift(TileIndex tile, uint32 flags)

   202

{

   203

	TileIndexDiff delta = TileOffsByDiagDir(GetLockDirection(tile));

   204

   205

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

   206

   207

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

   208

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

   209

		return CMD_ERROR;

   210

   211

	if (flags & DC_EXEC) {

   212

		DoClearSquare(tile);

   213

		MakeWaterOrCanalDependingOnSurroundings(tile + delta, _current_player);

   214

		MakeWaterOrCanalDependingOnSurroundings(tile - delta, _current_player);

   215

	}

   216

   217

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

   218

}

   219

   220

/**

   221

 * Marks the tiles around a tile as dirty.

   222

 *

   223

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

   224

 *

   225

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

   226

 * @ingroup dirty

   227

 * @see TerraformAddDirtyTileAround

   228

 */

   229

static void MarkTilesAroundDirty(TileIndex tile)

   230

{

   231

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

   232

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

   233

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

   234

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

   235

}

   236

   237

/** Builds a lock (ship-lift)

   238

 * @param tile tile where to place the lock

   239

 * @param flags type of operation

   240

 * @param p1 unused

   241

 * @param p2 unused

   242

 */

   243

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

   244

{

   245

	DiagDirection dir;

   246

   247

	switch (GetTileSlope(tile, NULL)) {

   248

		case SLOPE_SW: dir = DIAGDIR_SW; break;

   249

		case SLOPE_SE: dir = DIAGDIR_SE; break;

   250

		case SLOPE_NW: dir = DIAGDIR_NW; break;

   251

		case SLOPE_NE: dir = DIAGDIR_NE; break;

   252

		default: return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   253

	}

   254

	return DoBuildShiplift(tile, dir, flags);

   255

}

   256

   257

/** Build a piece of canal.

   258

 * @param tile end tile of stretch-dragging

   259

 * @param flags type of operation

   260

 * @param p1 start tile of stretch-dragging

   261

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

   262

 */

   263

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

   264

{

   265

	CommandCost cost(EXPENSES_CONSTRUCTION);

   266

	int size_x, size_y;

   267

	int x;

   268

	int y;

   269

	int sx, sy;

   270

   271

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

   272

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

   273

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

   274

   275

	x = TileX(tile);

   276

	y = TileY(tile);

   277

	sx = TileX(p1);

   278

	sy = TileY(p1);

   279

   280

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

   281

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

   282

	size_x = (x - sx) + 1;

   283

	size_y = (y - sy) + 1;

   284

   285

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

   286

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

   287

   288

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

   289

		CommandCost ret;

   290

   291

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

   292

			return_cmd_error(STR_0007_FLAT_LAND_REQUIRED);

   293

		}

   294

   295

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

   296

		if (IsTileType(tile, MP_WATER) && (!IsTileOwner(tile, OWNER_WATER) || HasBit(p2, 0))) continue;

   297

   298

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

   299

		if (CmdFailed(ret)) return ret;

   300

		cost.AddCost(ret);

   301

   302

		if (flags & DC_EXEC) {

   303

			if (TileHeight(tile) == 0 && HasBit(p2, 0)) {

   304

				MakeWater(tile);

   305

			} else {

   306

				MakeCanal(tile, _current_player);

   307

			}

   308

			MarkTileDirtyByTile(tile);

   309

			MarkTilesAroundDirty(tile);

   310

		}

   311

   312

		cost.AddCost(_price.clear_water);

   313

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

   314

   315

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

   316

		return_cmd_error(STR_1007_ALREADY_BUILT);

   317

	} else {

   318

		return cost;

   319

	}

   320

}

   321

   322

static CommandCost ClearTile_Water(TileIndex tile, byte flags)

   323

{

   324

	switch (GetWaterTileType(tile)) {

   325

		case WATER_TILE_CLEAR:

   326

			if (flags & DC_NO_WATER) return_cmd_error(STR_3807_CAN_T_BUILD_ON_WATER);

   327

   328

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

   329

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

   330

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

   331

				return_cmd_error(STR_0002_TOO_CLOSE_TO_EDGE_OF_MAP);

   332

			}

   333

   334

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

   335

			if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   336

   337

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

   338

   339

			if (flags & DC_EXEC) DoClearSquare(tile);

   340

			return CommandCost(EXPENSES_CONSTRUCTION, _price.clear_water);

   341

   342

		case WATER_TILE_COAST: {

   343

			Slope slope = GetTileSlope(tile, NULL);

   344

   345

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

   346

			if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   347

   348

			if (flags & DC_EXEC) DoClearSquare(tile);

   349

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

   350

				return CommandCost(EXPENSES_CONSTRUCTION, _price.clear_water);

   351

			} else {

   352

				return CommandCost(EXPENSES_CONSTRUCTION, _price.clear_roughland);

   353

			}

   354

		}

   355

   356

		case WATER_TILE_LOCK: {

   357

			static const TileIndexDiffC _shiplift_tomiddle_offs[] = {

   358

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

   359

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

   360

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

   361

			};

   362

   363

			if (flags & DC_AUTO) return_cmd_error(STR_2004_BUILDING_MUST_BE_DEMOLISHED);

   364

			if (_current_player == OWNER_WATER) return CMD_ERROR;

   365

			/* move to the middle tile.. */

   366

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

   367

		}

   368

   369

		case WATER_TILE_DEPOT:

   370

			if (flags & DC_AUTO) return_cmd_error(STR_2004_BUILDING_MUST_BE_DEMOLISHED);

   371

			return RemoveShipDepot(tile, flags);

   372

   373

		default:

   374

			NOT_REACHED();

   375

	}

   376

}

   377

   378

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

   379

static bool IsWateredTile(TileIndex tile)

   380

{

   381

	switch (GetTileType(tile)) {

   382

		case MP_WATER:

   383

			if (!IsCoast(tile)) return true;

   384

   385

			switch (GetTileSlope(tile, NULL)) {

   386

				case SLOPE_W:

   387

				case SLOPE_S:

   388

				case SLOPE_E:

   389

				case SLOPE_N:

   390

					return true;

   391

   392

				default:

   393

					return false;

   394

			}

   395

   396

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

   397

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

   398

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

   399

		default:          return false;

   400

	}

   401

}

   402

   403

/** draw a canal styled water tile with dikes around */

   404

void DrawCanalWater(TileIndex tile)

   405

{

   406

	uint wa;

   407

   408

	/* Test for custom graphics, else use the default */

   409

	SpriteID dikes_base = GetCanalSprite(CF_DIKES, tile);

   410

	if (dikes_base == 0) dikes_base = SPR_CANAL_DIKES_BASE;

   411

   412

	/* determine the edges around with water. */

   413

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

   414

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

   415

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

   416

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

   417

   418

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

   419

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

   420

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

   421

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

   422

   423

	/* right corner */

   424

	switch (wa & 0x03) {

   425

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

   426

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

   427

	}

   428

   429

	/* bottom corner */

   430

	switch (wa & 0x06) {

   431

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

   432

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

   433

	}

   434

   435

	/* left corner */

   436

	switch (wa & 0x0C) {

   437

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

   438

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

   439

	}

   440

   441

	/* upper corner */

   442

	switch (wa & 0x09) {

   443

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

   444

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

   445

	}

   446

}

   447

   448

struct LocksDrawTileStruct {

   449

	int8 delta_x, delta_y, delta_z;

   450

	byte width, height, depth;

   451

	SpriteID image;

   452

};

   453

   454

#include "table/water_land.h"

   455

   456

static void DrawWaterStuff(const TileInfo *ti, const WaterDrawTileStruct *wdts,

   457

	SpriteID palette, uint base

   458

)

   459

{

   460

	SpriteID image;

   461

	SpriteID water_base = GetCanalSprite(CF_WATERSLOPE, ti->tile);

   462

	SpriteID locks_base = GetCanalSprite(CF_LOCKS, ti->tile);

   463

   464

	/* If no custom graphics, use defaults */

   465

	if (water_base == 0) water_base = SPR_CANALS_BASE;

   466

	if (locks_base == 0) {

   467

		locks_base = SPR_SHIPLIFT_BASE;

   468

	} else {

   469

		/* If using custom graphics, ignore the variation on height */

   470

		base = 0;

   471

	}

   472

   473

	image = wdts++->image;

   474

	if (image < 4) image += water_base;

   475

	DrawGroundSprite(image, PAL_NONE);

   476

   477

	for (; wdts->delta_x != 0x80; wdts++) {

   478

		AddSortableSpriteToDraw(wdts->image + base + ((wdts->image < 24) ? locks_base : 0), palette,

   479

			ti->x + wdts->delta_x, ti->y + wdts->delta_y,

   480

			wdts->width, wdts->height,

   481

			wdts->unk, ti->z + wdts->delta_z,

   482

			IsTransparencySet(TO_BUILDINGS));

   483

	}