1

/* $Id$ */

     2

     3

/** @file clear_cmd.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "clear_map.h"

     8

#include "rail_map.h"

     9

#include "table/strings.h"

    10

#include "player.h"

    11

#include "viewport.h"

    12

#include "command_func.h"

    13

#include "tunnel_map.h"

    14

#include "bridge_map.h"

    15

#include "bridge.h"

    16

#include "landscape.h"

    17

#include "variables.h"

    18

#include "table/sprites.h"

    19

#include "unmovable_map.h"

    20

#include "genworld.h"

    21

#include "industry.h"

    22

#include "water_map.h"

    23

#include "tile_cmd.h"

    24

#include "functions.h"

    25

#include "economy_func.h"

    26

#include "vehicle_func.h"

    27

    28

/*

    29

 * In one terraforming command all four corners of a initial tile can be raised/lowered (though this is not available to the player).

    30

 * The maximal amount of height modifications is archieved when raising a complete flat land from sea level to MAX_TILE_HEIGHT or vice versa.

    31

 * This affects all corners with a manhatten distance smaller than MAX_TILE_HEIGHT to one of the initial 4 corners.

    32

 * Their maximal amount is computed to 4 * \sum_{i=1}^{h_max} i  =  2 * h_max * (h_max + 1).

    33

 */

    34

static const int TERRAFORMER_MODHEIGHT_SIZE = 2 * MAX_TILE_HEIGHT * (MAX_TILE_HEIGHT + 1);

    35

    36

/*

    37

 * The maximal amount of affected tiles (i.e. the tiles that incident with one of the corners above, is computed similiar to

    38

 * 1 + 4 * \sum_{i=1}^{h_max} (i+1)  =  1 + 2 * h_max + (h_max + 3).

    39

 */

    40

static const int TERRAFORMER_TILE_TABLE_SIZE = 1 + 2 * MAX_TILE_HEIGHT * (MAX_TILE_HEIGHT + 3);

    41

    42

struct TerraformerHeightMod {

    43

	TileIndex tile;   ///< Referenced tile.

    44

	byte height;      ///< New TileHeight (height of north corner) of the tile.

    45

};

    46

    47

struct TerraformerState {

    48

	int modheight_count;                                         ///< amount of entries in "modheight".

    49

	int tile_table_count;                                        ///< amount of entries in "tile_table".

    50

    51

	/**

    52

	 * Dirty tiles, i.e.\ at least one corner changed.

    53

	 *

    54

	 * This array contains the tiles which are or will be marked as dirty.

    55

	 *

    56

	 * @ingroup dirty

    57

	 */

    58

	TileIndex tile_table[TERRAFORMER_TILE_TABLE_SIZE];

    59

	TerraformerHeightMod modheight[TERRAFORMER_MODHEIGHT_SIZE];  ///< Height modifications.

    60

};

    61

    62

/**

    63

 * Gets the TileHeight (height of north corner) of a tile as of current terraforming progress.

    64

 *

    65

 * @param ts TerraformerState.

    66

 * @param tile Tile.

    67

 * @return TileHeight.

    68

 */

    69

static int TerraformGetHeightOfTile(TerraformerState *ts, TileIndex tile)

    70

{

    71

	TerraformerHeightMod *mod = ts->modheight;

    72

	int count;

    73

    74

	for (count = ts->modheight_count; count != 0; count--, mod++) {

    75

		if (mod->tile == tile) return mod->height;

    76

	}

    77

    78

	/* TileHeight unchanged so far, read value from map. */

    79

	return TileHeight(tile);

    80

}

    81

    82

/**

    83

 * Stores the TileHeight (height of north corner) of a tile in a TerraformerState.

    84

 *

    85

 * @param ts TerraformerState.

    86

 * @param tile Tile.

    87

 * @param height New TileHeight.

    88

 */

    89

static void TerraformSetHeightOfTile(TerraformerState *ts, TileIndex tile, int height)

    90

