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

    11

#include "player.h"

    12

#include "viewport.h"

    13

#include "command_func.h"

    14

#include "tunnel_map.h"

    15

#include "bridge_map.h"

    16

#include "bridge.h"

    17

#include "landscape.h"

    18

#include "variables.h"

    19

#include "table/sprites.h"

    20

#include "unmovable_map.h"

    21

#include "genworld.h"

    22

#include "industry.h"

    23

#include "water_map.h"

    24

#include "tile_cmd.h"

    25

#include "vehicle.h"

    26

#include "functions.h"

    28

    29

/*

    30

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

    31

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

    32

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

    33

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

    34

 */

    35

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

    36

    37

/*

    38

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

    39

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

    40

 */

    41

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

    42

    43

struct TerraformerHeightMod {

    44

	TileIndex tile;   ///< Referenced tile.

    45

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

    46

};

    47

    48

struct TerraformerState {

    49

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

    50

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

    51

    52

	/**

    53

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

    54

	 *

    55

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

    56

	 *

    57

	 * @ingroup dirty

    58

	 */

    59

	TileIndex tile_table[TERRAFORMER_TILE_TABLE_SIZE];

    60

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

    61

};

    62

    63

/**

    64

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

    65

 *

    66

 * @param ts TerraformerState.

    67

 * @param tile Tile.

    68

 * @return TileHeight.

    69

 */

    70

static int TerraformGetHeightOfTile(TerraformerState *ts, TileIndex tile)

    71

{

    72

	TerraformerHeightMod *mod = ts->modheight;

    73

	int count;

    74

    75

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

    76

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

    77

	}

    78

    79

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

    80

	return TileHeight(tile);

    81

}

    82

    83

/**

    84

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

    85

 *

    86

 * @param ts TerraformerState.

    87

 * @param tile Tile.

    88

 * @param height New TileHeight.

    89

 */

    90

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

    91

{

    92

	/* Find tile in the "modheight" table.

    93

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

    94

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

    95

	TerraformerHeightMod *mod = ts->modheight;

    96

	int count = ts->modheight_count;

    97

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

    98

		mod++;

    99

		count--;

   100

	}

   101

   102

	/* New entry? */

   103

	if (count == 0) {

   104

		assert(ts->modheight_count < TERRAFORMER_MODHEIGHT_SIZE);

   105

		ts->modheight_count++;

   106

	}

   107

   108

	/* Finally store the new value */

   109

	mod->tile = tile;

   110

	mod->height = (byte)height;

   111

}

   112

   113

/**

   114

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

   115

 *

   116

 * @param ts TerraformerState.

   117

 * @param tile Tile.

   118

 * @ingroup dirty

   119

 */

   120

static void TerraformAddDirtyTile(TerraformerState *ts, TileIndex tile)

   121

{

   122

	int count;

   123

	TileIndex *t;

   124

   125

	count = ts->tile_table_count;

   126

   127

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

   128

		if (*t == tile) return;

   129

	}

   130

   131

	assert(ts->tile_table_count < TERRAFORMER_TILE_TABLE_SIZE);

   132

   133

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

   134

}

   135

   136

/**

   137

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

   138

 *

   139

 * @param ts TerraformerState.

   140

 * @param tile Tile.

   141

 * @ingroup dirty

   142

 */

   143

static void TerraformAddDirtyTileAround(TerraformerState *ts, TileIndex tile)

   144

{

   145

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

   146

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

   147

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

   148

	TerraformAddDirtyTile(ts, tile);

   149

}

   150

   151

/**

   152

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

   153

 *

   154

 * @param ts TerraformerState.

   155

 * @param tile Tile.

   156

 * @param height Aimed height.

   157

 * @param return Error code or cost.

   158

 */

   159

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

   160

