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

    14

#include "viewport.h"

    15

#include "command.h"

    16

#include "tunnel_map.h"

    17

#include "bridge_map.h"

    18

#include "bridge.h"

    19

#include "landscape.h"

    20

#include "variables.h"

    21

#include "table/sprites.h"

    22

#include "unmovable_map.h"

    23

#include "genworld.h"

    24

#include "industry.h"

    25

#include "water_map.h"

    26

    27

static const int TERRAFORMER_MODHEIGHT_SIZE = 576;

    28

static const int TERRAFORMER_TILE_TABLE_SIZE = 625;

    29

    30

struct TerraformerHeightMod {

    31

	TileIndex tile;   ///< Referenced tile.

    32

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

    33

};

    34

    35

struct TerraformerState {

    36

	uint32 flags;

    37

    38

	int direction;

    39

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

    40

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

    41

    42

	CommandCost cost;

    43

    44

	TileIndex tile_table[TERRAFORMER_TILE_TABLE_SIZE];           ///< Dirty tiles, i.e. at least one corner changed.

    45

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

    46

};

    47

    48

/**

    49

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

    50

 *

    51

 * @param ts TerraformerState.

    52

 * @param tile Tile.

    53

 * @return TileHeight.

    54

 */

    55

static int TerraformGetHeightOfTile(TerraformerState *ts, TileIndex tile)

    56

{

    57

	TerraformerHeightMod *mod = ts->modheight;

    58

	int count;

    59

    60

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

    61

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

    62

	}

    63

    64

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

    65

	return TileHeight(tile);

    66

}

    67

    68

/**

    69

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

    70

 *

    71

 * @param ts TerraformerState.

    72

 * @param tile Tile.

    73

 */

    74

static void TerraformAddDirtyTile(TerraformerState *ts, TileIndex tile)

    75

{

    76

	int count;

    77

	TileIndex *t;

    78

    79

	count = ts->tile_table_count;

    80

    81

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

    82

		if (*t == tile) return;

    83

	}

    84

    85

	assert(ts->tile_table_count < TERRAFORMER_TILE_TABLE_SIZE);

    86

    87

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

    88

}

    89

    90

/**

    91

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

    92

 *

    93

 * @param ts TerraformerState.

    94

 * @param tile Tile.

    95

 */

    96

static void TerraformAddDirtyTileAround(TerraformerState *ts, TileIndex tile)

    97

{

    98

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

    99

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

   100

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

   101

	TerraformAddDirtyTile(ts, tile);

   102

}

   103

   104

/**

   106

 *

   107

 * @param ts TerraformerState.

   108

 * @param tile Tile.

   109

 * @param mode Affected corner: 0 = north, 1 = east, 2 = south, 3 = west.

   111

 */

   113

{

   114

	/* Check if a tile can be terraformed. */

   115

	if (IsTileType(tile, MP_RAILWAY)) {

   116

		static const TrackBits safe_track[] = { TRACK_BIT_LOWER, TRACK_BIT_LEFT, TRACK_BIT_UPPER, TRACK_BIT_RIGHT };

   117

		static const Slope unsafe_slope[] = { SLOPE_S, SLOPE_W, SLOPE_N, SLOPE_E };

   118

   119

		Slope tileh;

   120

		uint z;

   121

   122

		/* Nothing could be built at the steep slope - this avoids a bug

   123

		 * when you have a single diagonal track in one corner on a

   124

		 * basement and then you raise/lower the other corner. */

   125

		tileh = GetTileSlope(tile, &z);

   126

		if (tileh == unsafe_slope[mode] ||

   127

				tileh == (SLOPE_STEEP | ComplementSlope(unsafe_slope[mode]))) {

   128

			_terraform_err_tile = tile;

   129

			_error_message = STR_1008_MUST_REMOVE_RAILROAD_TRACK;

   131

		}

   132

   133

		/* If we have a single diagonal track there, the other side of

   134

		 * tile can be terraformed. */

   135

		if (IsPlainRailTile(tile) && GetTrackBits(tile) == safe_track[mode]) {

   138

		}

   139

	}

   140

   141

	/* Canals can't be terraformed */

   142

	if (IsClearWaterTile(tile) && IsCanal(tile)) {

   143

		_terraform_err_tile = tile;

   144

		_error_message = STR_MUST_DEMOLISH_CANAL_FIRST;

   146

	}

   147

   148

	/* Try to clear the tile. If the tile can be cleared, add the cost to the terraforming cost, else the terraforming fails. */

   150

}

   151

   152

