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"

    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

	if (!EnsureNoVehicle(tile)) return CMD_ERROR;

    71

    72

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

    73

    74

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

    75

	if (!EnsureNoVehicle(tile2)) return CMD_ERROR;

    76

    77

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

    78

		return_cmd_error(STR_3801_MUST_BE_BUILT_ON_WATER);

    79

    80

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

    81

    82

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

    83

	if (CmdFailed(ret)) return CMD_ERROR;

    84

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

    85

	if (CmdFailed(ret)) return CMD_ERROR;

    86

    87

	Depot *depot = new Depot(tile);

    88

	if (depot == NULL) return CMD_ERROR;

    89

	AutoPtrT<Depot> d_auto_delete = depot;

    90

    91

	if (flags & DC_EXEC) {

    92

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

    93

    94

		MakeShipDepot(tile,  _current_player, DEPOT_NORTH, axis);

    95

		MakeShipDepot(tile2, _current_player, DEPOT_SOUTH, axis);

    96

		MarkTileDirtyByTile(tile);

    97

		MarkTileDirtyByTile(tile2);

    98

		d_auto_delete.Detach();

    99

	}

   100

   101

	return cost.AddCost(_price.build_ship_depot);

   102

}

   103

   104

static CommandCost 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

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

   119

   120

		MakeWater(tile);

   121

		MakeWater(tile2);

   122

		MarkTileDirtyByTile(tile);

   123

		MarkTileDirtyByTile(tile2);

   124

	}

   125

   126

	return CommandCost(_price.remove_ship_depot);

   127

}

   128

   129

/** build a shiplift */

   130

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

   131

{

   132

	CommandCost 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 CommandCost(_price.clear_water * 22 >> 3);

   168

}

   169

   170

static CommandCost RemoveShiplift(TileIndex tile, uint32 flags)

   171

{

   172

	TileIndexDiff delta = TileOffsByDiagDir(GetLockDirection(tile));

   173

   174

	if (!CheckTileOwnership(tile) && GetTileOwner(tile) != OWNER_NONE) 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 CommandCost(_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

CommandCost 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

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

   226

{

   227

	CommandCost 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

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

   253

		CommandCost ret;

   254

   255

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

   256

			return_cmd_error(STR_0007_FLAT_LAND_REQUIRED);

   257

		}

   258

   259

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

   260

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

   261

   262

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

   263

		if (CmdFailed(ret)) return ret;

   264

		cost.AddCost(ret);

   265

   266

		if (flags & DC_EXEC) {

   267

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

   268

				MakeWater(tile);

   269

			} else {

   270

				MakeCanal(tile, _current_player);

   271

			}

   272

			MarkTileDirtyByTile(tile);

   273

			MarkTilesAroundDirty(tile);

   274

		}

   275

   276

		cost.AddCost(_price.clear_water);

   277

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

   278

   279

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

   280

		return_cmd_error(STR_1007_ALREADY_BUILT);

   281

	} else {

   282

		return cost;

   283

	}

   284

}

   285

   286

static CommandCost ClearTile_Water(TileIndex tile, byte flags)

   287

{

   288

	switch (GetWaterTileType(tile)) {

   289

		case WATER_TILE_CLEAR:

   290

			if (flags & DC_NO_WATER) return_cmd_error(STR_3807_CAN_T_BUILD_ON_WATER);

   291

   292

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

   293

			if (!EnsureNoVehicle(tile)) return CMD_ERROR;

   294

   295

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

   296

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

   297

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

   298

				return_cmd_error(STR_0002_TOO_CLOSE_TO_EDGE_OF_MAP);

   299

			}

   300

   301

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

   302

   303

			if (flags & DC_EXEC) DoClearSquare(tile);

   304

			return CommandCost(_price.clear_water);

   305

   306

		case WATER_TILE_COAST: {

   307

			Slope slope = GetTileSlope(tile, NULL);

   308

   309

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

   310

			if (!EnsureNoVehicle(tile)) return CMD_ERROR;

   311

   312

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

   313

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

   314

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

   315

				return_cmd_error(STR_0002_TOO_CLOSE_TO_EDGE_OF_MAP);

   316

			}

   317

   318

			if (flags & DC_EXEC) DoClearSquare(tile);

   319

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

   320

				return CommandCost(_price.clear_water);

   321

			} else {

   322

				return CommandCost(_price.purchase_land);

   323

			}

   324

		}

   325

   326

		case WATER_TILE_LOCK: {

   327

			static const TileIndexDiffC _shiplift_tomiddle_offs[] = {

   328

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

   329

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

   330

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

   331

			};

   332

   333

			if (flags & DC_AUTO) return_cmd_error(STR_2004_BUILDING_MUST_BE_DEMOLISHED);

   334

			if (_current_player == OWNER_WATER) return CMD_ERROR;

   335

			/* move to the middle tile.. */

   336

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

   337

		}

   338

   339

		case WATER_TILE_DEPOT:

   340

			if (flags & DC_AUTO) return_cmd_error(STR_2004_BUILDING_MUST_BE_DEMOLISHED);

   341

			return RemoveShipDepot(tile, flags);

   342

   343

		default:

   344

			NOT_REACHED();

   345

	}

   346

}

   347

   348

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

   349

