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

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

    37

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

    38

    39

	CommandCost cost;

    40

    41

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

    42

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

    43

};

    44

    45

/**

    46

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

    47

 *

    48

 * @param ts TerraformerState.

    49

 * @param tile Tile.

    50

 * @return TileHeight.

    51

 */

    52

static int TerraformGetHeightOfTile(TerraformerState *ts, TileIndex tile)

    53

{

    54

	TerraformerHeightMod *mod = ts->modheight;

    55

	int count;

    56

    57

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

    58

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

    59

	}

    60

    61

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

    62

	return TileHeight(tile);

    63

}

    64

    65

/**

    66

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

    67

 *

    68

 * @param ts TerraformerState.

    69

 * @param tile Tile.

    70

 */

    71

static void TerraformAddDirtyTile(TerraformerState *ts, TileIndex tile)

    72

{

    73

	int count;

    74

	TileIndex *t;

    75

    76

	count = ts->tile_table_count;

    77

    78

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

    79

		if (*t == tile) return;

    80

	}

    81

    82

	assert(ts->tile_table_count < TERRAFORMER_TILE_TABLE_SIZE);

    83

    84

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

    85

}

    86

    87

/**

    88

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

    89

 *

    90

 * @param ts TerraformerState.

    91

 * @param tile Tile.

    92

 */

    93

static void TerraformAddDirtyTileAround(TerraformerState *ts, TileIndex tile)

    94

{

    95

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

    96

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

    97

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

    98

	TerraformAddDirtyTile(ts, tile);

    99

}

   100

   101

/**

   102

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

   103

 *

   104

 * @param ts TerraformerState.

   105

 * @param tile Tile.

   106

 * @param height Aimed height.

   107

 * @param return true on success.

   108

 */

   109

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

   110

{

   111

	assert(tile < MapSize());

   112

   113

	/* Check range of destination height */

   114

	if (height < 0) {

   115

		_error_message = STR_1003_ALREADY_AT_SEA_LEVEL;

   116

		return false;

   117

	}

   118

   119

	_error_message = STR_1004_TOO_HIGH;

   120

   121

	if (height > MAX_TILE_HEIGHT) return false;

   122

   123

	/*

   124

	 * Check if the terraforming has any effect.

   125

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

   126

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

   127

	 */

   128

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

   129

   130

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

   131

	uint x = TileX(tile);

   132

	uint y = TileY(tile);

   133

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

   134

		/*

   135

		 * Determine a sensible error tile

   136

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

   137

		 */

   138

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

   139

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

   140

		_terraform_err_tile = TileXY(x, y);

   141

		_error_message = STR_0002_TOO_CLOSE_TO_EDGE_OF_MAP;

   142

		return false;

   143

	}

   144

   145

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

   146

	TerraformAddDirtyTileAround(ts, tile);

   147

   148

	/* Store the height modification */

   149

   150

	/* Find tile in the "modheight" table.

   151

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

   152

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

   153

	TerraformerHeightMod *mod = ts->modheight;

   154

	int count = ts->modheight_count;

   155

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

   156

		mod++;

   157

		count--;

   158

	}

   159

   160

	/* New entry? */

   161

	if (count == 0) {

   162

		assert(ts->modheight_count < TERRAFORMER_MODHEIGHT_SIZE);

   163

		ts->modheight_count++;

   164

	}

   165

   166

	/* Finally store the new value */

   167

	mod->tile = tile;

   168

	mod->height = (byte)height;

   169

   170

	/* Increment cost */

   171

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

   172

   173

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

   174

	{

   175

		const TileIndexDiffC *ttm;

   176

   177

		static const TileIndexDiffC _terraform_tilepos[] = {

   178

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

   179

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

   180

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

   181

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

   182

		};

   183

   184

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

   185

			tile += ToTileIndexDiff(*ttm);

   186

   187

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

   188

			int r = TerraformGetHeightOfTile(ts, tile);

   189

			int height_diff = height - r;

   190

   191

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

   192

			if (abs(height_diff) > 1) {

   193

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

   194

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

   195

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

   196

					return false;

   197

			}

   198

		}

   199

	}

   200

   201

	return true;

   202

}

   203

   204