/**

   153

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

   154

 *

   155

 * @param ts TerraformerState.

   156

 * @param tile Tile.

   157

 * @param height Aimed height.

   158

 * @param return true on success.

   159

 */

   160

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

   161

{

   162

	assert(tile < MapSize());

   163

   164

	/* Check range of destination height */

   165

	if (height < 0) {

   166

		_error_message = STR_1003_ALREADY_AT_SEA_LEVEL;

   167

		return false;

   168

	}

   169

   170

	_error_message = STR_1004_TOO_HIGH;

   171

   172

	if (height > MAX_TILE_HEIGHT) return false;

   173

   174

	/*

   175

	 * Check if the terraforming has any effect.

   176

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

   177

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

   178

	 */

   179

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

   180

   198

   199

	/* Store the height modification */

   200

   201

	/* Find tile in the "modheight" table.

   202

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

   203

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

   204

	TerraformerHeightMod *mod = ts->modheight;

   205

	int count = ts->modheight_count;

   206

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

   207

		mod++;

   208

		count--;

   209

	}

   210

   211

	/* New entry? */

   212

	if (count == 0) {

   213

		assert(ts->modheight_count < TERRAFORMER_MODHEIGHT_SIZE);

   214

		ts->modheight_count++;

   215

	}

   216

   217

	/* Finally store the new value */

   218

	mod->tile = tile;

   219

	mod->height = (byte)height;

   220

   221

	/* Increment cost */

   222

	ts->cost.AddCost(_price.terraform);

   223

   224

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

   225

	{

   226

		const TileIndexDiffC *ttm;

   227

   228

		static const TileIndexDiffC _terraform_tilepos[] = {

   229

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

   230

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

   231

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

   232

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

   233

		};

   234

   235

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

   236

			tile += ToTileIndexDiff(*ttm);

   237

   238

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

   239

			int r = TerraformGetHeightOfTile(ts, tile);

   240

			int height_diff = height - r;

   241

   242

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

   243

			if (abs(height_diff) > 1) {

   244

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

   245

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

   246

				if (!TerraformTileHeight(ts, tile, r + height_diff))

   247

					return false;

   248

			}

   249

		}

   250

	}

   251

   252

	return true;

   253

}

   254

   255

/** Terraform land

   256

 * @param tile tile to terraform

   257

 * @param flags for this command type

   258

 * @param p1 corners to terraform (SLOPE_xxx)

   259

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

   260

 * @return error or cost of terraforming

   261

 */

   262

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

   263

