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

    30

#include "newgrf.h"

    31

#include "newgrf_canal.h"

    32

#include "misc/autoptr.hpp"

    33

    34

/** Array for the shore sprites */

    35

static const SpriteID _water_shore_sprites[] = {

    36

	0,

    37

	SPR_SHORE_TILEH_1,  // SLOPE_W

    38

	SPR_SHORE_TILEH_2,  // SLOPE_S

    39

	SPR_SHORE_TILEH_3,  // SLOPE_SW

    40

	SPR_SHORE_TILEH_4,  // SLOPE_E

    41

	0,

    42

	SPR_SHORE_TILEH_6,  // SLOPE_SE

    43

	0,

    44

	SPR_SHORE_TILEH_8,  // SLOPE_N

    45

	SPR_SHORE_TILEH_9,  // SLOPE_NW

    46

	0,

    47

	0,

    48

	SPR_SHORE_TILEH_12, // SLOPE_NE

    49

	0,

    50

	0

    51

};

    52

    53

    54

static Vehicle *FindFloodableVehicleOnTile(TileIndex tile);

    55

static void FloodVehicle(Vehicle *v);

    56

    57

/** Build a ship depot.

    58

 * @param tile tile where ship depot is built

    59

 * @param flags type of operation

    60

 * @param p1 bit 0 depot orientation (Axis)

    61

 * @param p2 unused

    62

 */

    63

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

    64

