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

    14

#include "landscape.h"

    15

#include "viewport.h"

    16

#include "command_func.h"

    17

#include "town.h"

    18

#include "news.h"

    19

#include "depot.h"

    20

#include "vehicle_gui.h"

    21

#include "train.h"

    22

#include "roadveh.h"

    23

#include "water.h"

    24

#include "water_map.h"

    25

#include "industry_map.h"

    26

#include "newgrf.h"

    27

#include "newgrf_canal.h"

    28

#include "misc/autoptr.hpp"

    29

#include "transparency.h"

    30

#include "strings_func.h"

    31

#include "functions.h"

    32

#include "window_func.h"

    33

#include "vehicle_func.h"

    35

    36

/** Array for the shore sprites */

    37

static const SpriteID _water_shore_sprites[] = {

    38

	0,

    39

	SPR_SHORE_TILEH_1,  // SLOPE_W

    40

	SPR_SHORE_TILEH_2,  // SLOPE_S

    41

	SPR_SHORE_TILEH_3,  // SLOPE_SW

    42

	SPR_SHORE_TILEH_4,  // SLOPE_E

    43

	0,

    44

	SPR_SHORE_TILEH_6,  // SLOPE_SE

    45

	0,

    46

	SPR_SHORE_TILEH_8,  // SLOPE_N

    47

	SPR_SHORE_TILEH_9,  // SLOPE_NW

    48

	0,

    49

	0,

    50

	SPR_SHORE_TILEH_12, // SLOPE_NE

    51

	0,

    52

	0

    53

};

    54

    55

    56

static Vehicle *FindFloodableVehicleOnTile(TileIndex tile);

    57

static void FloodVehicle(Vehicle *v);

    58

    59

/**

    60

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

    61

 * This as for example docks and shipdepots do not store

    62

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

    63

 * @param t the tile to change.

    64

 * @param o the owner of the new tile.

    65

 */

    66

void MakeWaterOrCanalDependingOnSurroundings(TileIndex t, Owner o)

    67

{

    68

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

    69

    70

	/* Mark tile dirty in all cases */

    71

	MarkTileDirtyByTile(t);

    72

    73

	/* Non-sealevel -> canal */

    74

	if (TileHeight(t) != 0) {

    75

		MakeCanal(t, o);

    76

		return;

    77

	}

    78

    79

	bool has_water = false;

    80

	bool has_canal = false;

    81

    82

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

    83

		TileIndex neighbour = TileAddByDiagDir(t, dir);

    84

		if (IsTileType(neighbour, MP_WATER)) {

    85

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

    86

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

    87

		}

    88

	}

    89

	if (has_canal || !has_water) {

    90

		MakeCanal(t, o);

    91

	} else {

    92

		MakeWater(t);

    93

	}

    94

}

    95

    96

    97

/** Build a ship depot.

    98

 * @param tile tile where ship depot is built

    99

 * @param flags type of operation

   100

 * @param p1 bit 0 depot orientation (Axis)

   101

 * @param p2 unused

   102

 */

   103

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

   104

{

   105

	TileIndex tile2;

   106

   107

	CommandCost cost, ret;

   108

   109

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   110

   111

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

   112

   113

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

   114

   115

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

   116

		return_cmd_error(STR_3801_MUST_BE_BUILT_ON_WATER);

   117

   118

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

   119

   120

	Owner o1 = GetTileOwner(tile);

   121

	Owner o2 = GetTileOwner(tile2);

   122

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

   123

	if (CmdFailed(ret)) return CMD_ERROR;

   124

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

   125

	if (CmdFailed(ret)) return CMD_ERROR;

   126

   127

	Depot *depot = new Depot(tile);

   128

	if (depot == NULL) return CMD_ERROR;

   129

	AutoPtrT<Depot> d_auto_delete = depot;

   130

   131

	if (flags & DC_EXEC) {

   132

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

   133

   134

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

   135

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

   136

		MarkTileDirtyByTile(tile);

   137

		MarkTileDirtyByTile(tile2);

   138

		d_auto_delete.Detach();

   139

	}

   140

   141

	return cost.AddCost(_price.build_ship_depot);

   142

}

   143

   144

void MakeWaterOrCanalDependingOnOwner(TileIndex tile, Owner o)

   145

{

   146

	if (o == OWNER_WATER) {

   147

		MakeWater(tile);

   148

	} else {

   149

		MakeCanal(tile, o);

   150

	}

   151

}

   152

   153

static CommandCost RemoveShipDepot(TileIndex tile, uint32 flags)

   154

