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

    11

#include "map.h"

    12

#include "player.h"

    13

#include "viewport.h"

    14

#include "command.h"

    15

#include "tunnel_map.h"

    16

#include "bridge_map.h"

    17

#include "bridge.h"

    18

#include "landscape.h"

    19

#include "variables.h"

    20

#include "table/sprites.h"

    21

#include "unmovable_map.h"

    22

#include "genworld.h"

    23

#include "industry.h"

    24

#include "water_map.h"

    25

    26

/*

    27

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

    28

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

    29

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

    30

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

    31

 */

    32

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

    33

    34

/*

    35

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

    36

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

    37

 */

    38

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

    39

    40

struct TerraformerHeightMod {

    41

	TileIndex tile;   ///< Referenced tile.

    42

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

    43

};

    44

    45

struct TerraformerState {

    46

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

    47

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

    48

    49

	/**

    50

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

    51

	 *

    52

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

    53

	 *

    54

	 * @ingroup dirty

    55

	 */

    56

	TileIndex tile_table[TERRAFORMER_TILE_TABLE_SIZE];

    57

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

    58

};

    59

    60

/**

    61

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

    62

 *

    63

 * @param ts TerraformerState.

    64

 * @param tile Tile.

    65

 * @return TileHeight.

    66

 */

    67

static int TerraformGetHeightOfTile(TerraformerState *ts, TileIndex tile)

    68

{

    69

	TerraformerHeightMod *mod = ts->modheight;

    70

	int count;

    71

    72

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

    73

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

    74

	}

    75

    76

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

    77

	return TileHeight(tile);

    78

}

    79

    80

/**

    81

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

    82

 *

    83

 * @param ts TerraformerState.

    84

 * @param tile Tile.

    85

 * @param height New TileHeight.

    86

 */

    87

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

    88

{

    89

	/* Find tile in the "modheight" table.

    90

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

    91

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

    92

	TerraformerHeightMod *mod = ts->modheight;

    93

	int count = ts->modheight_count;

    94

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

    95

		mod++;

    96

		count--;

    97

	}

    98

    99

	/* New entry? */

   100

	if (count == 0) {

   101

		assert(ts->modheight_count < TERRAFORMER_MODHEIGHT_SIZE);

   102

		ts->modheight_count++;

   103

	}

   104

   105

	/* Finally store the new value */

   106

	mod->tile = tile;

   107

	mod->height = (byte)height;

   108

}

   109

   110

/**

   111

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

   112

 *

   113

 * @param ts TerraformerState.

   114

 * @param tile Tile.

   115

 * @ingroup dirty

   116

 */

   117

static void TerraformAddDirtyTile(TerraformerState *ts, TileIndex tile)

   118

{

   119

	int count;

   120

	TileIndex *t;

   121

   122

	count = ts->tile_table_count;

   123

   124

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

   125

		if (*t == tile) return;

   126

	}

   127

   128

	assert(ts->tile_table_count < TERRAFORMER_TILE_TABLE_SIZE);

   129

   130

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

   131

}

   132

   133

/**

   134

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

   135

 *

   136

 * @param ts TerraformerState.

   137

 * @param tile Tile.

   138

 * @ingroup dirty

   139

 */

   140

static void TerraformAddDirtyTileAround(TerraformerState *ts, TileIndex tile)

   141

{

   142

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

   143

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

   144

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

   145

	TerraformAddDirtyTile(ts, tile);

   146

}

   147

   148

/**

   149

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

   150

 *

   151

 * @param ts TerraformerState.

   152

 * @param tile Tile.

   153

 * @param height Aimed height.

   154

 * @param return Error code or cost.

   155

 */

   156

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

   157

