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

static const SpriteID _water_shore_sprites[] = {

    35

	0,

    36

	SPR_SHORE_TILEH_1,

    37

	SPR_SHORE_TILEH_2,

    38

	SPR_SHORE_TILEH_3,

    39

	SPR_SHORE_TILEH_4,

    40

	0,

    41

	SPR_SHORE_TILEH_6,

    42

	0,

    43

	SPR_SHORE_TILEH_8,

    44

	SPR_SHORE_TILEH_9,

    45

	0,

    46

	0,

    47

	SPR_SHORE_TILEH_12,

    48

	0,

    49

	0

    50

};

    51

    52

    53

static Vehicle *FindFloodableVehicleOnTile(TileIndex tile);

    54

static void FloodVehicle(Vehicle *v);

    55

    56

/** Build a ship depot.

    57

 * @param tile tile where ship depot is built

    58

 * @param flags type of operation

    59

 * @param p1 bit 0 depot orientation (Axis)

    60

 * @param p2 unused

    61

 */

    62

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

    63

{

    64

	TileIndex tile2;

    65

    66

	CommandCost cost, ret;

    67

    68

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

    69

    70

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

    71

    72

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

    73

    74

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

    75

		return_cmd_error(STR_3801_MUST_BE_BUILT_ON_WATER);

    76

    77

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

    78

    79

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

    80

	if (CmdFailed(ret)) return CMD_ERROR;

    81

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

    82

	if (CmdFailed(ret)) return CMD_ERROR;

    83

    84

	Depot *depot = new Depot(tile);

    85

	if (depot == NULL) return CMD_ERROR;

    86

	AutoPtrT<Depot> d_auto_delete = depot;

    87

    88

	if (flags & DC_EXEC) {

    89

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

    90

    91

		MakeShipDepot(tile,  _current_player, DEPOT_NORTH, axis);

    92

		MakeShipDepot(tile2, _current_player, DEPOT_SOUTH, axis);

    93

		MarkTileDirtyByTile(tile);

    94

		MarkTileDirtyByTile(tile2);

    95

		d_auto_delete.Detach();

    96

	}

    97

    98

	return cost.AddCost(_price.build_ship_depot);

    99

}

   100

   101

static CommandCost RemoveShipDepot(TileIndex tile, uint32 flags)

   102

{

   103

	TileIndex tile2;

   104

   105

	if (!IsShipDepot(tile)) return CMD_ERROR;

   106

	if (!CheckTileOwnership(tile)) return CMD_ERROR;

   107

	if (!EnsureNoVehicle(tile)) return CMD_ERROR;

   108

   109

	tile2 = GetOtherShipDepotTile(tile);

   110

   111

	if (!EnsureNoVehicle(tile2)) return CMD_ERROR;

   112

   113

	if (flags & DC_EXEC) {

   114

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

   115

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

   116

   117

		MakeWater(tile);

   118

		MakeWater(tile2);

   119

		MarkTileDirtyByTile(tile);

   120

		MarkTileDirtyByTile(tile2);

   121

	}

   122

   123

	return CommandCost(_price.remove_ship_depot);

   124

}

   125

   126

/** build a shiplift */

   127

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

   128

{

   129

	CommandCost ret;

   130

	int delta;

   131

   132

	/* middle tile */

   133

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

   134

	if (CmdFailed(ret)) return CMD_ERROR;

   135

   136

	delta = TileOffsByDiagDir(dir);

   137

	/* lower tile */

   138

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

   139

	if (CmdFailed(ret)) return CMD_ERROR;

   140

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

   141

		return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   142

	}

   143

   144

	/* upper tile */

   145

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

   146

	if (CmdFailed(ret)) return CMD_ERROR;

   147

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

   148

		return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   149

	}

   150

   151

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

   152

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

   153

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

   154

		return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   155

	}

   156

   157

	if (flags & DC_EXEC) {

   158

		MakeLock(tile, _current_player, dir);

   159

		MarkTileDirtyByTile(tile);

   160

		MarkTileDirtyByTile(tile - delta);

   161

		MarkTileDirtyByTile(tile + delta);

   162

	}

   163

   164

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

   165

}

   166

   167

static CommandCost RemoveShiplift(TileIndex tile, uint32 flags)

   168