{

    91

	/* Find tile in the "modheight" table.

    92

	 * Note: In a normal user-terraform command the tile will not be found in the "modheight" table.

    93

	 *       But during house- or industry-construction multiple corners can be terraformed at once. */

    94

	TerraformerHeightMod *mod = ts->modheight;

    95

	int count = ts->modheight_count;

    96

	while ((count > 0) && (mod->tile != tile)) {

    97

		mod++;

    98

		count--;

    99

	}

   100

   101

	/* New entry? */

   102

	if (count == 0) {

   103

		assert(ts->modheight_count < TERRAFORMER_MODHEIGHT_SIZE);

   104

		ts->modheight_count++;

   105

	}

   106

   107

	/* Finally store the new value */

   108

	mod->tile = tile;

   109

	mod->height = (byte)height;

   110

}

   111

   112

/**

   113

 * Adds a tile to the "tile_table" in a TerraformerState.

   114

 *

   115

 * @param ts TerraformerState.

   116

 * @param tile Tile.

   117

 * @ingroup dirty

   118

 */

   119

static void TerraformAddDirtyTile(TerraformerState *ts, TileIndex tile)

   120

{

   121

	int count;

   122

	TileIndex *t;

   123

   124

	count = ts->tile_table_count;

   125

   126

	for (t = ts->tile_table; count != 0; count--, t++) {

   127

		if (*t == tile) return;

   128

	}

   129

   130

	assert(ts->tile_table_count < TERRAFORMER_TILE_TABLE_SIZE);

   131

   132

	ts->tile_table[ts->tile_table_count++] = tile;

   133

}

   134

   135

/**

   136

 * Adds all tiles that incident with the north corner of a specific tile to the "tile_table" in a TerraformerState.

   137

 *

   138

 * @param ts TerraformerState.

   139

 * @param tile Tile.

   140

 * @ingroup dirty

   141

 */

   142

static void TerraformAddDirtyTileAround(TerraformerState *ts, TileIndex tile)

   143

{

   144

	TerraformAddDirtyTile(ts, tile + TileDiffXY( 0, -1));

   145

	TerraformAddDirtyTile(ts, tile + TileDiffXY(-1, -1));

   146

	TerraformAddDirtyTile(ts, tile + TileDiffXY(-1,  0));

   147

	TerraformAddDirtyTile(ts, tile);

   148

}

   149

   150

/**

   151

 * Terraform the north corner of a tile to a specific height.

   152

 *

   153

 * @param ts TerraformerState.

   154

 * @param tile Tile.

   155

 * @param height Aimed height.

   156

 * @param return Error code or cost.

   157

 */

   158

static CommandCost TerraformTileHeight(TerraformerState *ts, TileIndex tile, int height)

   159