{

   155

	TileIndex tile2;

   156

   157

	if (!IsShipDepot(tile)) return CMD_ERROR;

   158

	if (!CheckTileOwnership(tile)) return CMD_ERROR;

   159

	if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   160

   161

	tile2 = GetOtherShipDepotTile(tile);

   162

   163

	if (!EnsureNoVehicleOnGround(tile2)) return CMD_ERROR;

   164

   165

	if (flags & DC_EXEC) {

   166

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

   167

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

   168

   169

		MakeWaterOrCanalDependingOnOwner(tile,  GetShipDepotWaterOwner(tile));

   170

		MakeWaterOrCanalDependingOnOwner(tile2, GetShipDepotWaterOwner(tile2));

   171

		MarkTileDirtyByTile(tile);

   172

		MarkTileDirtyByTile(tile2);

   173

	}

   174

   175

	return CommandCost(_price.remove_ship_depot);

   176

}

   177

   178

/** build a shiplift */

   179

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

   180

{

   181

	CommandCost ret;

   182

	int delta;

   183

   184

	/* middle tile */

   185

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

   186

	if (CmdFailed(ret)) return CMD_ERROR;

   187

   188

	delta = TileOffsByDiagDir(dir);

   189

	/* lower tile */

   190

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

   191

	if (CmdFailed(ret)) return CMD_ERROR;

   192

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

   193

		return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   194

	}

   195

   196

	/* upper tile */

   197

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

   198

	if (CmdFailed(ret)) return CMD_ERROR;

   199

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

   200

		return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   201

	}

   202

   203

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

   204

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

   205

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

   206

		return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   207

	}

   208

   209

	if (flags & DC_EXEC) {

   210

		MakeLock(tile, _current_player, dir);

   211

		MarkTileDirtyByTile(tile);

   212

		MarkTileDirtyByTile(tile - delta);

   213

		MarkTileDirtyByTile(tile + delta);

   214

	}

   215

   216

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

   217

}

   218

   219

static CommandCost RemoveShiplift(TileIndex tile, uint32 flags)

   220

{

   221

	TileIndexDiff delta = TileOffsByDiagDir(GetLockDirection(tile));

   222

   223

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

   224

   225

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

   226

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

   227

		return CMD_ERROR;

   228

   229

	if (flags & DC_EXEC) {

   230

		DoClearSquare(tile);

   231

		MakeWaterOrCanalDependingOnSurroundings(tile + delta, _current_player);

   232

		MakeWaterOrCanalDependingOnSurroundings(tile - delta, _current_player);

   233

	}

   234

   235

	return CommandCost(_price.clear_water * 2);

   236

}

   237

   238

/**

   239

 * Marks the tiles around a tile as dirty.

   240

 *

   241

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

   242

 *

   243

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

   244

 * @ingroup dirty

   245

 * @see TerraformAddDirtyTileAround

   246

 */

   247

static void MarkTilesAroundDirty(TileIndex tile)

   248

{

   249

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

   250

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

   251

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

   252

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

   253

}

   254

   255

/** Builds a lock (ship-lift)

   256

 * @param tile tile where to place the lock

   257

 * @param flags type of operation

   258

 * @param p1 unused

   259

 * @param p2 unused

   260

 */

   261

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

   262

{

   263

	DiagDirection dir;

   264

   265

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   266

   267

	switch (GetTileSlope(tile, NULL)) {

   268

		case SLOPE_SW: dir = DIAGDIR_SW; break;

   269

		case SLOPE_SE: dir = DIAGDIR_SE; break;

   270

		case SLOPE_NW: dir = DIAGDIR_NW; break;

   271

		case SLOPE_NE: dir = DIAGDIR_NE; break;

   272

		default: return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   273

	}

   274

	return DoBuildShiplift(tile, dir, flags);

   275

}

   276

   277

/** Build a piece of canal.

   278

 * @param tile end tile of stretch-dragging

   279

 * @param flags type of operation

   280

 * @param p1 start tile of stretch-dragging

   281

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

   282

 */

   283

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

   284