{

   169

	TileIndexDiff delta = TileOffsByDiagDir(GetLockDirection(tile));

   170

   171

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

   172

   173

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

   174

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

   175

		return CMD_ERROR;

   176

   177

	if (flags & DC_EXEC) {

   178

		DoClearSquare(tile);

   179

		DoClearSquare(tile + delta);

   180

		DoClearSquare(tile - delta);

   181

	}

   182

   183

	return CommandCost(_price.clear_water * 2);

   184

}

   185

   186

static void MarkTilesAroundDirty(TileIndex tile)

   187

{

   188

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

   189

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

   190

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

   191

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

   192

}

   193

   194

/** Builds a lock (ship-lift)

   195

 * @param tile tile where to place the lock

   196

 * @param flags type of operation

   197

 * @param p1 unused

   198

 * @param p2 unused

   199

 */

   200

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

   201

{

   202

	DiagDirection dir;

   203

   204

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   205

   206

	switch (GetTileSlope(tile, NULL)) {

   207

		case SLOPE_SW: dir = DIAGDIR_SW; break;

   208

		case SLOPE_SE: dir = DIAGDIR_SE; break;

   209

		case SLOPE_NW: dir = DIAGDIR_NW; break;

   210

		case SLOPE_NE: dir = DIAGDIR_NE; break;

   211

		default: return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   212

	}

   213

	return DoBuildShiplift(tile, dir, flags);

   214

}

   215

   216

/** Build a piece of canal.

   217

 * @param tile end tile of stretch-dragging

   218

 * @param flags type of operation

   219

 * @param p1 start tile of stretch-dragging

   220

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

   221

 */

   222

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

   223

{

   224

	CommandCost cost;

   225

	int size_x, size_y;

   226

	int x;

   227

	int y;

   228

	int sx, sy;

   229

   230

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

   231

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

   232

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

   233

   234

	x = TileX(tile);

   235

	y = TileY(tile);

   236

	sx = TileX(p1);

   237

	sy = TileY(p1);

   238

   239

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   240

   241

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

   242

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

   243

	size_x = (x - sx) + 1;

   244

	size_y = (y - sy) + 1;

   245

   246

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

   247

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

   248

   249

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

   250

		CommandCost ret;

   251

   252

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

   253

			return_cmd_error(STR_0007_FLAT_LAND_REQUIRED);

   254

		}

   255

   256

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

   257

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

   258

   259

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

   260

		if (CmdFailed(ret)) return ret;

   261

		cost.AddCost(ret);

   262

   263

		if (flags & DC_EXEC) {

   264

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

   265

				MakeWater(tile);

   266

			} else {

   267

				MakeCanal(tile, _current_player);

   268

			}

   269

			MarkTileDirtyByTile(tile);

   270

			MarkTilesAroundDirty(tile);

   271

		}

   272

   273

		cost.AddCost(_price.clear_water);

   274

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

   275

   276

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

   277

		return_cmd_error(STR_1007_ALREADY_BUILT);

   278

	} else {

   279

		return cost;

   280

	}

   281

}

   282

   283

static CommandCost ClearTile_Water(TileIndex tile, byte flags)

   284

{

   285

	switch (GetWaterTileType(tile)) {

   286

		case WATER_TILE_CLEAR:

   287

			if (flags & DC_NO_WATER) return_cmd_error(STR_3807_CAN_T_BUILD_ON_WATER);

   288

   289

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

   290

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

   291

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

   292

				return_cmd_error(STR_0002_TOO_CLOSE_TO_EDGE_OF_MAP);

   293

			}

   294

   295

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

   296

			if (!EnsureNoVehicle(tile)) return CMD_ERROR;

   297

   298

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

   299

   300

			if (flags & DC_EXEC) DoClearSquare(tile);

   301

			return CommandCost(_price.clear_water);

   302

   303

		case WATER_TILE_COAST: {

   304

			Slope slope = GetTileSlope(tile, NULL);

   305

   306

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

   307

			if (!EnsureNoVehicle(tile)) return CMD_ERROR;

   308

   309

			if (flags & DC_EXEC) DoClearSquare(tile);

   310

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

   311

				return CommandCost(_price.clear_water);

   312

			} else {

   313

				return CommandCost(_price.purchase_land);

   314

			}

   315

		}

   316

   317

		case WATER_TILE_LOCK: {

   318

			static const TileIndexDiffC _shiplift_tomiddle_offs[] = {

   319

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

   320

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

   321

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

   322

			};

   323

   324

			if (flags & DC_AUTO) return_cmd_error(STR_2004_BUILDING_MUST_BE_DEMOLISHED);

   325

			if (_current_player == OWNER_WATER) return CMD_ERROR;

   326

			/* move to the middle tile.. */

   327

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

   328

		}

   329

   330

		case WATER_TILE_DEPOT:

   331

			if (flags & DC_AUTO) return_cmd_error(STR_2004_BUILDING_MUST_BE_DEMOLISHED);

   332

			return RemoveShipDepot(tile, flags);

   333

   334

		default:

   335

			NOT_REACHED();

   336

	}

   337

}

   338

   339

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

   340

