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

#include "misc/autoptr.hpp"

    32

    33

static const SpriteID _water_shore_sprites[] = {

    34

	0,

    35

	SPR_SHORE_TILEH_1,

    36

	SPR_SHORE_TILEH_2,

    37

	SPR_SHORE_TILEH_3,

    38

	SPR_SHORE_TILEH_4,

    39

	0,

    40

	SPR_SHORE_TILEH_6,

    41

	0,

    42

	SPR_SHORE_TILEH_8,

    43

	SPR_SHORE_TILEH_9,

    44

	0,

    45

	0,

    46

	SPR_SHORE_TILEH_12,

    47

	0,

    48

	0

    49

};

    50

    51

    52

static Vehicle *FindFloodableVehicleOnTile(TileIndex tile);

    53

static void FloodVehicle(Vehicle *v);

    54

    55

/** Build a ship depot.

    56

 * @param tile tile where ship depot is built

    57

 * @param flags type of operation

    58

 * @param p1 bit 0 depot orientation (Axis)

    59

 * @param p2 unused

    60

 */

    61

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

    62

{

    63

	TileIndex tile2;

    64

    65

	CommandCost cost, ret;

    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 *depot = new Depot(tile);

    87

	if (depot == NULL) return CMD_ERROR;

    88

	AutoPtrT<Depot> d_auto_delete = depot;

    89

    90

	if (flags & DC_EXEC) {

    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

		d_auto_delete.Detach();

    98

	}

    99

   100

	return cost.AddCost(_price.build_ship_depot);

   101

}

   102

   103

static CommandCost RemoveShipDepot(TileIndex tile, uint32 flags)

   104

{

   105

	TileIndex tile2;

   106

   107

	if (!IsShipDepot(tile)) return CMD_ERROR;

   108

	if (!CheckTileOwnership(tile)) return CMD_ERROR;

   109

	if (!EnsureNoVehicle(tile)) return CMD_ERROR;

   110

   111

	tile2 = GetOtherShipDepotTile(tile);

   112

   113

	if (!EnsureNoVehicle(tile2)) return CMD_ERROR;

   114

   115

	if (flags & DC_EXEC) {

   116

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

   117

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

   118

   119

		MakeWater(tile);

   120

		MakeWater(tile2);

   121

		MarkTileDirtyByTile(tile);

   122

		MarkTileDirtyByTile(tile2);

   123

	}

   124

   125

	return CommandCost(_price.remove_ship_depot);

   126

}

   127

   128

/** build a shiplift */

   129

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

   130

{

   131

	CommandCost ret;

   132

	int delta;

   133

   134

	/* middle tile */

   135

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

   136

	if (CmdFailed(ret)) return CMD_ERROR;

   137

   138

	delta = TileOffsByDiagDir(dir);

   139

	/* lower tile */

   140

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

   141

	if (CmdFailed(ret)) return CMD_ERROR;

   142

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

   143

		return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   144

	}

   145

   146

	/* upper tile */

   147

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

   148

	if (CmdFailed(ret)) return CMD_ERROR;

   149

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

   150

		return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   151

	}

   152

   153

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

   154

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

   155

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

   156

		return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   157

	}

   158

   159

	if (flags & DC_EXEC) {

   160

		MakeLock(tile, _current_player, dir);

   161

		MarkTileDirtyByTile(tile);

   162

		MarkTileDirtyByTile(tile - delta);

   163

		MarkTileDirtyByTile(tile + delta);

   164

	}

   165

   166

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

   167

}

   168

   169

static CommandCost RemoveShiplift(TileIndex tile, uint32 flags)

   170

{

   171

	TileIndexDiff delta = TileOffsByDiagDir(GetLockDirection(tile));

   172

   173

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

   174

   175

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

   176

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

   177

		return CMD_ERROR;

   178

   179

	if (flags & DC_EXEC) {

   180

		DoClearSquare(tile);

   181

		DoClearSquare(tile + delta);

   182

		DoClearSquare(tile - delta);

   183

	}

   184

   185

	return CommandCost(_price.clear_water * 2);

   186

}

   187

   188

