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"

    14

#include "landscape.h"

    15

#include "map.h"

    16

#include "vehicle.h"

    17

#include "viewport.h"

    18

#include "command_func.h"

    19

#include "town.h"

    20

#include "news.h"

    21

#include "sound.h"

    22

#include "depot.h"

    23

#include "vehicle_gui.h"

    24

#include "train.h"

    25

#include "roadveh.h"

    26

#include "water.h"

    27

#include "water_map.h"

    28

#include "industry_map.h"

    29

#include "newgrf.h"

    30

#include "newgrf_canal.h"

    31

#include "misc/autoptr.hpp"

    32

#include "transparency.h"

    33

#include "strings_func.h"

    34

    35

/** Array for the shore sprites */

    36

static const SpriteID _water_shore_sprites[] = {

    37

	0,

    38

	SPR_SHORE_TILEH_1,  // SLOPE_W

    39

	SPR_SHORE_TILEH_2,  // SLOPE_S

    40

	SPR_SHORE_TILEH_3,  // SLOPE_SW

    41

	SPR_SHORE_TILEH_4,  // SLOPE_E

    42

	0,

    43

	SPR_SHORE_TILEH_6,  // SLOPE_SE

    44

	0,

    45

	SPR_SHORE_TILEH_8,  // SLOPE_N

    46

	SPR_SHORE_TILEH_9,  // SLOPE_NW

    47

	0,

    48

	0,

    49

	SPR_SHORE_TILEH_12, // SLOPE_NE

    50

	0,

    51

	0

    52

};

    53

    54

    55

static Vehicle *FindFloodableVehicleOnTile(TileIndex tile);

    56

static void FloodVehicle(Vehicle *v);

    57

    58

/**

    59

 * Makes a tile canal or water depending on the surroundings.

    60

 * This as for example docks and shipdepots do not store

    61

 * whether the tile used to be canal or 'normal' water.

    62

 * @param t the tile to change.

    63

 * @param o the owner of the new tile.

    64

 */

    65

void MakeWaterOrCanalDependingOnSurroundings(TileIndex t, Owner o)

    66

{

    67

	assert(GetTileSlope(t, NULL) == SLOPE_FLAT);

    68

    69

	/* Mark tile dirty in all cases */

    70

	MarkTileDirtyByTile(t);

    71

    72

	/* Non-sealevel -> canal */

    73

	if (TileHeight(t) != 0) {

    74

		MakeCanal(t, o);

    75

		return;

    76

	}

    77

    78

	bool has_water = false;

    79

	bool has_canal = false;

    80

    81

	for (DiagDirection dir = DIAGDIR_BEGIN; dir < DIAGDIR_END; dir++) {

    82

		TileIndex neighbour = TileAddByDiagDir(t, dir);

    83

		if (IsTileType(neighbour, MP_WATER)) {

    84

			has_water |= IsSea(neighbour) || IsCoast(neighbour) || (IsShipDepot(neighbour) && GetShipDepotWaterOwner(neighbour) == OWNER_WATER);

    85

			has_canal |= IsCanal(neighbour) || (IsShipDepot(neighbour) && GetShipDepotWaterOwner(neighbour) != OWNER_WATER);

    86

		}

    87

	}

    88

	if (has_canal || !has_water) {

    89

		MakeCanal(t, o);

    90

	} else {

    91

		MakeWater(t);

    92

	}

    93

}

    94

    95

    96

/** Build a ship depot.

    97

 * @param tile tile where ship depot is built

    98

 * @param flags type of operation

    99

 * @param p1 bit 0 depot orientation (Axis)

   100

 * @param p2 unused

   101

 */

   102

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

   103

{

   104

	TileIndex tile2;

   105

   106

	CommandCost cost, ret;

   107

   108

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   109

   110

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

   111

   112

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

   113

   114

	if (!IsWaterTile(tile) || !IsWaterTile(tile2))

   115

		return_cmd_error(STR_3801_MUST_BE_BUILT_ON_WATER);

   116

   117

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

   118

   119

	Owner o1 = GetTileOwner(tile);

   120

	Owner o2 = GetTileOwner(tile2);

   121

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

   122

	if (CmdFailed(ret)) return CMD_ERROR;

   123

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

   124

	if (CmdFailed(ret)) return CMD_ERROR;

   125

   126

	Depot *depot = new Depot(tile);

   127

	if (depot == NULL) return CMD_ERROR;

   128

	AutoPtrT<Depot> d_auto_delete = depot;

   129

   130

	if (flags & DC_EXEC) {

   131

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

   132

   133

		MakeShipDepot(tile,  _current_player, DEPOT_NORTH, axis, o1);

   134

		MakeShipDepot(tile2, _current_player, DEPOT_SOUTH, axis, o2);

   135

		MarkTileDirtyByTile(tile);

   136

		MarkTileDirtyByTile(tile2);

   137

		d_auto_delete.Detach();

   138

	}

   139

   140

	return cost.AddCost(_price.build_ship_depot);

   141

}

   142

   143