static bool IsWateredTile(TileIndex tile)

   341

{

   342

	switch (GetTileType(tile)) {

   343

		case MP_WATER:

   344

			if (!IsCoast(tile)) return true;

   345

   346

			switch (GetTileSlope(tile, NULL)) {

   347

				case SLOPE_W:

   348

				case SLOPE_S:

   349

				case SLOPE_E:

   350

				case SLOPE_N:

   351

					return true;

   352

   353

				default:

   354

					return false;

   355

			}

   356

   357

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

   358

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

   359

		default:          return false;

   360

	}

   361

}

   362

   363

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

   364

void DrawCanalWater(TileIndex tile)

   365

{

   366

	uint wa;

   367

   368

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

   369

	SpriteID dikes_base = GetCanalSprite(CF_DIKES, tile);

   370

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

   371

   372

	/* determine the edges around with water. */

   373

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

   374

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

   375

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

   376

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

   377

   378

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

   379

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

   380

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

   381

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

   382

   383

	/* right corner */

   384

	switch (wa & 0x03) {

   385

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

   386

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

   387

	}

   388

   389

	/* bottom corner */

   390

	switch (wa & 0x06) {

   391

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

   392

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

   393

	}

   394

   395

	/* left corner */

   396

	switch (wa & 0x0C) {

   397

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

   398

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

   399

	}

   400

   401

	/* upper corner */

   402

	switch (wa & 0x09) {

   403

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

   404

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

   405

	}

   406

}

   407

   408

struct LocksDrawTileStruct {

   409

	int8 delta_x, delta_y, delta_z;

   410

	byte width, height, depth;

   411

	SpriteID image;

   412

};

   413

   414

#include "table/water_land.h"

   415

   416

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

   417

	SpriteID palette, uint base

   418

)

   419

{

   420

	SpriteID image;

   421

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

   422

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

   423

   424

	/* If no custom graphics, use defaults */

   425

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

   426

	if (locks_base == 0) {

   427

		locks_base = SPR_CANALS_BASE + 9;

   428

	} else {

   429

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

   430

		base = 0;

   431

	}

   432

   433

	image = wdts++->image;

   434

	if (image < 4) image += water_base;

   435

	DrawGroundSprite(image, PAL_NONE);

   436

   437

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

   438

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

   439

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

   440

			wdts->width, wdts->height,

   441

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

   442

			HASBIT(_transparent_opt, TO_BUILDINGS));

   443

	}

   444

}

   445

   446

static void DrawTile_Water(TileInfo *ti)

   447

{

   448

	switch (GetWaterTileType(ti->tile)) {

   449

		case WATER_TILE_CLEAR:

   450

			DrawGroundSprite(SPR_FLAT_WATER_TILE, PAL_NONE);

   451

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

   452

			DrawBridgeMiddle(ti);

   453

			break;

   454

   455

		case WATER_TILE_COAST:

   456

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

   457

			if (_coast_base != 0) {

   458

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

   459

			} else {

   460

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

   461

			}

   462

			DrawBridgeMiddle(ti);

   463

			break;

   464

   465

		case WATER_TILE_LOCK: {

   466

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

   467

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

   468

		} break;

   469

   470

		case WATER_TILE_DEPOT:

   471

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

   472

			break;

   473

	}

   474

}

   475

   476

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

   477

{

   478

	const WaterDrawTileStruct *wdts = _shipdepot_display_seq[image];

   479

   480

	DrawSprite(wdts++->image, PAL_NONE, x, y);

   481

   482

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

   483

		Point pt = RemapCoords(wdts->delta_x, wdts->delta_y, wdts->delta_z);

   484

		DrawSprite(wdts->image, PLAYER_SPRITE_COLOR(_local_player), x + pt.x, y + pt.y);