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

    14

#include "functions.h"

    15

#include "landscape.h"

    16

#include "map.h"

    17

#include "tile.h"

    18

#include "vehicle.h"

    19

#include "viewport.h"

    20

#include "command.h"

    21

#include "town.h"

    22

#include "news.h"

    23

#include "sound.h"

    24

#include "depot.h"

    25

#include "vehicle_gui.h"

    26

#include "train.h"

    27

#include "roadveh.h"

    28

#include "water_map.h"

    29

#include "newgrf.h"

    30

#include "newgrf_canal.h"

    31

    32

static const SpriteID _water_shore_sprites[] = {

    33

	0,

    34

	SPR_SHORE_TILEH_1,

    35

	SPR_SHORE_TILEH_2,

    36

	SPR_SHORE_TILEH_3,

    37

	SPR_SHORE_TILEH_4,

    38

	0,

    39

	SPR_SHORE_TILEH_6,

    40

	0,

    41

	SPR_SHORE_TILEH_8,

    42

	SPR_SHORE_TILEH_9,

    43

	0,

    44

	0,

    45

	SPR_SHORE_TILEH_12,

    46

	0,

    47

	0

    48

};

    49

    50

    51

static Vehicle *FindFloodableVehicleOnTile(TileIndex tile);

    52

static void FloodVehicle(Vehicle *v);

    53

    54

/** Build a ship depot.

    55

 * @param tile tile where ship depot is built

    56

 * @param flags type of operation

    57

 * @param p1 bit 0 depot orientation (Axis)

    58

 * @param p2 unused

    59

 */

    60

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

    61

{

    62

	TileIndex tile2;

    63

    64

	CommandCost cost, ret;

    65

	Depot *depot;

    66

    67

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

    68

    69

	if (!EnsureNoVehicle(tile)) return CMD_ERROR;

    70

    71

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

    72

    73

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

    74

	if (!EnsureNoVehicle(tile2)) return CMD_ERROR;

    75

    76

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

    77

		return_cmd_error(STR_3801_MUST_BE_BUILT_ON_WATER);

    78

    79

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

    80

    81

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

    82

	if (CmdFailed(ret)) return CMD_ERROR;

    83

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

    84

	if (CmdFailed(ret)) return CMD_ERROR;

    85

    86

	depot = AllocateDepot();

    87

	if (depot == NULL) return CMD_ERROR;

    88

    89

	if (flags & DC_EXEC) {

    90

		depot->xy = tile;

    91

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

    92

    93

		MakeShipDepot(tile,  _current_player, DEPOT_NORTH, axis);

    94

		MakeShipDepot(tile2, _current_player, DEPOT_SOUTH, axis);

    95

		MarkTileDirtyByTile(tile);

    96

		MarkTileDirtyByTile(tile2);

    97

	}

    98

    99

	return cost.AddCost(_price.build_ship_depot);

   100

}

   101

   102

static CommandCost RemoveShipDepot(TileIndex tile, uint32 flags)

   103

{

   104

	TileIndex tile2;

   105

   106

	if (!IsShipDepot(tile)) return CMD_ERROR;

   107

	if (!CheckTileOwnership(tile)) return CMD_ERROR;

   108

	if (!EnsureNoVehicle(tile)) return CMD_ERROR;

   109

   110

	tile2 = GetOtherShipDepotTile(tile);

   111

   112

	if (!EnsureNoVehicle(tile2)) return CMD_ERROR;

   113

   114

	if (flags & DC_EXEC) {

   115

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

   116

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

   117

   118

		MakeWater(tile);

   119

		MakeWater(tile2);

   120

		MarkTileDirtyByTile(tile);

   121

		MarkTileDirtyByTile(tile2);

   122

	}

   123

   124

	return CommandCost(_price.remove_ship_depot);

   125

}

   126

   127

/** build a shiplift */

   128

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

   129

{

   130

	CommandCost ret;

   131

	int delta;

   132

   133

	/* middle tile */

   134

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

   135

	if (CmdFailed(ret)) return CMD_ERROR;

   136

   137

	delta = TileOffsByDiagDir(dir);

   138

	/* lower tile */

   139

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

   140

	if (CmdFailed(ret)) return CMD_ERROR;

   141

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

   142

		return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   143

	}

   144

   145

	/* upper tile */

   146

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

   147

	if (CmdFailed(ret)) return CMD_ERROR;

   148

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

   149

		return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   150

	}

   151

   152

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

   153

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

   154

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

   155

		return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   156

	}

   157

   158

	if (flags & DC_EXEC) {

   159

		MakeLock(tile, _current_player, dir);

   160

		MarkTileDirtyByTile(tile);

   161

		MarkTileDirtyByTile(tile - delta);

   162

		MarkTileDirtyByTile(tile + delta);

   163

	}

   164

   165

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

   166

}

   167

   168