static bool IsWateredTile(TileIndex tile)

   350

{

   351

	switch (GetTileType(tile)) {

   352

		case MP_WATER:

   353

			if (!IsCoast(tile)) return true;

   354

   355

			switch (GetTileSlope(tile, NULL)) {

   356

				case SLOPE_W:

   357

				case SLOPE_S:

   358

				case SLOPE_E:

   359

				case SLOPE_N:

   360

					return true;

   361

   362

				default:

   363

					return false;

   364

			}

   365

   369

	}

   370

}

   371

   372

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

   373

void DrawCanalWater(TileIndex tile)

   374

{

   375

	uint wa;

   376

   377

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

   378

	SpriteID dikes_base = GetCanalSprite(CF_DIKES, tile);

   379

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

   380

   381

	/* determine the edges around with water. */

   386

   387

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

   388

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

   389

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

   390

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

   391

   392

	/* right corner */

   393

	switch (wa & 0x03) {

   394

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

   395

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

   396

	}

   397

   398

	/* bottom corner */

   399

	switch (wa & 0x06) {

   400

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

   401

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

   402

	}

   403

   404

	/* left corner */

   405

	switch (wa & 0x0C) {

   406

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

   407

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

   408

	}

   409

   410

	/* upper corner */

   411

	switch (wa & 0x09) {

   412

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

   413

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

   414

	}

   415

}

   416

   417

struct LocksDrawTileStruct {

   418

	int8 delta_x, delta_y, delta_z;

   419

	byte width, height, depth;

   420

	SpriteID image;

   421

};

   422

   423

#include "table/water_land.h"

   424

   425

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

   426

	SpriteID palette, uint base

   427

)

   428

{

   429

	SpriteID image;

   430

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

   431

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

   432

   433

	/* If no custom graphics, use defaults */

   434

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

   435

	if (locks_base == 0) {

   436

		locks_base = SPR_CANALS_BASE + 9;

   437

	} else {

   438

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

   439

		base = 0;

   440

	}

   441

   442

	image = wdts++->image;

   443

	if (image < 4) image += water_base;

   444

	DrawGroundSprite(image, PAL_NONE);

   445

   446

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

   447

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

   448

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

   449

			wdts->width, wdts->height,

   450

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

   451

			HASBIT(_transparent_opt, TO_BUILDINGS));

   452

	}

   453

}

   454

   455

static void DrawTile_Water(TileInfo *ti)

   456

{

   457

	switch (GetWaterTileType(ti->tile)) {

   458

		case WATER_TILE_CLEAR:

   459

			DrawGroundSprite(SPR_FLAT_WATER_TILE, PAL_NONE);

   460

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

   461

			DrawBridgeMiddle(ti);

   462

			break;

   463

   464

		case WATER_TILE_COAST:

   465

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

   466

			if (_coast_base != 0) {

   467

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

   468

			} else {

   469

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

   470

			}

   471

			DrawBridgeMiddle(ti);

   472

			break;

   473

   474

		case WATER_TILE_LOCK: {

   475

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

   476

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

   477

		} break;

   478

   479

		case WATER_TILE_DEPOT:

   480

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

   481

			break;

   482

	}

   483

}

   484