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 "table/sprites.h"

    12

#include "table/strings.h"

    13

#include "tile_cmd.h"

    14

#include "landscape.h"

    15

#include "map.h"

    16

#include "vehicle.h"

    17

#include "viewport.h"

    18

#include "command_func.h"

    19

#include "town.h"

    20

#include "news.h"

    21

#include "sound.h"

    22

#include "depot.h"

    23

#include "vehicle_gui.h"

    24

#include "train.h"

    25

#include "roadveh.h"

    26

#include "water.h"

    27

#include "water_map.h"

    28

#include "industry_map.h"

    29

#include "newgrf.h"

    30

#include "newgrf_canal.h"

    31

#include "misc/autoptr.hpp"

    32

#include "transparency.h"

    33

#include "strings_func.h"

    34

#include "functions.h"

    35

#include "window_func.h"

    36

    37

/** Array for the shore sprites */

    38

static const SpriteID _water_shore_sprites[] = {

    39

	0,

    40

	SPR_SHORE_TILEH_1,  // SLOPE_W

    41

	SPR_SHORE_TILEH_2,  // SLOPE_S

    42

	SPR_SHORE_TILEH_3,  // SLOPE_SW

    43

	SPR_SHORE_TILEH_4,  // SLOPE_E

    44

	0,

    45

	SPR_SHORE_TILEH_6,  // SLOPE_SE

    46

	0,

    47

	SPR_SHORE_TILEH_8,  // SLOPE_N

    48

	SPR_SHORE_TILEH_9,  // SLOPE_NW

    49

	0,

    50

	0,

    51

	SPR_SHORE_TILEH_12, // SLOPE_NE

    52

	0,

    53

	0

    54

};

    55

    56

    57

static Vehicle *FindFloodableVehicleOnTile(TileIndex tile);

    58

static void FloodVehicle(Vehicle *v);

    59

    60

/**

    61

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

    62

 * This as for example docks and shipdepots do not store

    63

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

    64

 * @param t the tile to change.

    65

 * @param o the owner of the new tile.

    66

 */

    67

void MakeWaterOrCanalDependingOnSurroundings(TileIndex t, Owner o)

    68

{

    69

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

    70

    71

	/* Mark tile dirty in all cases */

    72

	MarkTileDirtyByTile(t);

    73

    74

	/* Non-sealevel -> canal */

    75

	if (TileHeight(t) != 0) {

    76

		MakeCanal(t, o);

    77

		return;

    78

	}

    79

    80

	bool has_water = false;

    81

	bool has_canal = false;

    82

    83

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

    84

		TileIndex neighbour = TileAddByDiagDir(t, dir);

    85

		if (IsTileType(neighbour, MP_WATER)) {

    86

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

    87

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

    88

		}

    89

	}

    90

	if (has_canal || !has_water) {

    91

		MakeCanal(t, o);

    92

	} else {

    93

		MakeWater(t);

    94

	}

    95

}

    96

    97

    98

/** Build a ship depot.

    99

 * @param tile tile where ship depot is built

   100

 * @param flags type of operation

   101

 * @param p1 bit 0 depot orientation (Axis)

   102

 * @param p2 unused

   103

 */

   104

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

   105

{

   106

	TileIndex tile2;

   107

   108

	CommandCost cost, ret;

   109

   110

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   111

   112

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

   113

   114

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

   115

   116

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

   117

		return_cmd_error(STR_3801_MUST_BE_BUILT_ON_WATER);

   118

   119

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

   120

   121

	Owner o1 = GetTileOwner(tile);

   122

	Owner o2 = GetTileOwner(tile2);

   123

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

   124

	if (CmdFailed(ret)) return CMD_ERROR;

   125

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

   126

	if (CmdFailed(ret)) return CMD_ERROR;

   127

   128

	Depot *depot = new Depot(tile);

   129

	if (depot == NULL) return CMD_ERROR;

   130

	AutoPtrT<Depot> d_auto_delete = depot;

   131

   132

	if (flags & DC_EXEC) {

   133

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

   134

   135

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

   136

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

   137

		MarkTileDirtyByTile(tile);

   138

		MarkTileDirtyByTile(tile2);

   139

		d_auto_delete.Detach();

   140

	}

   141

   142

	return cost.AddCost(_price.build_ship_depot);

   143

}

   144

   145

void MakeWaterOrCanalDependingOnOwner(TileIndex tile, Owner o)

   146

{

   147

	if (o == OWNER_WATER) {

   148

		MakeWater(tile);

   149

	} else {

   150

		MakeCanal(tile, o);

   151

	}

   152

}

   153

   154

static CommandCost RemoveShipDepot(TileIndex tile, uint32 flags)

   155

