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 "functions.h"

    14

#include "landscape.h"

    15

#include "map.h"

    16

#include "tile.h"

    17

#include "vehicle.h"

    18

#include "viewport.h"

    19

#include "command.h"

    20

#include "town.h"

    21

#include "news.h"

    22

#include "sound.h"

    23

#include "depot.h"

    24

#include "vehicle_gui.h"

    25

#include "train.h"

    27

#include "water_map.h"

    28

#include "newgrf.h"

    29

#include "newgrf_canal.h"

    30

    31

static const SpriteID _water_shore_sprites[] = {

    32

	0,

    33

	SPR_SHORE_TILEH_1,

    34

	SPR_SHORE_TILEH_2,

    35

	SPR_SHORE_TILEH_3,

    36

	SPR_SHORE_TILEH_4,

    37

	0,

    38

	SPR_SHORE_TILEH_6,

    39

	0,

    40

	SPR_SHORE_TILEH_8,

    41

	SPR_SHORE_TILEH_9,

    42

	0,

    43

	0,

    44

	SPR_SHORE_TILEH_12,

    45

	0,

    46

	0

    47

};

    48

    49

    50

static Vehicle *FindFloodableVehicleOnTile(TileIndex tile);

    51

static void FloodVehicle(Vehicle *v);

    52

    53

/** Build a ship depot.

    54

 * @param tile tile where ship depot is built

    55

 * @param flags type of operation

    56

 * @param p1 bit 0 depot orientation (Axis)

    57

 * @param p2 unused

    58

 */

    59

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

    60

{

    61

	TileIndex tile2;

    62

    63

	int32 cost, ret;

    64

	Depot *depot;

    65

    66

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

    67

    68

	if (!EnsureNoVehicle(tile)) return CMD_ERROR;

    69

    70

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

    71

    72

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

    73

	if (!EnsureNoVehicle(tile2)) return CMD_ERROR;

    74

    75

	if (!IsClearWaterTile(tile) || !IsClearWaterTile(tile2))

    76

		return_cmd_error(STR_3801_MUST_BE_BUILT_ON_WATER);

    77

    78

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

    79

    80

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

    81

	if (CmdFailed(ret)) return CMD_ERROR;

    82

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

    83

	if (CmdFailed(ret)) return CMD_ERROR;

    84

    85

	/* pretend that we're not making land from the water even though we actually are. */

    86

	cost = 0;

    87

    88

	depot = AllocateDepot();

    89

	if (depot == NULL) return CMD_ERROR;

    90

    91

	if (flags & DC_EXEC) {

    92

		depot->xy = tile;

    93

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

    94

    95

		MakeShipDepot(tile,  _current_player, DEPOT_NORTH, axis);

    96

		MakeShipDepot(tile2, _current_player, DEPOT_SOUTH, axis);

    97

		MarkTileDirtyByTile(tile);

    98

		MarkTileDirtyByTile(tile2);

    99

	}

   100

   101

	return cost + _price.build_ship_depot;

   102

}

   103

   104

static int32 RemoveShipDepot(TileIndex tile, uint32 flags)

   105

{

   106

	TileIndex tile2;

   107

   108

	if (!IsShipDepot(tile)) return CMD_ERROR;

   109

	if (!CheckTileOwnership(tile)) return CMD_ERROR;

   110

	if (!EnsureNoVehicle(tile)) return CMD_ERROR;

   111

   112

	tile2 = GetOtherShipDepotTile(tile);

   113

   114

	if (!EnsureNoVehicle(tile2)) return CMD_ERROR;

   115

   116

	if (flags & DC_EXEC) {

   117

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

   118

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

   119

   120

		MakeWater(tile);

   121

		MakeWater(tile2);

   122

		MarkTileDirtyByTile(tile);

   123

		MarkTileDirtyByTile(tile2);

   124

	}

   125

   126

	return _price.remove_ship_depot;

   127

}

   128

   129

/** build a shiplift */

   130

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

   131

{

   132

	int32 ret;

   133

	int delta;

   134

   135

	/* middle tile */

   136

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

   137

	if (CmdFailed(ret)) return CMD_ERROR;

   138

   139

	delta = TileOffsByDiagDir(dir);

   140

	/* lower tile */

   141

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

   142

	if (CmdFailed(ret)) return CMD_ERROR;

   143

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

   144

		return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   145

	}

   146

   147

	/* upper tile */

   148

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

   149

	if (CmdFailed(ret)) return CMD_ERROR;

   150

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

   151

		return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   152

	}

   153

   154

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

   155

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

   156

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

   157

		return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   158

	}

   159

   160

	if (flags & DC_EXEC) {

   161

		MakeLock(tile, _current_player, dir);

   162

		MarkTileDirtyByTile(tile);

   163

		MarkTileDirtyByTile(tile - delta);

   164

		MarkTileDirtyByTile(tile + delta);

   165

	}

   166

   167

	return _price.clear_water * 22 >> 3;

   168

}

   169

   170