/** Terraform land

   205

 * @param tile tile to terraform

   206

 * @param flags for this command type

   207

 * @param p1 corners to terraform (SLOPE_xxx)

   208

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

   209

 * @return error or cost of terraforming

   210

 */

   211

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

   212

{

   213

	TerraformerState ts;

   214

	TileIndex t;

   215

	int direction;

   216

   217

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   218

   219

	_terraform_err_tile = 0;

   220

   222

	ts.modheight_count = ts.tile_table_count = 0;

   223

	ts.cost = CommandCost();

   224

   225

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

   226

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

   227

   228

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

   229

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

   230

		t = tile + TileDiffXY(1, 0);

   231

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

   232

			return CMD_ERROR;

   233

		}

   234

	}

   235

   236

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

   237

		t = tile + TileDiffXY(1, 1);

   238

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

   239

			return CMD_ERROR;

   240

		}

   241

	}

   242

   243

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

   244

		t = tile + TileDiffXY(0, 1);

   245

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

   246

			return CMD_ERROR;

   247

		}

   248

	}

   249

   250

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

   251

		t = tile + TileDiffXY(0, 0);

   252

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

   253

			return CMD_ERROR;

   254

		}

   255

	}

   256

   257

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

   258

	{

   259

		int count;

   260

		TileIndex *ti = ts.tile_table;

   261

   262

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

   263

			TileIndex tile = *ti;

   264

   265

			/* Find new heights of tile corners */

   266

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

   267

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

   268

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

   269

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

   270

   271

			/* Find min and max height of tile */

   272

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

   273

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

   274

   282

			/* Check if bridge would take damage */

   283

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

   284

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

   285

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

   286

				return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   287

			}

   288

			/* Check if tunnel would take damage */

   289

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

   290

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

   291

				return_cmd_error(STR_1002_EXCAVATION_WOULD_DAMAGE);

   292

			}

   293

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

   299

			ts.cost.AddCost(cost);

   300

		}

   301

	}

   302

   303

	if (flags & DC_EXEC) {

   304

		/* change the height */

   305

		{

   306

			int count;

   307

			TerraformerHeightMod *mod;

   308

   309

			mod = ts.modheight;

   310

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

   311

				TileIndex til = mod->tile;

   312

   313

				SetTileHeight(til, mod->height);

   314

			}

   315

		}

   316

   317

		/* finally mark the dirty tiles dirty */

   318

		{

   319

			int count;

   320

			TileIndex *ti = ts.tile_table;

   321

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

   322

				MarkTileDirtyByTile(*ti);

   323

			}

   324

		}

   325

	}

   326

	return ts.cost;

   327

}

   328

   329

   330

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

   331

 * @param tile end tile of area-drag

   332

 * @param flags for this command type

   333

 * @param p1 start tile of area drag

   334

 * @param p2 unused

   335

 * @return  error or cost of terraforming

   336

 */

   337

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

   338