{

   158

	CommandCost total_cost = CommandCost();

   159

   160

	assert(tile < MapSize());

   161

   162

	/* Check range of destination height */

   163

	if (height < 0) return_cmd_error(STR_1003_ALREADY_AT_SEA_LEVEL);

   164

	if (height > MAX_TILE_HEIGHT) return_cmd_error(STR_1004_TOO_HIGH);

   165

   166

	/*

   167

	 * Check if the terraforming has any effect.

   168

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

   169

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

   170

	 */

   171

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

   172

   173

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

   174

	uint x = TileX(tile);

   175

	uint y = TileY(tile);

   176

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

   177

		/*

   178

		 * Determine a sensible error tile

   179

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

   180

		 */

   181

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

   182

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

   183

		_terraform_err_tile = TileXY(x, y);

   184

		return_cmd_error(STR_0002_TOO_CLOSE_TO_EDGE_OF_MAP);

   185

	}

   186

   187

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

   188

	TerraformAddDirtyTileAround(ts, tile);

   189

   190

	/* Store the height modification */

   191

	TerraformSetHeightOfTile(ts, tile, height);

   192

   193

	/* Increment cost */

   194

	total_cost.AddCost(_price.terraform);

   195

   196

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

   197

	{

   198

		const TileIndexDiffC *ttm;

   199

   200

		static const TileIndexDiffC _terraform_tilepos[] = {

   201

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

   202

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

   203

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

   204

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

   205

		};

   206

   207

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

   208

			tile += ToTileIndexDiff(*ttm);

   209

   210

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

   211

			int r = TerraformGetHeightOfTile(ts, tile);

   212

			int height_diff = height - r;

   213

   214

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

   215

			if (abs(height_diff) > 1) {

   216

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

   217

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

   218

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

   219

				if (CmdFailed(cost)) return cost;

   220

				total_cost.AddCost(cost);

   221

			}

   222

		}

   223

	}

   224

   225

	return total_cost;

   226

}

   227

   228

/** Terraform land

   229

 * @param tile tile to terraform

   230

 * @param flags for this command type

   231

 * @param p1 corners to terraform (SLOPE_xxx)

   232

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

   233

 * @return error or cost of terraforming

   234

 */

   235

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

   236

{

   237

	TerraformerState ts;

   238

	CommandCost total_cost = CommandCost();

   239

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

   240

   241

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   242

   243

	_terraform_err_tile = 0;

   244

   245

	ts.modheight_count = ts.tile_table_count = 0;

   246

   247

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

   248

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

   249

   250

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

   251

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

   252

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

   253

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

   254

		if (CmdFailed(cost)) return cost;

   255

		total_cost.AddCost(cost);

   256

	}

   257

   258

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

   259

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

   260

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

   261

		if (CmdFailed(cost)) return cost;

   262

		total_cost.AddCost(cost);

   263

	}

   264

   265

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

   266

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

   267

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

   268

		if (CmdFailed(cost)) return cost;

   269

		total_cost.AddCost(cost);

   270

	}

   271

   272

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

   273

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

   274

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

   275

		if (CmdFailed(cost)) return cost;

   276

		total_cost.AddCost(cost);

   277

	}

   278

   279

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

   280

	{

   281

		int count;

   282

		TileIndex *ti = ts.tile_table;

   283

   284

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

   285

			TileIndex tile = *ti;

   286

   287

			/* Find new heights of tile corners */

   288

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

   289

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

   290

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

   291

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

   292

   293

			/* Find min and max height of tile */

   294

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

   295

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

   296

   297

			/* Compute tile slope */

   298

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

   299

			if (z_W > z_min) tileh += SLOPE_W;

   300

			if (z_S > z_min) tileh += SLOPE_S;

   301

			if (z_E > z_min) tileh += SLOPE_E;

   302

			if (z_N > z_min) tileh += SLOPE_N;

   303

   304

			/* Check if bridge would take damage */

   305

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

   306

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

   307

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

   308

				return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   309

			}

   310

			/* Check if tunnel would take damage */

   311

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

   312

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

   313

				return_cmd_error(STR_1002_EXCAVATION_WOULD_DAMAGE);

   314

			}

   315

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

   316

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

   317

			if (CmdFailed(cost)) {

   318

				_terraform_err_tile = tile;

   319

				return cost;

   320

			}

   321

			total_cost.AddCost(cost);

   322

		}

   323

	}

   324

   325

	if (flags & DC_EXEC) {

   326

		/* change the height */

   327

		{

   328

			int count;

   329

			TerraformerHeightMod *mod;

   330

   331

			mod = ts.modheight;

   332

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

   333

				TileIndex til = mod->tile;

   334

   335

				SetTileHeight(til, mod->height);

   336

			}

   337

		}

   338

   339

		/* finally mark the dirty tiles dirty */

   340

		{

   341

			int count;

   342

			TileIndex *ti = ts.tile_table;

   343

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

   344

				MarkTileDirtyByTile(*ti);

   345

			}

   346

		}

   347

	}

   348

	return total_cost;

   349

}

   350

   351

   352

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

   353

 * @param tile end tile of area-drag

   354

 * @param flags for this command type

   355

 * @param p1 start tile of area drag

   356

 * @param p2 unused

   357

 * @return  error or cost of terraforming

   358

 */

   359

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

   360