static CommandCost RemoveShiplift(TileIndex tile, uint32 flags)

   169

{

   170

	TileIndexDiff delta = TileOffsByDiagDir(GetLockDirection(tile));

   171

   172

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

   173

   174

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

   175

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

   176

		return CMD_ERROR;

   177

   178

	if (flags & DC_EXEC) {

   179

		DoClearSquare(tile);

   180

		DoClearSquare(tile + delta);

   181

		DoClearSquare(tile - delta);

   182

	}

   183

   184

	return CommandCost(_price.clear_water * 2);

   185

}

   186

   187

static void MarkTilesAroundDirty(TileIndex tile)

   188

{

   189

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

   190

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

   191

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

   192

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

   193

}

   194

   195

/** Builds a lock (ship-lift)

   196

 * @param tile tile where to place the lock

   197

 * @param flags type of operation

   198

 * @param p1 unused

   199

 * @param p2 unused

   200

 */

   201

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

   202

{

   203

	DiagDirection dir;

   204

   205

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   206

   207

	switch (GetTileSlope(tile, NULL)) {

   208

		case SLOPE_SW: dir = DIAGDIR_SW; break;

   209

		case SLOPE_SE: dir = DIAGDIR_SE; break;

   210

		case SLOPE_NW: dir = DIAGDIR_NW; break;

   211

		case SLOPE_NE: dir = DIAGDIR_NE; break;

   212

		default: return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   213

	}

   214

	return DoBuildShiplift(tile, dir, flags);

   215

}

   216

   217

/** Build a piece of canal.

   218

 * @param tile end tile of stretch-dragging

   219

 * @param flags type of operation

   220

 * @param p1 start tile of stretch-dragging

   221

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

   222

 */

   223

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

   224

{

   225

	CommandCost cost;

   226

	int size_x, size_y;

   227

	int x;

   228

	int y;

   229

	int sx, sy;

   230

   231

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

   232

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

   233

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

   234

   235

	x = TileX(tile);

   236

	y = TileY(tile);

   237

	sx = TileX(p1);

   238

	sy = TileY(p1);

   239

   240

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   241

   242

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

   243

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

   244

	size_x = (x - sx) + 1;

   245

	size_y = (y - sy) + 1;

   246

   247

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

   248

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

   249

   250

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

   251

		CommandCost ret;

   252

   253

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

   254

			return_cmd_error(STR_0007_FLAT_LAND_REQUIRED);

   255

		}

   256

   257

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

   258

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

   259

   260

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

   261

		if (CmdFailed(ret)) return ret;

   262

		cost.AddCost(ret);

   263

   264

		if (flags & DC_EXEC) {

   265

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

   266

				MakeWater(tile);

   267

			} else {

   268

				MakeCanal(tile, _current_player);

   269

			}

   270

			MarkTileDirtyByTile(tile);

   271

			MarkTilesAroundDirty(tile);

   272

		}

   273

   274

		cost.AddCost(_price.clear_water);

   275

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

   276

   277

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

   278

		return_cmd_error(STR_1007_ALREADY_BUILT);

   279

	} else {

   280

		return cost;

   281

	}

   282

}

   283

   284

static CommandCost ClearTile_Water(TileIndex tile, byte flags)

   285

{

   286

	switch (GetWaterTileType(tile)) {

   287

		case WATER_TILE_CLEAR:

   288

			if (flags & DC_NO_WATER) return_cmd_error(STR_3807_CAN_T_BUILD_ON_WATER);

   289

   290

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

   291

			if (!EnsureNoVehicle(tile)) return CMD_ERROR;

   292

   293

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

   294

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

   295

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

   296

				return_cmd_error(STR_0002_TOO_CLOSE_TO_EDGE_OF_MAP);

   297

			}

   298

   299

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

   300

   301

			if (flags & DC_EXEC) DoClearSquare(tile);

   302

			return CommandCost(_price.clear_water);

   303

   304

		case WATER_TILE_COAST: {

   305

			Slope slope = GetTileSlope(tile, NULL);

   306

   307

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

   308

			if (!EnsureNoVehicle(tile)) return CMD_ERROR;

   309

   310

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

   311

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

   312

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

   313

				return_cmd_error(STR_0002_TOO_CLOSE_TO_EDGE_OF_MAP);

   314

			}

   315

   316

			if (flags & DC_EXEC) DoClearSquare(tile);

   317

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

   318

				return CommandCost(_price.clear_water);

   319

			} else {

   320

				return CommandCost(_price.purchase_land);

   321

			}

   322

		}

   323

   324

		case WATER_TILE_LOCK: {

   325

			static const TileIndexDiffC _shiplift_tomiddle_offs[] = {

   326

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

   327

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

   328

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

   329

			};

   330

   331

			if (flags & DC_AUTO) return_cmd_error(STR_2004_BUILDING_MUST_BE_DEMOLISHED);

   332

			if (_current_player == OWNER_WATER) return CMD_ERROR;

   333

			/* move to the middle tile.. */

   334

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

   335

		}

   336

   337

		case WATER_TILE_DEPOT:

   338

			if (flags & DC_AUTO) return_cmd_error(STR_2004_BUILDING_MUST_BE_DEMOLISHED);

   339

			return RemoveShipDepot(tile, flags);

   340

   341

		default:

   342

			NOT_REACHED();

   343

	}

   344

}

   345

   346

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

   347