{

   339

	int size_x, size_y;

   340

	int ex;

   341

	int ey;

   342

	int sx, sy;

   343

	uint h, curh;

   344

	CommandCost money;

   345

	CommandCost ret;

   346

	CommandCost cost;

   347

   348

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

   349

   350

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   351

   352

	/* remember level height */

   353

	h = TileHeight(p1);

   354

   355

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

   356

	ex = TileX(tile);

   357

	ey = TileY(tile);

   358

	sx = TileX(p1);

   359

	sy = TileY(p1);

   360

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

   361

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

   362

	tile = TileXY(sx, sy);

   363

   364

	size_x = ex - sx + 1;

   365

	size_y = ey - sy + 1;

   366

   367

	money.AddCost(GetAvailableMoneyForCommand());

   368

   369

	BEGIN_TILE_LOOP(tile2, size_x, size_y, tile) {

   370

		curh = TileHeight(tile2);

   371

		while (curh != h) {

   372

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

   373

			if (CmdFailed(ret)) break;

   374

   375

			if (flags & DC_EXEC) {

   376

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

   377

				if (money.GetCost() < 0) {

   378

					_additional_cash_required = ret.GetCost();

   379

					return cost;

   380

				}

   381

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

   382

			}

   383

   384

			cost.AddCost(ret);

   385

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

   386

		}

   387

	} END_TILE_LOOP(tile2, size_x, size_y, tile)

   388

   389

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

   390

}

   391

   392

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

   393

 * the name is a bit confusing ;p

   394

 * @param tile the tile the player is purchasing

   395

 * @param flags for this command type

   396

 * @param p1 unused

   397

 * @param p2 unused

   398

 * @return error of cost of operation

   399

 */

   400

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

   401

{

   402

	CommandCost cost;

   403

   404

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   405

   406

	if (!EnsureNoVehicle(tile)) return CMD_ERROR;

   407

   408

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

   409

		return_cmd_error(STR_5807_YOU_ALREADY_OWN_IT);

   410

	}

   411

   412

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

   413

	if (CmdFailed(cost)) return CMD_ERROR;

   414

   415

	if (flags & DC_EXEC) {

   416

		MakeOwnedLand(tile, _current_player);

   417

		MarkTileDirtyByTile(tile);

   418

	}

   419

   420

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

   421

}

   422

   423

   424

static CommandCost ClearTile_Clear(TileIndex tile, byte flags)

   425

{

   426

	static const Money* clear_price_table[] = {

   427

		&_price.clear_1,

   428

		&_price.purchase_land,

   429

		&_price.clear_2,

   430

		&_price.clear_3,

   431

		&_price.purchase_land,

   432

		&_price.purchase_land,

   433

		&_price.clear_2, // XXX unused?

   434

	};

   435

	CommandCost price;

   436

   437

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

   438

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

   439

	}

   440

   441

	if (flags & DC_EXEC) DoClearSquare(tile);

   442

   443

	return price;

   444

}

   445

   446

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

   447

 * the name is a bit confusing ;p

   448

 * @param tile the tile the player is selling

   449

 * @param flags for this command type

   450

 * @param p1 unused

   451

 * @param p2 unused

   452

 * @return error or cost of operation

   453

 */

   454

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

   455

{

   456

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   457

   458

	if (!IsOwnedLandTile(tile)) return CMD_ERROR;

   459

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

   460

   461

   462

	if (!EnsureNoVehicle(tile)) return CMD_ERROR;

   463

   464

	if (flags & DC_EXEC) DoClearSquare(tile);

   465

   466

	return CommandCost(- _price.purchase_land * 2);

   467

}

   468

   469

   470

#include "table/clear_land.h"

   471

   472

   473

void DrawClearLandTile(const TileInfo *ti, byte set)

   474

{

   475

	DrawGroundSprite(SPR_FLAT_BARE_LAND + _tileh_to_sprite[ti->tileh] + set * 19, PAL_NONE);

   476

}

   477

   478

void DrawHillyLandTile(const TileInfo *ti)

   479

{

   480

	if (ti->tileh != SLOPE_FLAT) {

   481

		DrawGroundSprite(SPR_FLAT_ROUGH_LAND + _tileh_to_sprite[ti->tileh], PAL_NONE);

   482

	} else {

   483

		DrawGroundSprite(_landscape_clear_sprites[GB(ti->x ^ ti->y, 4, 3)], PAL_NONE);

   484

	}

   485

}

   486

   487

void DrawClearLandFence(const TileInfo *ti)

   488

{

   489

	byte z = ti->z;

   490