static void MarkTilesAroundDirty(TileIndex tile)

   189

{

   190

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

   191

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

   192

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

   193

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

   194

}

   195

   196

/** Builds a lock (ship-lift)

   197

 * @param tile tile where to place the lock

   198

 * @param flags type of operation

   199

 * @param p1 unused

   200

 * @param p2 unused

   201

 */

   202

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

   203

{

   204

	DiagDirection dir;

   205

   206

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   207

   208

	switch (GetTileSlope(tile, NULL)) {

   209

		case SLOPE_SW: dir = DIAGDIR_SW; break;

   210

		case SLOPE_SE: dir = DIAGDIR_SE; break;

   211

		case SLOPE_NW: dir = DIAGDIR_NW; break;

   212

		case SLOPE_NE: dir = DIAGDIR_NE; break;

   213

		default: return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   214

	}

   215

	return DoBuildShiplift(tile, dir, flags);

   216

}

   217

   218

/** Build a piece of canal.

   219

 * @param tile end tile of stretch-dragging

   220

 * @param flags type of operation

   221

 * @param p1 start tile of stretch-dragging

   222

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

   223

 */

   224

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

   225

{

   226

	CommandCost cost;

   227

	int size_x, size_y;

   228

	int x;

   229

	int y;

   230

	int sx, sy;

   231

   232

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

   233

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

   234

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

   235

   236

	x = TileX(tile);

   237

	y = TileY(tile);

   238

	sx = TileX(p1);

   239

	sy = TileY(p1);

   240

   241

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   242

   243

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

   244

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

   245

	size_x = (x - sx) + 1;

   246

	size_y = (y - sy) + 1;

   247

   248

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

   249

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

   250

   251

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

   252

		CommandCost ret;

   253

   254

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

   255

			return_cmd_error(STR_0007_FLAT_LAND_REQUIRED);

   256

		}

   257

   258

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

   259

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

   260

   261

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

   262

		if (CmdFailed(ret)) return ret;

   263

		cost.AddCost(ret);

   264

   265

		if (flags & DC_EXEC) {

   266

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

   267

				MakeWater(tile);

   268

			} else {

   269

				MakeCanal(tile, _current_player);

   270

			}

   271

			MarkTileDirtyByTile(tile);

   272

			MarkTilesAroundDirty(tile);

   273

		}

   274

   275

		cost.AddCost(_price.clear_water);

   276

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

   277

   278

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

   279

		return_cmd_error(STR_1007_ALREADY_BUILT);

   280

	} else {

   281

		return cost;

   282

	}

   283

}

   284

   285

static CommandCost ClearTile_Water(TileIndex tile, byte flags)

   286

{

   287

	switch (GetWaterTileType(tile)) {

   288

		case WATER_TILE_CLEAR:

   289

			if (flags & DC_NO_WATER) return_cmd_error(STR_3807_CAN_T_BUILD_ON_WATER);

   290

   291

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

   292

			if (!EnsureNoVehicle(tile)) return CMD_ERROR;

   293

   294

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

   295

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

   296

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

   297

				return_cmd_error(STR_0002_TOO_CLOSE_TO_EDGE_OF_MAP);

   298

			}

   299

   300

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

   301

   302

			if (flags & DC_EXEC) DoClearSquare(tile);

   303

			return CommandCost(_price.clear_water);

   304

   305

		case WATER_TILE_COAST: {

   306

			Slope slope = GetTileSlope(tile, NULL);

   307

   308

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

   309

			if (!EnsureNoVehicle(tile)) return CMD_ERROR;

   310

   311

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

   312

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

   313

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

   314

				return_cmd_error(STR_0002_TOO_CLOSE_TO_EDGE_OF_MAP);

   315

			}

   316

   317

			if (flags & DC_EXEC) DoClearSquare(tile);

   318

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

   319

				return CommandCost(_price.clear_water);

   320

			} else {

   321

				return CommandCost(_price.purchase_land);

   322

			}

   323

		}

   324

   325

		case WATER_TILE_LOCK: {

   326

			static const TileIndexDiffC _shiplift_tomiddle_offs[] = {

   327

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

   328

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

   329

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

   330

			};

   331

   332

			if (flags & DC_AUTO) return_cmd_error(STR_2004_BUILDING_MUST_BE_DEMOLISHED);

   333

			if (_current_player == OWNER_WATER) return CMD_ERROR;

   334

			/* move to the middle tile.. */

   335

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

   336

		}

   337

   338

		case WATER_TILE_DEPOT:

   339

			if (flags & DC_AUTO) return_cmd_error(STR_2004_BUILDING_MUST_BE_DEMOLISHED);

   340

			return RemoveShipDepot(tile, flags);

   341

   342

		default:

   343

			NOT_REACHED();

   344

	}

   345

}

   346

   347

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

   348