{

   161

	CommandCost total_cost = CommandCost();

   162

   163

	assert(tile < MapSize());

   164

   165

	/* Check range of destination height */

   166

	if (height < 0) return_cmd_error(STR_1003_ALREADY_AT_SEA_LEVEL);

   167

	if (height > MAX_TILE_HEIGHT) return_cmd_error(STR_1004_TOO_HIGH);

   168

   169

	/*

   170

	 * Check if the terraforming has any effect.

   171

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

   172

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

   173

	 */

   174

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

   175

   176

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

   177

	uint x = TileX(tile);

   178

	uint y = TileY(tile);

   179

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

   180

		/*

   181

		 * Determine a sensible error tile

   182

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

   183

		 */

   184

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

   185

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

   186

		_terraform_err_tile = TileXY(x, y);

   187

		return_cmd_error(STR_0002_TOO_CLOSE_TO_EDGE_OF_MAP);

   188

	}

   189

   190

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

   191

	TerraformAddDirtyTileAround(ts, tile);

   192

   193

	/* Store the height modification */

   194

	TerraformSetHeightOfTile(ts, tile, height);

   195

   196

	/* Increment cost */

   197

	total_cost.AddCost(_price.terraform);

   198

   199

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

   200

	{

   201

		const TileIndexDiffC *ttm;

   202

   203

		static const TileIndexDiffC _terraform_tilepos[] = {

   204

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

   205

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

   206

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

   207

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

   208

		};

   209

   210

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

   211

			tile += ToTileIndexDiff(*ttm);

   212

   213

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

   214

			int r = TerraformGetHeightOfTile(ts, tile);

   215

			int height_diff = height - r;

   216

   217

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

   218

			if (abs(height_diff) > 1) {

   219

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

   220

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

   221

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

   222

				if (CmdFailed(cost)) return cost;

   223

				total_cost.AddCost(cost);

   224

			}

   225

		}

   226

	}

   227

   228

	return total_cost;

   229

}

   230

   231

/** Terraform land

   232

 * @param tile tile to terraform

   233

 * @param flags for this command type

   234

 * @param p1 corners to terraform (SLOPE_xxx)

   235

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

   236

 * @return error or cost of terraforming

   237

 */

   238

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

   239

{

   240

	TerraformerState ts;

   241

	CommandCost total_cost = CommandCost();

   242

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

   243

   244

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   245

   246

	_terraform_err_tile = 0;

   247

   248

	ts.modheight_count = ts.tile_table_count = 0;

   249

   250

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

   251

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

   252

   253

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

   254

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

   255

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

   256

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

   257

		if (CmdFailed(cost)) return cost;

   258

		total_cost.AddCost(cost);

   259

	}

   260

   261

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

   262

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

   263

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

   264

		if (CmdFailed(cost)) return cost;

   265

		total_cost.AddCost(cost);

   266

	}

   267

   268

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

   269

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

   270

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

   271

		if (CmdFailed(cost)) return cost;

   272

		total_cost.AddCost(cost);

   273

	}

   274

   275

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

   276

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

   277

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

   278

		if (CmdFailed(cost)) return cost;

   279

		total_cost.AddCost(cost);

   280

	}

   281

   282

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

   283

	{

   284

		int count;

   285

		TileIndex *ti = ts.tile_table;

   286

   287

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

   288

			TileIndex tile = *ti;

   289

   290

			/* Find new heights of tile corners */

   291

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

   292

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

   293

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

   294

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

   295

   296

			/* Find min and max height of tile */

   297

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

   298

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

   299

   300

			/* Compute tile slope */

   301

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

   302

			if (z_W > z_min) tileh += SLOPE_W;

   303

			if (z_S > z_min) tileh += SLOPE_S;

   304

			if (z_E > z_min) tileh += SLOPE_E;

   305

			if (z_N > z_min) tileh += SLOPE_N;

   306

   307

			/* Check if bridge would take damage */

   308

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

   309

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

   310

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

   311

				return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   312

			}

   313

			/* Check if tunnel would take damage */

   314

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

   315

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

   316

				return_cmd_error(STR_1002_EXCAVATION_WOULD_DAMAGE);

   317

			}

   318

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

   319

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

   320

			if (CmdFailed(cost)) {

   321

				_terraform_err_tile = tile;

   322

				return cost;

   323

			}

   324

			total_cost.AddCost(cost);

   325

		}

   326

	}

   327

   328

	if (flags & DC_EXEC) {

   329

		/* change the height */

   330

		{

   331

			int count;

   332

			TerraformerHeightMod *mod;

   333

   334

			mod = ts.modheight;

   335

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

   336

				TileIndex til = mod->tile;

   337

   338

				SetTileHeight(til, mod->height);

   339

			}

   340

		}

   341

   342

		/* finally mark the dirty tiles dirty */

   343

		{

   344

			int count;

   345

			TileIndex *ti = ts.tile_table;

   346

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

   347

				MarkTileDirtyByTile(*ti);

   348

			}

   349

		}

   350

	}

   351

	return total_cost;

   352

}

   353

   354

   355

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

   356

 * @param tile end tile of area-drag

   357

 * @param flags for this command type

   358

 * @param p1 start tile of area drag

   359

 * @param p2 unused

   360

 * @return  error or cost of terraforming

   361

 */

   362

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

   363