{

   160

	CommandCost total_cost = CommandCost();

   161

   162

	assert(tile < MapSize());

   163

   164

	/* Check range of destination height */

   165

	if (height < 0) return_cmd_error(STR_1003_ALREADY_AT_SEA_LEVEL);

   166

	if (height > MAX_TILE_HEIGHT) return_cmd_error(STR_1004_TOO_HIGH);

   167

   168

	/*

   169

	 * Check if the terraforming has any effect.

   170

	 * This can only be true, if multiple corners of the start-tile are terraformed (i.e. the terraforming is done by towns/industries etc.).

   171

	 * In this case the terraforming should fail. (Don't know why.)

   172

	 */

   173

	if (height == TerraformGetHeightOfTile(ts, tile)) return CMD_ERROR;

   174

   175

	/* Check "too close to edge of map" */

   176

	uint x = TileX(tile);

   177

	uint y = TileY(tile);

   178

	if ((x <= 1) || (y <= 1) || (x >= MapMaxX() - 1) || (y >= MapMaxY() - 1)) {

   179

		/*

   180

		 * Determine a sensible error tile

   181

		 * Note: If x and y are both zero this will disable the error tile. (Tile 0 cannot be highlighted :( )

   182

		 */

   183

		if ((x == 1) && (y != 0)) x = 0;

   184

		if ((y == 1) && (x != 0)) y = 0;

   185

		_terraform_err_tile = TileXY(x, y);

   186

		return_cmd_error(STR_0002_TOO_CLOSE_TO_EDGE_OF_MAP);

   187

	}

   188

   189

	/* Mark incident tiles, that are involved in the terraforming */

   190

	TerraformAddDirtyTileAround(ts, tile);

   191

   192

	/* Store the height modification */

   193

	TerraformSetHeightOfTile(ts, tile, height);

   194

   195

	/* Increment cost */

   196

	total_cost.AddCost(_price.terraform);

   197

   198

	/* Recurse to neighboured corners if height difference is larger than 1 */

   199

	{

   200

		const TileIndexDiffC *ttm;

   201

   202

		static const TileIndexDiffC _terraform_tilepos[] = {

   203

			{ 1,  0}, // move to tile in SE

   204

			{-2,  0}, // undo last move, and move to tile in NW

   205

			{ 1,  1}, // undo last move, and move to tile in SW

   206

			{ 0, -2}  // undo last move, and move to tile in NE

   207

		};

   208

   209

		for (ttm = _terraform_tilepos; ttm != endof(_terraform_tilepos); ttm++) {

   210

			tile += ToTileIndexDiff(*ttm);

   211

   212

			/* Get TileHeight of neighboured tile as of current terraform progress */

   213

			int r = TerraformGetHeightOfTile(ts, tile);

   214

			int height_diff = height - r;

   215

   216

			/* Is the height difference to the neighboured corner greater than 1? */

   217

			if (abs(height_diff) > 1) {

   218

				/* Terraform the neighboured corner. The resulting height difference should be 1. */

   219

				height_diff += (height_diff < 0 ? 1 : -1);

   220

				CommandCost cost = TerraformTileHeight(ts, tile, r + height_diff);

   221

				if (CmdFailed(cost)) return cost;

   222

				total_cost.AddCost(cost);

   223

			}

   224

		}

   225

	}

   226

   227

	return total_cost;

   228

}

   229

   230

/** Terraform land

   231

 * @param tile tile to terraform

   232

 * @param flags for this command type

   233

 * @param p1 corners to terraform (SLOPE_xxx)

   234

 * @param p2 direction; eg up (non-zero) or down (zero)

   235

 * @return error or cost of terraforming

   236

 */

   237

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

   238