{

   156

	TileIndex tile2;

   157

   158

	if (!IsShipDepot(tile)) return CMD_ERROR;

   159

	if (!CheckTileOwnership(tile)) return CMD_ERROR;

   160

	if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   161

   162

	tile2 = GetOtherShipDepotTile(tile);

   163

   164

	if (!EnsureNoVehicleOnGround(tile2)) return CMD_ERROR;

   165

   166

	if (flags & DC_EXEC) {

   167

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

   168

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

   169

   170

		MakeWaterOrCanalDependingOnOwner(tile,  GetShipDepotWaterOwner(tile));

   171

		MakeWaterOrCanalDependingOnOwner(tile2, GetShipDepotWaterOwner(tile2));

   172

		MarkTileDirtyByTile(tile);

   173

		MarkTileDirtyByTile(tile2);

   174

	}

   175

   176

	return CommandCost(_price.remove_ship_depot);

   177

}

   178

   179

/** build a shiplift */

   180

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

   181

{

   182

	CommandCost ret;

   183

	int delta;

   184

   185

	/* middle tile */

   186

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

   187

	if (CmdFailed(ret)) return CMD_ERROR;

   188

   189

	delta = TileOffsByDiagDir(dir);

   190

	/* lower tile */

   191

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

   192

	if (CmdFailed(ret)) return CMD_ERROR;

   193

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

   194

		return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   195

	}

   196

   197

	/* upper tile */

   198

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

   199

	if (CmdFailed(ret)) return CMD_ERROR;

   200

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

   201

		return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   202

	}

   203

   204

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

   205

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

   206

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

   207

		return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   208

	}

   209

   210

	if (flags & DC_EXEC) {

   211

		MakeLock(tile, _current_player, dir);

   212

		MarkTileDirtyByTile(tile);

   213

		MarkTileDirtyByTile(tile - delta);

   214

		MarkTileDirtyByTile(tile + delta);

   215

	}

   216

   217

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

   218

}

   219

   220

static CommandCost RemoveShiplift(TileIndex tile, uint32 flags)

   221

{

   222

	TileIndexDiff delta = TileOffsByDiagDir(GetLockDirection(tile));

   223

   224

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

   225

   226

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

   227

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

   228

		return CMD_ERROR;

   229

   230

	if (flags & DC_EXEC) {

   231

		DoClearSquare(tile);

   232

		MakeWaterOrCanalDependingOnSurroundings(tile + delta, _current_player);

   233

		MakeWaterOrCanalDependingOnSurroundings(tile - delta, _current_player);

   234

	}

   235

   236

	return CommandCost(_price.clear_water * 2);

   237

}

   238

   239

/**

   240

 * Marks the tiles around a tile as dirty.

   241

 *

   242

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

   243

 *

   244

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

   245

 * @ingroup dirty

   246

 * @see TerraformAddDirtyTileAround

   247

 */

   248

static void MarkTilesAroundDirty(TileIndex tile)

   249

{

   250

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

   251

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

   252

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

   253

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

   254

}

   255

   256

/** Builds a lock (ship-lift)

   257

 * @param tile tile where to place the lock

   258

 * @param flags type of operation

   259

 * @param p1 unused

   260

 * @param p2 unused

   261

 */

   262

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

   263

{

   264

	DiagDirection dir;

   265

   266

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   267

   268

	switch (GetTileSlope(tile, NULL)) {

   269

		case SLOPE_SW: dir = DIAGDIR_SW; break;

   270

		case SLOPE_SE: dir = DIAGDIR_SE; break;

   271

		case SLOPE_NW: dir = DIAGDIR_NW; break;

   272

		case SLOPE_NE: dir = DIAGDIR_NE; break;

   273

		default: return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   274

	}

   275

	return DoBuildShiplift(tile, dir, flags);

   276

}

   277

   278

/** Build a piece of canal.

   279

 * @param tile end tile of stretch-dragging

   280

 * @param flags type of operation

   281

 * @param p1 start tile of stretch-dragging

   282

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

   283

 */

   284

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

   285