static bool IsWateredTile(TileIndex tile)

   348

{

   349

	switch (GetTileType(tile)) {

   350

		case MP_WATER:

   351

			if (!IsCoast(tile)) return true;

   352

   353

			switch (GetTileSlope(tile, NULL)) {

   354

				case SLOPE_W:

   355

				case SLOPE_S:

   356

				case SLOPE_E:

   357

				case SLOPE_N:

   358

					return true;

   359

   360

				default:

   361

					return false;

   362

			}

   363

   364

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

   365

		default:         return false;

   366

	}

   367

}

   368

   369

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

   370

void DrawCanalWater(TileIndex tile)

   371

{

   372

	uint wa;

   373

   374

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

   375

	SpriteID dikes_base = GetCanalSprite(CF_DIKES, tile);

   376

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

   377

   378

	/* determine the edges around with water. */

   379

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

   380

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

   381

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

   382

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

   383

   384

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

   385

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

   386

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

   387

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

   388

   389

	/* right corner */

   390

	switch (wa & 0x03) {

   391

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

   392

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

   393

	}

   394

   395

	/* bottom corner */

   396

	switch (wa & 0x06) {

   397

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

   398

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

   399

	}

   400

   401

	/* left corner */

   402

	switch (wa & 0x0C) {

   403

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

   404

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

   405

	}

   406

   407

	/* upper corner */

   408

	switch (wa & 0x09) {

   409

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

   410

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

   411

	}

   412

}

   413

   414

struct LocksDrawTileStruct {

   415

	int8 delta_x, delta_y, delta_z;

   416

	byte width, height, depth;

   417

	SpriteID image;

   418

};

   419

   420

#include "table/water_land.h"

   421

   422

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

   423

	SpriteID palette, uint base

   424

)

   425

{

   426

	SpriteID image;

   427

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

   428

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

   429

   430

	/* If no custom graphics, use defaults */

   431

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

   432

	if (locks_base == 0) {

   433

		locks_base = SPR_CANALS_BASE + 9;

   434

	} else {

   435

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

   436

		base = 0;

   437

	}

   438

   439

	image = wdts++->image;

   440

	if (image < 4) image += water_base;

   441

	DrawGroundSprite(image, PAL_NONE);

   442

   443

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

   445

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

   446

			wdts->width, wdts->height,

   449

	}

   450

}

   451

   452

static void DrawTile_Water(TileInfo *ti)

   453

{

   454

	switch (GetWaterTileType(ti->tile)) {

   455

		case WATER_TILE_CLEAR:

   456

			DrawGroundSprite(SPR_FLAT_WATER_TILE, PAL_NONE);

   457

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

   458

			DrawBridgeMiddle(ti);

   459

			break;

   460

   461

		case WATER_TILE_COAST:

   462

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

   463

			if (_coast_base != 0) {

   464

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

   465

			} else {

   466

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

   467

			}

   468

			DrawBridgeMiddle(ti);

   469

			break;

   470

   471

		case WATER_TILE_LOCK: {

   472

			const WaterDrawTileStruct *t = _shiplift_display_seq[GetSection(ti->tile)];

   473

			DrawWaterStuff(ti, t, 0, ti->z > t[3].delta_y ? 24 : 0);

   474

		} break;

   475

   476

		case WATER_TILE_DEPOT:

   477

			DrawWaterStuff(ti, _shipdepot_display_seq[GetSection(ti->tile)], PLAYER_SPRITE_COLOR(GetTileOwner(ti->tile)), 0);

   478

			break;

   479

	}

   480

}

   481

   482

void DrawShipDepotSprite(int x, int y, int image)

   483

{

   484

	const WaterDrawTileStruct *wdts = _shipdepot_display_seq[image];

   485