static int32 RemoveShiplift(TileIndex tile, uint32 flags)

   171

{

   172

	TileIndexDiff delta = TileOffsByDiagDir(GetLockDirection(tile));

   173

   174

	if (!CheckTileOwnership(tile)) return CMD_ERROR;

   175

   176

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

   177

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

   178

		return CMD_ERROR;

   179

   180

	if (flags & DC_EXEC) {

   181

		DoClearSquare(tile);

   182

		DoClearSquare(tile + delta);

   183

		DoClearSquare(tile - delta);

   184

	}

   185

   186

	return _price.clear_water * 2;

   187

}

   188

   189

static void MarkTilesAroundDirty(TileIndex tile)

   190

{

   191

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

   192

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

   193

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

   194

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

   195

}

   196

   197

/** Builds a lock (ship-lift)

   198

 * @param tile tile where to place the lock

   199

 * @param flags type of operation

   200

 * @param p1 unused

   201

 * @param p2 unused

   202

 */

   203

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

   204

{

   205

	DiagDirection dir;

   206

   207

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   208

   209

	switch (GetTileSlope(tile, NULL)) {

   210

		case SLOPE_SW: dir = DIAGDIR_SW; break;

   211

		case SLOPE_SE: dir = DIAGDIR_SE; break;

   212

		case SLOPE_NW: dir = DIAGDIR_NW; break;

   213

		case SLOPE_NE: dir = DIAGDIR_NE; break;

   214

		default: return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   215

	}

   216

	return DoBuildShiplift(tile, dir, flags);

   217

}

   218

   219

/** Build a piece of canal.

   220

 * @param tile end tile of stretch-dragging

   221

 * @param flags type of operation

   222

 * @param p1 start tile of stretch-dragging

   223

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

   224

 */

   225

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

   226

{

   227

	int32 cost;

   228

	int size_x, size_y;

   229

	int x;

   230

	int y;

   231

	int sx, sy;

   232

   233

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

   234

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

   235

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

   236

   237

	x = TileX(tile);

   238

	y = TileY(tile);

   239

	sx = TileX(p1);

   240

	sy = TileY(p1);

   241

   242

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   243

   244

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

   245

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

   246

	size_x = (x - sx) + 1;

   247

	size_y = (y - sy) + 1;

   248

   249

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

   250

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

   251

   252

	cost = 0;

   253

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

   254

		int32 ret;

   255

   256

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

   257

			return_cmd_error(STR_0007_FLAT_LAND_REQUIRED);

   258

		}

   259

   260

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

   261

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

   262

   263

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

   264

		if (CmdFailed(ret)) return ret;

   265

		cost += ret;

   266

   267

		if (flags & DC_EXEC) {

   268

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

   269

				MakeWater(tile);

   270

			} else {

   271

				MakeCanal(tile, _current_player);

   272

			}

   273

			MarkTileDirtyByTile(tile);

   274

			MarkTilesAroundDirty(tile);

   275

		}

   276

   277

		cost += _price.clear_water;

   278

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

   279

   280

	if (cost == 0) {

   281

		return_cmd_error(STR_1007_ALREADY_BUILT);

   282

	} else {

   283

		return cost;

   284

	}

   285

}

   286

   287

static int32 ClearTile_Water(TileIndex tile, byte flags)

   288

{

   289

	switch (GetWaterTileType(tile)) {

   290

		case WATER_TILE_CLEAR:

   291

			if (flags & DC_NO_WATER) return_cmd_error(STR_3807_CAN_T_BUILD_ON_WATER);

   292

   293

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

   294

			if (!EnsureNoVehicle(tile)) return CMD_ERROR;

   295

   296

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

   297

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

   298

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

   299

				return_cmd_error(STR_0002_TOO_CLOSE_TO_EDGE_OF_MAP);

   300

			}

   301

   302

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

   303

   304

			if (flags & DC_EXEC) DoClearSquare(tile);

   305

			return _price.clear_water;

   306

   307

		case WATER_TILE_COAST: {

   308

			Slope slope = GetTileSlope(tile, NULL);

   309

   310

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

   311

			if (!EnsureNoVehicle(tile)) return CMD_ERROR;

   312

   313

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

   314

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

   315

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

   316

				return_cmd_error(STR_0002_TOO_CLOSE_TO_EDGE_OF_MAP);

   317

			}

   318

   319

			if (flags & DC_EXEC) DoClearSquare(tile);

   320

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

   321

				return _price.clear_water;

   322

			} else {

   323

				return _price.purchase_land;

   324

			}

   325

		}

   326

   327

		case WATER_TILE_LOCK: {

   328

			static const TileIndexDiffC _shiplift_tomiddle_offs[] = {

   329

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

   330

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

   331

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

   332

			};

   333

   334

			if (flags & DC_AUTO) return_cmd_error(STR_2004_BUILDING_MUST_BE_DEMOLISHED);

   335

			if (_current_player == OWNER_WATER) return CMD_ERROR;

   336

			/* move to the middle tile.. */

   337

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

   338

		}

   339

   340

		case WATER_TILE_DEPOT:

   341

			if (flags & DC_AUTO) return_cmd_error(STR_2004_BUILDING_MUST_BE_DEMOLISHED);

   342

			return RemoveShipDepot(tile, flags);

   343

   344

		default:

   345

			NOT_REACHED();

   346

			return 0;

   347

	}

   348

}

   349

   350

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

   351