{

   286

	CommandCost cost;

   287

	int size_x, size_y;

   288

	int x;

   289

	int y;

   290

	int sx, sy;

   291

   292

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

   293

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

   294

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

   295

   296

	x = TileX(tile);

   297

	y = TileY(tile);

   298

	sx = TileX(p1);

   299

	sy = TileY(p1);

   300

   301

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   302

   303

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

   304

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

   305

	size_x = (x - sx) + 1;

   306

	size_y = (y - sy) + 1;

   307

   308

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

   309

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

   310

   311

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

   312

		CommandCost ret;

   313

   314

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

   315

			return_cmd_error(STR_0007_FLAT_LAND_REQUIRED);

   316

		}

   317

   318

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

   319

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

   320

   321

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

   322

		if (CmdFailed(ret)) return ret;

   323

		cost.AddCost(ret);

   324

   325

		if (flags & DC_EXEC) {

   326

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

   327

				MakeWater(tile);

   328

			} else {

   329

				MakeCanal(tile, _current_player);

   330

			}

   331

			MarkTileDirtyByTile(tile);

   332

			MarkTilesAroundDirty(tile);

   333

		}

   334

   335

		cost.AddCost(_price.clear_water);

   336

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

   337

   338

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

   339

		return_cmd_error(STR_1007_ALREADY_BUILT);

   340

	} else {

   341

		return cost;

   342

	}

   343

}

   344

   345

static CommandCost ClearTile_Water(TileIndex tile, byte flags)

   346

{

   347

	switch (GetWaterTileType(tile)) {

   348

		case WATER_TILE_CLEAR:

   349

			if (flags & DC_NO_WATER) return_cmd_error(STR_3807_CAN_T_BUILD_ON_WATER);

   350

   351

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

   352

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

   353

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

   354

				return_cmd_error(STR_0002_TOO_CLOSE_TO_EDGE_OF_MAP);

   355

			}

   356

   357

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

   358

			if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   359

   360

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

   361

   362

			if (flags & DC_EXEC) DoClearSquare(tile);

   363

			return CommandCost(_price.clear_water);

   364

   365

		case WATER_TILE_COAST: {

   366

			Slope slope = GetTileSlope(tile, NULL);

   367

   368

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

   369

			if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   370

   371

			if (flags & DC_EXEC) DoClearSquare(tile);

   372

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

   373

				return CommandCost(_price.clear_water);

   374

			} else {

   375

				return CommandCost(_price.clear_roughland);

   376

			}

   377

		}

   378

   379

		case WATER_TILE_LOCK: {

   380

			static const TileIndexDiffC _shiplift_tomiddle_offs[] = {

   381

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

   382

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

   383

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

   384

			};

   385

   386

			if (flags & DC_AUTO) return_cmd_error(STR_2004_BUILDING_MUST_BE_DEMOLISHED);

   387

			if (_current_player == OWNER_WATER) return CMD_ERROR;

   388

			/* move to the middle tile.. */

   389

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

   390

		}

   391

   392

		case WATER_TILE_DEPOT:

   393

			if (flags & DC_AUTO) return_cmd_error(STR_2004_BUILDING_MUST_BE_DEMOLISHED);

   394

			return RemoveShipDepot(tile, flags);

   395

   396

		default:

   397

			NOT_REACHED();

   398

	}

   399

}

   400

   401

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

   402

static bool IsWateredTile(TileIndex tile)

   403

{

   404

	switch (GetTileType(tile)) {

   405

		case MP_WATER:

   406

			if (!IsCoast(tile)) return true;

   407

   408

			switch (GetTileSlope(tile, NULL)) {

   409

				case SLOPE_W:

   410

				case SLOPE_S:

   411

				case SLOPE_E:

   412

				case SLOPE_N:

   413

					return true;

   414

   415

				default:

   416

					return false;

   417

			}

   418

   419

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

   420

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

   421

		default:          return false;

   422

	}

   423

}

   424

   425

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

   426

void DrawCanalWater(TileIndex tile)

   427

{

   428

	uint wa;

   429

   430

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

   431

	SpriteID dikes_base = GetCanalSprite(CF_DIKES, tile);

   432

	if (dikes_base == 0) dikes_base = SPR_CANAL_DIKES_BASE;

   433

   434

	/* determine the edges around with water. */

   435

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

   436

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

   437

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

   438

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

   439

   440

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

   441

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

   442

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

   443

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

   444

   445

	/* right corner */

   446

	switch (wa & 0x03) {

   447

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

   448

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

   449

	}

   450

   451

	/* bottom corner */

   452

	switch (wa & 0x06) {

   453

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

   454

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

   455

	}

   456

   457

	/* left corner */

   458

	switch (wa & 0x0C) {

   459

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

   460

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

   461

	}

   462

   463

	/* upper corner */

   464

	switch (wa & 0x09) {

   465

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

   466

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

   467

	}

   468

}

   469

   470

struct LocksDrawTileStruct {

   471

	int8 delta_x, delta_y, delta_z;

   472

	byte width, height, depth;

   473

	SpriteID image;

   474

};

   475

   476

#include "table/water_land.h"

   477

   478

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

   479

	SpriteID palette, uint base

   480

)

   481

{

   482

	SpriteID image;

   483

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