{

   264

	TerraformerState ts;

   265

	TileIndex t;

   266

	int direction;

   267

   268

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   269

   270

	_terraform_err_tile = 0;

   271

   272

	ts.direction = direction = p2 ? 1 : -1;

   273

	ts.flags = flags;

   274

	ts.modheight_count = ts.tile_table_count = 0;

   275

	ts.cost = CommandCost();

   276

   277

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

   278

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

   279

   280

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

   281

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

   282

		t = tile + TileDiffXY(1, 0);

   283

		if (!TerraformTileHeight(&ts, t, TileHeight(t) + direction)) {

   284

			return CMD_ERROR;

   285

		}

   286

	}

   287

   288

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

   289

		t = tile + TileDiffXY(1, 1);

   290

		if (!TerraformTileHeight(&ts, t, TileHeight(t) + direction)) {

   291

			return CMD_ERROR;

   292

		}

   293

	}

   294

   295

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

   296

		t = tile + TileDiffXY(0, 1);

   297

		if (!TerraformTileHeight(&ts, t, TileHeight(t) + direction)) {

   298

			return CMD_ERROR;

   299

		}

   300

	}

   301

   302

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

   303

		t = tile + TileDiffXY(0, 0);

   304

		if (!TerraformTileHeight(&ts, t, TileHeight(t) + direction)) {

   305

			return CMD_ERROR;

   306

		}

   307

	}

   308

   310

	{

   311

		int count;

   312

		TileIndex *ti = ts.tile_table;

   313

   314

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

   315

			TileIndex tile = *ti;

   316

   323

			/* Find min and max height of tile */

   326

   327

			/* Check if bridge would take damage */

   328

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

   329

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

   330

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

   331

				return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   332

			}

   333

			/* Check if tunnel would take damage */

   334

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

   335

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

   336

				return_cmd_error(STR_1002_EXCAVATION_WOULD_DAMAGE);

   337

			}

   367

		}

   368

	}

   369

   370

	if (flags & DC_EXEC) {

   371

		/* change the height */

   372

		{

   373

			int count;

   374

			TerraformerHeightMod *mod;

   375

   376

			mod = ts.modheight;

   377

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

   378

				TileIndex til = mod->tile;

   379

   380

				SetTileHeight(til, mod->height);

   381

			}

   382

		}

   383

   384

		/* finally mark the dirty tiles dirty */

   385

		{

   386

			int count;

   387

			TileIndex *ti = ts.tile_table;

   388

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

   389

				MarkTileDirtyByTile(*ti);

   390

			}

   391

		}

   392

	}

   393

	return ts.cost;

   394

}

   395

   396

   397

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

   398

 * @param tile end tile of area-drag

   399

 * @param flags for this command type

   400

 * @param p1 start tile of area drag

   401

 * @param p2 unused

   402

 * @return  error or cost of terraforming

   403

 */

   404

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

   405

{

   406

	int size_x, size_y;

   407

	int ex;

   408

	int ey;

   409

	int sx, sy;

   410

	uint h, curh;

   411

	CommandCost money;

   412

	CommandCost ret;

   413

	CommandCost cost;

   414

   415

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

   416

   417

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   418

   419

	/* remember level height */

   420

	h = TileHeight(p1);

   421

   422

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

   423

	ex = TileX(tile);

   424

	ey = TileY(tile);

   425

	sx = TileX(p1);

   426

	sy = TileY(p1);

   427

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

   428

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

   429

	tile = TileXY(sx, sy);

   430

   431

	size_x = ex - sx + 1;

   432

	size_y = ey - sy + 1;

   433

   434

	money.AddCost(GetAvailableMoneyForCommand());

   435

   436

	BEGIN_TILE_LOOP(tile2, size_x, size_y, tile) {

   437

		curh = TileHeight(tile2);

   438

		while (curh != h) {

   439

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

   440

			if (CmdFailed(ret)) break;

   441

   442

			if (flags & DC_EXEC) {

   443

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

   444

				if (money.GetCost() < 0) {

   445

					_additional_cash_required = ret.GetCost();

   446

					return cost;

   447

				}

   448

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

   449

			}

   450

   451

			cost.AddCost(ret);

   452

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

   453

		}

   454

	} END_TILE_LOOP(tile2, size_x, size_y, tile)

   455

   456

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

   457

}

   458

   459

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

   460

 * the name is a bit confusing ;p

   461

 * @param tile the tile the player is purchasing

   462

 * @param flags for this command type

   463

 * @param p1 unused

   464

 * @param p2 unused

   465

 * @return error of cost of operation

   466

 */

   467

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

   468

{

   469

	CommandCost cost;

   470

   471

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   472

   473

	if (!EnsureNoVehicle(tile)) return CMD_ERROR;

   474

   475

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

   476

		return_cmd_error(STR_5807_YOU_ALREADY_OWN_IT);

   477

	}

   478

   479

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

   480

	if (CmdFailed(cost)) return CMD_ERROR;

   481

   482

	if (flags & DC_EXEC) {

   483

		MakeOwnedLand(tile, _current_player);

   484

		MarkTileDirtyByTile(tile);

   485

	}

   486

   487

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

   488

}

   489

   490