{

   239

	TerraformerState ts;

   240

	CommandCost total_cost = CommandCost();

   241

	int direction = (p2 != 0 ? 1 : -1);

   242

   243

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   244

   245

	_terraform_err_tile = 0;

   246

   247

	ts.modheight_count = ts.tile_table_count = 0;

   248

   249

	/* Make an extra check for map-bounds cause we add tiles to the originating tile */

   250

	if (tile + TileDiffXY(1, 1) >= MapSize()) return CMD_ERROR;

   251

   252

	/* Compute the costs and the terraforming result in a model of the landscape */

   253

	if ((p1 & SLOPE_W) != 0) {

   254

		TileIndex t = tile + TileDiffXY(1, 0);

   255

		CommandCost cost = TerraformTileHeight(&ts, t, TileHeight(t) + direction);

   256

		if (CmdFailed(cost)) return cost;

   257

		total_cost.AddCost(cost);

   258

	}

   259

   260

	if ((p1 & SLOPE_S) != 0) {

   261

		TileIndex t = tile + TileDiffXY(1, 1);

   262

		CommandCost cost = TerraformTileHeight(&ts, t, TileHeight(t) + direction);

   263

		if (CmdFailed(cost)) return cost;

   264

		total_cost.AddCost(cost);

   265

	}

   266

   267

	if ((p1 & SLOPE_E) != 0) {

   268

		TileIndex t = tile + TileDiffXY(0, 1);

   269

		CommandCost cost = TerraformTileHeight(&ts, t, TileHeight(t) + direction);

   270

		if (CmdFailed(cost)) return cost;

   271

		total_cost.AddCost(cost);

   272

	}

   273

   274

	if ((p1 & SLOPE_N) != 0) {

   275

		TileIndex t = tile + TileDiffXY(0, 0);

   276

		CommandCost cost = TerraformTileHeight(&ts, t, TileHeight(t) + direction);

   277

		if (CmdFailed(cost)) return cost;

   278

		total_cost.AddCost(cost);

   279

	}

   280

   281

	/* Check if the terraforming is valid wrt. tunnels, bridges and objects on the surface */

   282

	{

   283

		int count;

   284

		TileIndex *ti = ts.tile_table;

   285

   286

		for (count = ts.tile_table_count; count != 0; count--, ti++) {

   287

			TileIndex tile = *ti;

   288

   289

			/* Find new heights of tile corners */

   290

			uint z_N = TerraformGetHeightOfTile(&ts, tile + TileDiffXY(0, 0));

   291

			uint z_W = TerraformGetHeightOfTile(&ts, tile + TileDiffXY(1, 0));

   292

			uint z_S = TerraformGetHeightOfTile(&ts, tile + TileDiffXY(1, 1));

   293

			uint z_E = TerraformGetHeightOfTile(&ts, tile + TileDiffXY(0, 1));

   294

   295

			/* Find min and max height of tile */

   296

			uint z_min = min(min(z_N, z_W), min(z_S, z_E));

   297

			uint z_max = max(max(z_N, z_W), max(z_S, z_E));

   298

   299

			/* Compute tile slope */

   300

			uint tileh = (z_max > z_min + 1 ? SLOPE_STEEP : SLOPE_FLAT);

   301

			if (z_W > z_min) tileh += SLOPE_W;

   302

			if (z_S > z_min) tileh += SLOPE_S;

   303

			if (z_E > z_min) tileh += SLOPE_E;

   304

			if (z_N > z_min) tileh += SLOPE_N;

   305

   306

			/* Check if bridge would take damage */

   307

			if (direction == 1 && MayHaveBridgeAbove(tile) && IsBridgeAbove(tile) &&

   308

					GetBridgeHeight(GetSouthernBridgeEnd(tile)) <= z_max * TILE_HEIGHT) {

   309

				_terraform_err_tile = tile; // highlight the tile under the bridge

   310

				return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   311

			}

   312

			/* Check if tunnel would take damage */

   313

			if (direction == -1 && IsTunnelInWay(tile, z_min * TILE_HEIGHT)) {

   314

				_terraform_err_tile = tile; // highlight the tile above the tunnel

   315

				return_cmd_error(STR_1002_EXCAVATION_WOULD_DAMAGE);

   316

			}

   317

			/* Check tiletype-specific things, and add extra-cost */

   318

			CommandCost cost = _tile_type_procs[GetTileType(tile)]->terraform_tile_proc(tile, flags | DC_AUTO, z_min * TILE_HEIGHT, (Slope) tileh);

   319

			if (CmdFailed(cost)) {

   320

				_terraform_err_tile = tile;

   321

				return cost;

   322

			}

   323

			total_cost.AddCost(cost);

   324

		}

   325

	}

   326

   327

	if (flags & DC_EXEC) {

   328

		/* change the height */

   329

		{

   330

			int count;

   331

			TerraformerHeightMod *mod;

   332

   333

			mod = ts.modheight;

   334

			for (count = ts.modheight_count; count != 0; count--, mod++) {

   335

				TileIndex til = mod->tile;

   336

   337

				SetTileHeight(til, mod->height);

   338

			}

   339

		}

   340

   341

		/* finally mark the dirty tiles dirty */

   342

		{

   343

			int count;

   344

			TileIndex *ti = ts.tile_table;

   345

			for (count = ts.tile_table_count; count != 0; count--, ti++) {

   346

				MarkTileDirtyByTile(*ti);

   347

			}

   348

		}

   349

	}

   350

	return total_cost;

   351

}

   352

   353

   354

/** Levels a selected (rectangle) area of land

   355

 * @param tile end tile of area-drag

   356

 * @param flags for this command type

   357

 * @param p1 start tile of area drag

   359

 * @return  error or cost of terraforming

   360

 */

   361

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

   362