void MakeWaterOrCanalDependingOnOwner(TileIndex tile, Owner o)

   144

{

   145

	if (o == OWNER_WATER) {

   146

		MakeWater(tile);

   147

	} else {

   148

		MakeCanal(tile, o);

   149

	}

   150

}

   151

   152

static CommandCost RemoveShipDepot(TileIndex tile, uint32 flags)

   153

{

   154

	TileIndex tile2;

   155

   156

	if (!IsShipDepot(tile)) return CMD_ERROR;

   157

	if (!CheckTileOwnership(tile)) return CMD_ERROR;

   158

	if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   159

   160

	tile2 = GetOtherShipDepotTile(tile);

   161

   162

	if (!EnsureNoVehicleOnGround(tile2)) return CMD_ERROR;

   163

   164

	if (flags & DC_EXEC) {

   165

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

   166

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

   167

   168

		MakeWaterOrCanalDependingOnOwner(tile,  GetShipDepotWaterOwner(tile));

   169

		MakeWaterOrCanalDependingOnOwner(tile2, GetShipDepotWaterOwner(tile2));

   170

		MarkTileDirtyByTile(tile);

   171

		MarkTileDirtyByTile(tile2);

   172

	}

   173

   174

	return CommandCost(_price.remove_ship_depot);

   175

}

   176

   177

/** build a shiplift */

   178

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

   179

{

   180

	CommandCost ret;

   181

	int delta;

   182

   183

	/* middle tile */

   184

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

   185

	if (CmdFailed(ret)) return CMD_ERROR;

   186

   187

	delta = TileOffsByDiagDir(dir);

   188

	/* lower tile */

   189

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

   190

	if (CmdFailed(ret)) return CMD_ERROR;

   191

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

   192

		return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   193

	}

   194

   195

	/* upper tile */

   196

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

   197

	if (CmdFailed(ret)) return CMD_ERROR;

   198

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

   199

		return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   200

	}

   201

   202

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

   203

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

   204

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

   205

		return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   206

	}

   207

   208

	if (flags & DC_EXEC) {

   209

		MakeLock(tile, _current_player, dir);

   210

		MarkTileDirtyByTile(tile);

   211

		MarkTileDirtyByTile(tile - delta);

   212

		MarkTileDirtyByTile(tile + delta);

   213

	}

   214

   215

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

   216

}

   217

   218

static CommandCost RemoveShiplift(TileIndex tile, uint32 flags)

   219

{

   220

	TileIndexDiff delta = TileOffsByDiagDir(GetLockDirection(tile));

   221

   222

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

   223

   224

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

   225

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

   226

		return CMD_ERROR;

   227

   228

	if (flags & DC_EXEC) {

   229

		DoClearSquare(tile);

   230

		MakeWaterOrCanalDependingOnSurroundings(tile + delta, _current_player);

   231

		MakeWaterOrCanalDependingOnSurroundings(tile - delta, _current_player);

   232

	}

   233

   234

	return CommandCost(_price.clear_water * 2);

   235

}

   236

   237

/**

   238

 * Marks the tiles around a tile as dirty.

   239

 *

   240

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

   241

 *

   242

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

   243

 * @ingroup dirty

   244

 * @see TerraformAddDirtyTileAround

   245

 */

   246

static void MarkTilesAroundDirty(TileIndex tile)

   247

{

   248

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

   249

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

   250

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

   251

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

   252

}

   253

   254

/** Builds a lock (ship-lift)

   255

 * @param tile tile where to place the lock

   256

 * @param flags type of operation

   257

 * @param p1 unused

   258

 * @param p2 unused

   259

 */

   260

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

   261

{

   262

	DiagDirection dir;

   263

   264

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   265

   266

	switch (GetTileSlope(tile, NULL)) {

   267

		case SLOPE_SW: dir = DIAGDIR_SW; break;

   268

		case SLOPE_SE: dir = DIAGDIR_SE; break;

   269

		case SLOPE_NW: dir = DIAGDIR_NW; break;

   270

		case SLOPE_NE: dir = DIAGDIR_NE; break;

   271

		default: return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   272

	}

   273

	return DoBuildShiplift(tile, dir, flags);

   274

}

   275

   276

/** Build a piece of canal.

   277

 * @param tile end tile of stretch-dragging

   278

 * @param flags type of operation

   279

 * @param p1 start tile of stretch-dragging

   280

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

   281

 */

   282

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

   283