static bool IsWateredTile(TileIndex tile)

   352

{

   353

	switch (GetTileType(tile)) {

   354

		case MP_WATER:

   355

			if (!IsCoast(tile)) return true;

   356

   357

			switch (GetTileSlope(tile, NULL)) {

   358

				case SLOPE_W:

   359

				case SLOPE_S:

   360

				case SLOPE_E:

   361

				case SLOPE_N:

   362

					return true;

   363

   364

				default:

   365

					return false;

   366

			}

   367

   368

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

   369

		default:         return false;

   370

	}

   371

}

   372

   373

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

   374

void DrawCanalWater(TileIndex tile)

   375

{

   376

	uint wa;

   377

   378

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

   379

	SpriteID dikes_base = GetCanalSprite(CF_DIKES, tile);

   380

	if (dikes_base == 0) dikes_base = SPR_CANALS_BASE + 57;

   381

   382

	/* determine the edges around with water. */

   383

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

   384

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

   385

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

   386

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

   387

   388

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

   389

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

   390

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

   391

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

   392

   393

	/* right corner */

   394

	switch (wa & 0x03) {

   395

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

   396

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

   397

	}

   398

   399

	/* bottom corner */

   400

	switch (wa & 0x06) {

   401

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

   402

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

   403

	}

   404

   405

	/* left corner */

   406

	switch (wa & 0x0C) {

   407

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

   408

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

   409

	}

   410

   411

	/* upper corner */

   412

	switch (wa & 0x09) {

   413

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

   414

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

   415

	}

   416

}

   417

   418

struct LocksDrawTileStruct {

   419

	int8 delta_x, delta_y, delta_z;

   420

	byte width, height, depth;

   421

	SpriteID image;

   422

};

   423

   424

#include "table/water_land.h"

   425

   426

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

   427

	SpriteID palette, uint base

   428

)

   429

{

   430

	SpriteID image;

   431

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

   432

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

   433

   434

	/* If no custom graphics, use defaults */

   435

	if (water_base == 0) water_base = SPR_CANALS_BASE + 5;

   436

	if (locks_base == 0) {

   437

		locks_base = SPR_CANALS_BASE + 9;

   438

	} else {

   439

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

   440

		base = 0;

   441

	}

   442

   443

	image = wdts++->image;

   444

	if (image < 4) image += water_base;

   445

	DrawGroundSprite(image, PAL_NONE);

   446

   447

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

   448

		SpriteID image = wdts->image;

   449

		SpriteID pal;

   450

   451

		if (image < 24) image += locks_base;

   452

		image += base;

   453

   454

		if (HASBIT(_transparent_opt, TO_BUILDINGS)) {

   455

			SETBIT(image, PALETTE_MODIFIER_TRANSPARENT);

   456

			pal = PALETTE_TO_TRANSPARENT;

   457

		} else {

   458

			pal = palette;

   459

		}

   460

   461

		AddSortableSpriteToDraw(image, pal,

   462

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

   463

			wdts->width, wdts->height,

   464

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

   465

	}

   466

}

   467

   468

static void DrawTile_Water(TileInfo *ti)

   469

{

   470

	switch (GetWaterTileType(ti->tile)) {

   471

		case WATER_TILE_CLEAR:

   472

			DrawGroundSprite(SPR_FLAT_WATER_TILE, PAL_NONE);

   473

			if (ti->z != 0 || !IsTileOwner(ti->tile, OWNER_WATER)) DrawCanalWater(ti->tile);

   474

			DrawBridgeMiddle(ti);

   475

			break;

   476

   477

		case WATER_TILE_COAST:

   478

			assert(!IsSteepSlope(ti->tileh));

   479

			if (_coast_base != 0) {

   480

				DrawGroundSprite(_coast_base + ti->tileh, PAL_NONE);

   481

			} else {

   482

				DrawGroundSprite(_water_shore_sprites[ti->tileh], PAL_NONE);

   483

			}

   484

			DrawBridgeMiddle(ti);

   485

			break;

   486