{

   285

	CommandCost cost;

   286

	int size_x, size_y;

   287

	int x;

   288

	int y;

   289

	int sx, sy;

   290

   291

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

   292

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

   293

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

   294

   295

	x = TileX(tile);

   296

	y = TileY(tile);

   297

	sx = TileX(p1);

   298

	sy = TileY(p1);

   299

   300

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   301

   302

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

   303

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

   304

	size_x = (x - sx) + 1;

   305

	size_y = (y - sy) + 1;

   306

   307

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

   308

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

   309

   310

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

   311

		CommandCost ret;

   312

   313

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

   314

			return_cmd_error(STR_0007_FLAT_LAND_REQUIRED);

   315

		}

   316

   317

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

   318

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

   319

   320

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

   321

		if (CmdFailed(ret)) return ret;

   322

		cost.AddCost(ret);

   323

   324

		if (flags & DC_EXEC) {

   325

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

   326

				MakeWater(tile);

   327

			} else {

   328

				MakeCanal(tile, _current_player);

   329

			}

   330

			MarkTileDirtyByTile(tile);

   331

			MarkTilesAroundDirty(tile);

   332

		}

   333

   334

		cost.AddCost(_price.clear_water);

   335

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

   336

   337

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

   338

		return_cmd_error(STR_1007_ALREADY_BUILT);

   339

	} else {

   340

		return cost;

   341

	}

   342

}

   343

   344

static CommandCost ClearTile_Water(TileIndex tile, byte flags)

   345

{

   346

	switch (GetWaterTileType(tile)) {

   347

		case WATER_TILE_CLEAR:

   348

			if (flags & DC_NO_WATER) return_cmd_error(STR_3807_CAN_T_BUILD_ON_WATER);

   349

   350

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

   351

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

   352

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

   353

				return_cmd_error(STR_0002_TOO_CLOSE_TO_EDGE_OF_MAP);

   354

			}

   355

   356

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

   357

			if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   358

   359

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

   360

   361

			if (flags & DC_EXEC) DoClearSquare(tile);

   362

			return CommandCost(_price.clear_water);

   363

   364

		case WATER_TILE_COAST: {

   365

			Slope slope = GetTileSlope(tile, NULL);

   366

   367

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

   368

			if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   369

   370

			if (flags & DC_EXEC) DoClearSquare(tile);

   371

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

   372

				return CommandCost(_price.clear_water);

   373

			} else {

   374

				return CommandCost(_price.clear_roughland);

   375

			}

   376

		}

   377

   378

		case WATER_TILE_LOCK: {

   379

			static const TileIndexDiffC _shiplift_tomiddle_offs[] = {

   380

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

   381

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

   382

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

   383

			};

   384

   385

			if (flags & DC_AUTO) return_cmd_error(STR_2004_BUILDING_MUST_BE_DEMOLISHED);

   386

			if (_current_player == OWNER_WATER) return CMD_ERROR;

   387

			/* move to the middle tile.. */

   388

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

   389

		}

   390

   391

		case WATER_TILE_DEPOT:

   392

			if (flags & DC_AUTO) return_cmd_error(STR_2004_BUILDING_MUST_BE_DEMOLISHED);

   393

			return RemoveShipDepot(tile, flags);

   394

   395

		default:

   396

			NOT_REACHED();

   397

	}

   398

}

   399

   400

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

   401

static bool IsWateredTile(TileIndex tile)

   402

{

   403

	switch (GetTileType(tile)) {

   404

		case MP_WATER:

   405

			if (!IsCoast(tile)) return true;

   406

   407

			switch (GetTileSlope(tile, NULL)) {

   408

				case SLOPE_W:

   409

				case SLOPE_S:

   410

				case SLOPE_E:

   411

				case SLOPE_N:

   412

					return true;

   413

   414

				default:

   415

					return false;

   416

			}

   417

   418

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

   419

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

   420

		default:          return false;

   421

	}

   422

}

   423

   424

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

   425

void DrawCanalWater(TileIndex tile)

   426

{

   427

	uint wa;

   428

   429

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

   430

	SpriteID dikes_base = GetCanalSprite(CF_DIKES, tile);

   431

	if (dikes_base == 0) dikes_base = SPR_CANAL_DIKES_BASE;

   432

   433

	/* determine the edges around with water. */

   434

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

   435

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

   436

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

   437

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

   438

   439

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

   440

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

   441

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

   442

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

   443

   444

	/* right corner */

   445

	switch (wa & 0x03) {

   446

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

   447

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

   448

	}

   449

   450

	/* bottom corner */

   451

	switch (wa & 0x06) {

   452

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

   453

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

   454

	}

   455

   456

	/* left corner */

   457

	switch (wa & 0x0C) {

   458

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

   459

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

   460

	}

   461

   462

	/* upper corner */

   463

	switch (wa & 0x09) {

   464

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

   465

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

   466

	}

   467

}

   468

   469

struct LocksDrawTileStruct {

   470

	int8 delta_x, delta_y, delta_z;

   471

	byte width, height, depth;

   472

	SpriteID image;

   473

};

   474

   475

#include "table/water_land.h"

   476

   477

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

   478

	SpriteID palette, uint base

   479

)

   480

{

   481

	SpriteID image;

   482

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

   483

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