{

   284

	CommandCost cost;

   285

	int size_x, size_y;

   286

	int x;

   287

	int y;

   288

	int sx, sy;

   289

   290

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

   291

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

   292

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

   293

   294

	x = TileX(tile);

   295

	y = TileY(tile);

   296

	sx = TileX(p1);

   297

	sy = TileY(p1);

   298

   299

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   300

   301

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

   302

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

   303

	size_x = (x - sx) + 1;

   304

	size_y = (y - sy) + 1;

   305

   306

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

   307

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

   308

   309

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

   310

		CommandCost ret;

   311

   312

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

   313

			return_cmd_error(STR_0007_FLAT_LAND_REQUIRED);

   314

		}

   315

   316

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

   317

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

   318

   319

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

   320

		if (CmdFailed(ret)) return ret;

   321

		cost.AddCost(ret);

   322

   323

		if (flags & DC_EXEC) {

   324

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

   325

				MakeWater(tile);

   326

			} else {

   327

				MakeCanal(tile, _current_player);

   328

			}

   329

			MarkTileDirtyByTile(tile);

   330

			MarkTilesAroundDirty(tile);

   331

		}

   332

   333

		cost.AddCost(_price.clear_water);

   334

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

   335

   336

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

   337

		return_cmd_error(STR_1007_ALREADY_BUILT);

   338

	} else {

   339

		return cost;

   340

	}

   341

}

   342

   343

static CommandCost ClearTile_Water(TileIndex tile, byte flags)

   344

{

   345

	switch (GetWaterTileType(tile)) {

   346

		case WATER_TILE_CLEAR:

   347

			if (flags & DC_NO_WATER) return_cmd_error(STR_3807_CAN_T_BUILD_ON_WATER);

   348

   349

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

   350

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

   351

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

   352

				return_cmd_error(STR_0002_TOO_CLOSE_TO_EDGE_OF_MAP);

   353

			}

   354

   355

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

   356

			if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   357

   358

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

   359

   360

			if (flags & DC_EXEC) DoClearSquare(tile);

   361

			return CommandCost(_price.clear_water);

   362

   363

		case WATER_TILE_COAST: {

   364

			Slope slope = GetTileSlope(tile, NULL);

   365

   366

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

   367

			if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   368

   369

			if (flags & DC_EXEC) DoClearSquare(tile);

   370

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

   371

				return CommandCost(_price.clear_water);

   372

			} else {

   373

				return CommandCost(_price.clear_roughland);

   374

			}

   375

		}

   376

   377

		case WATER_TILE_LOCK: {

   378

			static const TileIndexDiffC _shiplift_tomiddle_offs[] = {

   379

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

   380

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

   381

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

   382

			};

   383

   384

			if (flags & DC_AUTO) return_cmd_error(STR_2004_BUILDING_MUST_BE_DEMOLISHED);

   385

			if (_current_player == OWNER_WATER) return CMD_ERROR;

   386

			/* move to the middle tile.. */

   387

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

   388

		}

   389

   390

		case WATER_TILE_DEPOT:

   391

			if (flags & DC_AUTO) return_cmd_error(STR_2004_BUILDING_MUST_BE_DEMOLISHED);

   392

			return RemoveShipDepot(tile, flags);

   393

   394

		default:

   395

			NOT_REACHED();

   396

	}

   397

}

   398

   399

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

   400

static bool IsWateredTile(TileIndex tile)

   401

{

   402

	switch (GetTileType(tile)) {

   403

		case MP_WATER:

   404

			if (!IsCoast(tile)) return true;

   405

   406

			switch (GetTileSlope(tile, NULL)) {

   407

				case SLOPE_W:

   408

				case SLOPE_S:

   409

				case SLOPE_E:

   410

				case SLOPE_N:

   411

					return true;

   412

   413

				default:

   414

					return false;

   415

			}

   416

   417

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

   418

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

   419

		default:          return false;

   420

	}

   421

}

   422

   423

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

   424

void DrawCanalWater(TileIndex tile)

   425

{

   426

	uint wa;

   427

   428

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

   429

	SpriteID dikes_base = GetCanalSprite(CF_DIKES, tile);

   430

	if (dikes_base == 0) dikes_base = SPR_CANAL_DIKES_BASE;

   431

   432

	/* determine the edges around with water. */

   433

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

   434

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

   435

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

   436

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

   437

   438

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

   439

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

   440

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

   441

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

   442

   443

	/* right corner */

   444

	switch (wa & 0x03) {

   445

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

   446

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

   447

	}

   448

   449

	/* bottom corner */

   450

	switch (wa & 0x06) {

   451

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

   452

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

   453

	}

   454

   455

	/* left corner */

   456

	switch (wa & 0x0C) {

   457

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

   458

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

   459

	}

   460

   461

	/* upper corner */

   462

	switch (wa & 0x09) {

   463

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

   464

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

   465

	}

   466

}

   467

   468

struct LocksDrawTileStruct {

   469

	int8 delta_x, delta_y, delta_z;

   470

	byte width, height, depth;

   471

	SpriteID image;

   472

};

   473

   474

#include "table/water_land.h"

   475

   476

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

   477

	SpriteID palette, uint base

   478

)

   479

{

   480

	SpriteID image;

   481

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

   482

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

   483