{

    65

	TileIndex tile2;

    66

    67

	CommandCost cost, ret;

    68

    69

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

    70

    71

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

    72

    73

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

    74

    75

	if (!IsWaterTile(tile) || !IsWaterTile(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

	Depot *depot = new Depot(tile);

    86

	if (depot == NULL) return CMD_ERROR;

    87

	AutoPtrT<Depot> d_auto_delete = depot;

    88

    89

	if (flags & DC_EXEC) {

    90

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

    91

    92

		MakeShipDepot(tile,  _current_player, DEPOT_NORTH, axis);

    93

		MakeShipDepot(tile2, _current_player, DEPOT_SOUTH, axis);

    94

		MarkTileDirtyByTile(tile);

    95

		MarkTileDirtyByTile(tile2);

    96

		d_auto_delete.Detach();

    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 (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   109

   110

	tile2 = GetOtherShipDepotTile(tile);

   111

   112

	if (!EnsureNoVehicleOnGround(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

		delete 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 (!EnsureNoVehicleOnGround(tile) || !EnsureNoVehicleOnGround(tile + delta) || !EnsureNoVehicleOnGround(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

/**

   188

 * Marks the tiles around a tile as dirty.

   189

 *

   190

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

   191

 *

   192

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

   193

 * @ingroup dirty

   194

 * @see TerraformAddDirtyTileAround

   195

 */

   196

static void MarkTilesAroundDirty(TileIndex tile)

   197

{

   198

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

   199

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

   200

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

   201

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

   202

}

   203

   204

/** Builds a lock (ship-lift)

   205

 * @param tile tile where to place the lock

   206

 * @param flags type of operation

   207

 * @param p1 unused

   208

 * @param p2 unused

   209

 */

   210

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

   211

{

   212

	DiagDirection dir;

   213

   214

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   215

   216

	switch (GetTileSlope(tile, NULL)) {

   217

		case SLOPE_SW: dir = DIAGDIR_SW; break;

   218

		case SLOPE_SE: dir = DIAGDIR_SE; break;

   219

		case SLOPE_NW: dir = DIAGDIR_NW; break;

   220

		case SLOPE_NE: dir = DIAGDIR_NE; break;

   221

		default: return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   222

	}

   223

	return DoBuildShiplift(tile, dir, flags);

   224

}

   225

   226

/** Build a piece of canal.

   227

 * @param tile end tile of stretch-dragging

   228

 * @param flags type of operation

   229

 * @param p1 start tile of stretch-dragging

   230

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

   231

 */

   232

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

   233

{

   234

	CommandCost cost;

   235

	int size_x, size_y;

   236

	int x;

   237

	int y;

   238

	int sx, sy;

   239

   240

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

   241

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

   242

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

   243

   244

	x = TileX(tile);

   245

	y = TileY(tile);

   246

	sx = TileX(p1);

   247

	sy = TileY(p1);

   248

   249

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   250

   251

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

   252

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

   253

	size_x = (x - sx) + 1;

   254

	size_y = (y - sy) + 1;

   255

   256

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

   257

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

   258

   259

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

   260

		CommandCost ret;

   261

   262

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

   263

			return_cmd_error(STR_0007_FLAT_LAND_REQUIRED);

   264

		}

   265

   266

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

   267

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

   268

   269

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

   270

		if (CmdFailed(ret)) return ret;

   271

		cost.AddCost(ret);

   272

   273

		if (flags & DC_EXEC) {

   274

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

   275

				MakeWater(tile);

   276

			} else {

   277

				MakeCanal(tile, _current_player);

   278

			}

   279

			MarkTileDirtyByTile(tile);

   280

			MarkTilesAroundDirty(tile);

   281

		}

   282

   283

		cost.AddCost(_price.clear_water);

   284

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

   285

   286

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

   287

		return_cmd_error(STR_1007_ALREADY_BUILT);

   288

	} else {

   289

		return cost;

   290

	}

   291

}

   292

   293

static CommandCost ClearTile_Water(TileIndex tile, byte flags)

   294

{

   295

	switch (GetWaterTileType(tile)) {

   296

		case WATER_TILE_CLEAR:

   297

			if (flags & DC_NO_WATER) return_cmd_error(STR_3807_CAN_T_BUILD_ON_WATER);

   298

   299

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

   300

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

   301

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

   302

				return_cmd_error(STR_0002_TOO_CLOSE_TO_EDGE_OF_MAP);

   303

			}

   304

   305

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

   306

			if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   307

   308

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

   309

   310

			if (flags & DC_EXEC) DoClearSquare(tile);

   311

			return CommandCost(_price.clear_water);

   312

   313

		case WATER_TILE_COAST: {

   314

			Slope slope = GetTileSlope(tile, NULL);

   315

   316

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

   317

			if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   318

   319

			if (flags & DC_EXEC) DoClearSquare(tile);

   320

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

   321

				return CommandCost(_price.clear_water);

   322

			} else {

   323

				return CommandCost(_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

	}

   347

}

   348

   349

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

   350

static bool IsWateredTile(TileIndex tile)

   351

{

   352

	switch (GetTileType(tile)) {

   353

		case MP_WATER:

   354

			if (!IsCoast(tile)) return true;

   355

   356

			switch (GetTileSlope(tile, NULL)) {

   357

				case SLOPE_W:

   358

				case SLOPE_S:

   359

				case SLOPE_E:

   360

				case SLOPE_N:

   361

					return true;

   362

   363

				default:

   364

					return false;

   365

			}

   366

   367

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

   368

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

   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

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

   449

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

   450

			wdts->width, wdts->height,

   451

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

   452

			HASBIT(_transparent_opt, TO_BUILDINGS));

   453

	}

   454

}

   455

   456

static void DrawTile_Water(TileInfo *ti)

   457

{

   458

	switch (GetWaterTileType(ti->tile)) {

   459

		case WATER_TILE_CLEAR:

   460

			DrawGroundSprite(SPR_FLAT_WATER_TILE, PAL_NONE);

   461

			if (IsCanal(ti->tile)) DrawCanalWater(ti->tile);

   462

			DrawBridgeMiddle(ti);

   463

			break;

   464

   465

		case WATER_TILE_COAST:

   466

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

   467

			if (_coast_base != 0) {

   468

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

   469

			} else {

   470

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

   471

			}

   472

			DrawBridgeMiddle(ti);

   473

			break;

   474

   475

		case WATER_TILE_LOCK: {

   476

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

   477

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

   478

		} break;

   479

   480

		case WATER_TILE_DEPOT:

   481

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

   482

			break;

   483

	}