static bool IsWateredTile(TileIndex tile)

   349

{

   350

	switch (GetTileType(tile)) {

   351

		case MP_WATER:

   352

			if (!IsCoast(tile)) return true;

   353

   354

			switch (GetTileSlope(tile, NULL)) {

   355

				case SLOPE_W:

   356

				case SLOPE_S:

   357

				case SLOPE_E:

   358

				case SLOPE_N:

   359

					return true;

   360

   361

				default:

   362

					return false;

   363

			}

   364

   365

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

   366

		default:         return false;

   367

	}

   368

}

   369

   370

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

   371

void DrawCanalWater(TileIndex tile)

   372

{

   373

	uint wa;

   374

   375

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

   376

	SpriteID dikes_base = GetCanalSprite(CF_DIKES, tile);

   377

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

   378

   379

	/* determine the edges around with water. */

   380

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

   381

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

   382

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

   383

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

   384

   385

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

   386

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

   387

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

   388

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

   389

   390

	/* right corner */

   391

	switch (wa & 0x03) {

   392

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

   393

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

   394

	}

   395

   396

	/* bottom corner */

   397

	switch (wa & 0x06) {

   398

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

   399

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

   400

	}

   401

   402

	/* left corner */

   403

	switch (wa & 0x0C) {

   404

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

   405

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

   406

	}

   407

   408

	/* upper corner */

   409

	switch (wa & 0x09) {

   410

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

   411

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

   412

	}

   413

}

   414

   415

struct LocksDrawTileStruct {

   416

	int8 delta_x, delta_y, delta_z;

   417

	byte width, height, depth;

   418

	SpriteID image;

   419

};

   420

   421

#include "table/water_land.h"

   422

   423

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

   424

	SpriteID palette, uint base

   425

)

   426

{

   427

	SpriteID image;

   428

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

   429

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

   430

   431

	/* If no custom graphics, use defaults */

   432

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

   433

	if (locks_base == 0) {

   434

		locks_base = SPR_CANALS_BASE + 9;

   435

	} else {

   436

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

   437

		base = 0;

   438

	}

   439

   440

	image = wdts++->image;

   441

	if (image < 4) image += water_base;

   442

	DrawGroundSprite(image, PAL_NONE);

   443

   444

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

   445

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

   446

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

   447

			wdts->width, wdts->height,

   448

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

   449

			HASBIT(_transparent_opt, TO_BUILDINGS));

   450

	}

   451

}

   452

   453

static void DrawTile_Water(TileInfo *ti)

   454

{

   455

	switch (GetWaterTileType(ti->tile)) {

   456

		case WATER_TILE_CLEAR:

   457

			DrawGroundSprite(SPR_FLAT_WATER_TILE, PAL_NONE);

   458

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

   459

			DrawBridgeMiddle(ti);

   460

			break;

   461

   462

		case WATER_TILE_COAST:

   463

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

   464

			if (_coast_base != 0) {

   465

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

   466

			} else {

   467

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

   468

			}

   469

			DrawBridgeMiddle(ti);

   470

			break;

   471

   472

		case WATER_TILE_LOCK: {

   473

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

   474

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

   475

		} break;

   476

   477

		case WATER_TILE_DEPOT:

   478

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

   479

			break;

   480

	}

   481

}

   482

   483

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

   484

{