{

   361

	int size_x, size_y;

   362

	int ex;

   363

	int ey;

   364

	int sx, sy;

   365

	uint h, curh;

   366

	CommandCost money;

   367

	CommandCost ret;

   368

	CommandCost cost;

   369

   370

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

   371

   372

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   373

   374

	/* remember level height */

   375

	h = TileHeight(p1);

   376

   377

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

   378

	ex = TileX(tile);

   379

	ey = TileY(tile);

   380

	sx = TileX(p1);

   381

	sy = TileY(p1);

   382

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

   383

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

   384

	tile = TileXY(sx, sy);

   385

   386

	size_x = ex - sx + 1;

   387

	size_y = ey - sy + 1;

   388

   389

	money.AddCost(GetAvailableMoneyForCommand());

   390

   391

	BEGIN_TILE_LOOP(tile2, size_x, size_y, tile) {

   392

		curh = TileHeight(tile2);

   393

		while (curh != h) {

   394

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

   395

			if (CmdFailed(ret)) break;

   396

   397

			if (flags & DC_EXEC) {

   398

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

   399

				if (money.GetCost() < 0) {

   400

					_additional_cash_required = ret.GetCost();

   401

					return cost;

   402

				}

   403

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

   404

			}

   405

   406

			cost.AddCost(ret);

   407

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

   408

		}

   409

	} END_TILE_LOOP(tile2, size_x, size_y, tile)

   410

   411

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

   412

}

   413

   414

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

   415

 * the name is a bit confusing ;p

   416

 * @param tile the tile the player is purchasing

   417

 * @param flags for this command type

   418

 * @param p1 unused

   419

 * @param p2 unused

   420

 * @return error of cost of operation

   421

 */

   422

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

   423

{

   424

	CommandCost cost;

   425

   426

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   427

   428

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

   429

		return_cmd_error(STR_5807_YOU_ALREADY_OWN_IT);

   430

	}

   431

   432

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

   433

	if (CmdFailed(cost)) return CMD_ERROR;

   434

   435

	if (flags & DC_EXEC) {

   436

		MakeOwnedLand(tile, _current_player);

   437

		MarkTileDirtyByTile(tile);

   438

	}

   439

   440

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

   441

}

   442

   443

   444

static CommandCost ClearTile_Clear(TileIndex tile, byte flags)

   445

{

   446

	static const Money* clear_price_table[] = {

   447

		&_price.clear_grass,

   448

		&_price.clear_roughland,

   449

		&_price.clear_rocks,

   450

		&_price.clear_fields,

   451

		&_price.clear_roughland,

   452

		&_price.clear_roughland,

   453

	};

   454

	CommandCost price;

   455

   456

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

   457

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

   458

	}

   459

   460

	if (flags & DC_EXEC) DoClearSquare(tile);

   461

   462

	return price;

   463

}

   464

   465

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

   466

 * the name is a bit confusing ;p

   467

 * @param tile the tile the player is selling

   468

 * @param flags for this command type

   469

 * @param p1 unused

   470

 * @param p2 unused

   471

 * @return error or cost of operation

   472

 */

   473

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

   474

{

   475

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   476

   477

	if (!IsOwnedLandTile(tile)) return CMD_ERROR;

   478

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

   479

   480

   481

	if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   482

   483

	if (flags & DC_EXEC) DoClearSquare(tile);

   484

   485

	return CommandCost(- _price.clear_roughland * 2);

   486

}

   487

   488

   489

#include "table/clear_land.h"