{

   364

	int size_x, size_y;

   365

	int ex;

   366

	int ey;

   367

	int sx, sy;

   368

	uint h, curh;

   369

	CommandCost money;

   370

	CommandCost ret;

   371

	CommandCost cost;

   372

   373

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

   374

   375

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   376

   377

	/* remember level height */

   378

	h = TileHeight(p1);

   379

   380

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

   381

	ex = TileX(tile);

   382

	ey = TileY(tile);

   383

	sx = TileX(p1);

   384

	sy = TileY(p1);

   385

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

   386

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

   387

	tile = TileXY(sx, sy);

   388

   389

	size_x = ex - sx + 1;

   390

	size_y = ey - sy + 1;

   391

   392

	money.AddCost(GetAvailableMoneyForCommand());

   393

   394

	BEGIN_TILE_LOOP(tile2, size_x, size_y, tile) {

   395

		curh = TileHeight(tile2);

   396

		while (curh != h) {

   397

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

   398

			if (CmdFailed(ret)) break;

   399

   400

			if (flags & DC_EXEC) {

   401

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

   402

				if (money.GetCost() < 0) {

   403

					_additional_cash_required = ret.GetCost();

   404

					return cost;

   405

				}

   406

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

   407

			}

   408

   409

			cost.AddCost(ret);

   410

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

   411

		}

   412

	} END_TILE_LOOP(tile2, size_x, size_y, tile)

   413

   414

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

   415

}

   416

   417

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

   418

 * the name is a bit confusing ;p

   419

 * @param tile the tile the player is purchasing

   420

 * @param flags for this command type

   421

 * @param p1 unused

   422

 * @param p2 unused

   423

 * @return error of cost of operation

   424

 */

   425

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

   426

{

   427

	CommandCost cost;

   428

   429

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   430

   431

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

   432

		return_cmd_error(STR_5807_YOU_ALREADY_OWN_IT);

   433

	}

   434

   435

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

   436

	if (CmdFailed(cost)) return CMD_ERROR;

   437

   438

	if (flags & DC_EXEC) {

   439

		MakeOwnedLand(tile, _current_player);

   440

		MarkTileDirtyByTile(tile);

   441

	}

   442

   443

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

   444

}

   445

   446

   447

static CommandCost ClearTile_Clear(TileIndex tile, byte flags)

   448

{

   449

	static const Money* clear_price_table[] = {

   450

		&_price.clear_grass,

   451

		&_price.clear_roughland,

   452

		&_price.clear_rocks,

   453

		&_price.clear_fields,

   454

		&_price.clear_roughland,

   455

		&_price.clear_roughland,

   456

	};

   457

	CommandCost price;

   458

   459

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

   460

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

   461

	}

   462

   463

	if (flags & DC_EXEC) DoClearSquare(tile);

   464

   465

	return price;

   466

}

   467

   468

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

   469

 * the name is a bit confusing ;p

   470

 * @param tile the tile the player is selling

   471

 * @param flags for this command type

   472

 * @param p1 unused

   473

 * @param p2 unused

   474

 * @return error or cost of operation

   475

 */

   476

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

   477

{

   478

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   479

   480

	if (!IsOwnedLandTile(tile)) return CMD_ERROR;

   481

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

   482

   483

   484

	if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   485

   486

	if (flags & DC_EXEC) DoClearSquare(tile);

   487

   488

	return CommandCost(- _price.clear_roughland * 2);