{

   363

	int size_x, size_y;

   364

	int ex;

   365

	int ey;

   366

	int sx, sy;

   368

	CommandCost money;

   369

	CommandCost ret;

   370

	CommandCost cost;

   371

   372

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

   373

   374

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   375

   376

	/* remember level height */

   384

   385

	/* make sure sx,sy are smaller than ex,ey */

   386

	ex = TileX(tile);

   387

	ey = TileY(tile);

   388

	sx = TileX(p1);

   389

	sy = TileY(p1);

   390

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

   391

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

   392

	tile = TileXY(sx, sy);

   393

   394

	size_x = ex - sx + 1;

   395

	size_y = ey - sy + 1;

   396

   397

	money.AddCost(GetAvailableMoneyForCommand());

   398

   399

	BEGIN_TILE_LOOP(tile2, size_x, size_y, tile) {

   400

		curh = TileHeight(tile2);

   401

		while (curh != h) {

   402

			ret = DoCommand(tile2, SLOPE_N, (curh > h) ? 0 : 1, flags & ~DC_EXEC, CMD_TERRAFORM_LAND);

   403

			if (CmdFailed(ret)) break;

   404

   405

			if (flags & DC_EXEC) {

   406

				money.AddCost(-ret.GetCost());

   407

				if (money.GetCost() < 0) {

   408

					_additional_cash_required = ret.GetCost();

   409

					return cost;

   410

				}

   411

				DoCommand(tile2, SLOPE_N, (curh > h) ? 0 : 1, flags, CMD_TERRAFORM_LAND);

   412

			}

   413

   414

			cost.AddCost(ret);

   415

			curh += (curh > h) ? -1 : 1;

   416

		}

   417

	} END_TILE_LOOP(tile2, size_x, size_y, tile)

   418

   419

	return (cost.GetCost() == 0) ? CMD_ERROR : cost;

   420

}

   421

   422

/** Purchase a land area. Actually you only purchase one tile, so

   423

 * the name is a bit confusing ;p

   424

 * @param tile the tile the player is purchasing

   425

 * @param flags for this command type

   426

 * @param p1 unused

   427

 * @param p2 unused

   428

 * @return error of cost of operation

   429

 */

   430

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

   431

{

   432

	CommandCost cost;

   433

   434

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   435

   436

	if (IsOwnedLandTile(tile) && IsTileOwner(tile, _current_player)) {

   437

		return_cmd_error(STR_5807_YOU_ALREADY_OWN_IT);

   438

	}

   439

   440

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

   441

	if (CmdFailed(cost)) return CMD_ERROR;

   442

   443

	if (flags & DC_EXEC) {

   444

		MakeOwnedLand(tile, _current_player);

   445

		MarkTileDirtyByTile(tile);

   446

	}

   447

   448

	return cost.AddCost(_price.clear_roughland * 10);

   449

}

   450

   451

   452

static CommandCost ClearTile_Clear(TileIndex tile, byte flags)

   453

{

   454

	static const Money* clear_price_table[] = {

   455

		&_price.clear_grass,

   456

		&_price.clear_roughland,

   457

		&_price.clear_rocks,

   458

		&_price.clear_fields,

   459

		&_price.clear_roughland,

   460

		&_price.clear_roughland,

   461

	};

   462

	CommandCost price;

   463

   464

	if (!IsClearGround(tile, CLEAR_GRASS) || GetClearDensity(tile) != 0) {

   465

		price.AddCost(*clear_price_table[GetClearGround(tile)]);

   466

	}

   467

   468

	if (flags & DC_EXEC) DoClearSquare(tile);

   469

   470

	return price;

   471

}

   472

   473

/** Sell a land area. Actually you only sell one tile, so

   474

 * the name is a bit confusing ;p

   475

 * @param tile the tile the player is selling

   476

 * @param flags for this command type

   477

 * @param p1 unused

   478

 * @param p2 unused

   479

 * @return error or cost of operation

   480

 */

   481

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

   482

{

   483

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   484

   485

	if (!IsOwnedLandTile(tile)) return CMD_ERROR;

   486

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

   487

   488