1

/* $Id$ */

     2

     3

/** @file road_cmd.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "bridge_map.h"

     8

#include "bridge.h"

     9

#include "cmd_helper.h"

    10

#include "rail_map.h"

    11

#include "road_map.h"

    12

#include "sprite.h"

    13

#include "table/sprites.h"

    14

#include "table/strings.h"

    15

#include "functions.h"

    16

#include "map.h"

    17

#include "landscape.h"

    18

#include "tile.h"

    19

#include "town_map.h"

    20

#include "vehicle.h"

    21

#include "viewport.h"

    22

#include "command.h"

    23

#include "player.h"

    24

#include "town.h"

    25

#include "gfx.h"

    26

#include "sound.h"

    27

#include "yapf/yapf.h"

    28

#include "depot.h"

    29

    30

    31

static uint CountRoadBits(RoadBits r)

    32

{

    33

	uint count = 0;

    34

    35

	if (r & ROAD_NW) ++count;

    36

	if (r & ROAD_SW) ++count;

    37

	if (r & ROAD_SE) ++count;

    38

	if (r & ROAD_NE) ++count;

    39

	return count;

    40

}

    41

    42

    43

bool CheckAllowRemoveRoad(TileIndex tile, RoadBits remove, Owner owner, bool *edge_road)

    44

{

    45

	RoadBits present;

    46

	RoadBits n;

    47

	*edge_road = true;

    48

    49

	if (_game_mode == GM_EDITOR) return true;

    50

    51

	/* Only do the special processing for actual players. */

    52

	if (!IsValidPlayer(_current_player)) return true;

    53

    54

	/* Only do the special processing if the road is owned

    55

	 * by a town */

    56

	if (owner != OWNER_TOWN) return (owner == OWNER_NONE) || CheckOwnership(owner);

    57

    58

	if (_cheats.magic_bulldozer.value) return true;

    59

    60

	/* Get a bitmask of which neighbouring roads has a tile */

    61

	n = ROAD_NONE;

    62

	present = GetAnyRoadBits(tile);

    63

	if (present & ROAD_NE && GetAnyRoadBits(TILE_ADDXY(tile,-1, 0)) & ROAD_SW) n |= ROAD_NE;

    64

	if (present & ROAD_SE && GetAnyRoadBits(TILE_ADDXY(tile, 0, 1)) & ROAD_NW) n |= ROAD_SE;

    65

	if (present & ROAD_SW && GetAnyRoadBits(TILE_ADDXY(tile, 1, 0)) & ROAD_NE) n |= ROAD_SW;

    66

	if (present & ROAD_NW && GetAnyRoadBits(TILE_ADDXY(tile, 0,-1)) & ROAD_SE) n |= ROAD_NW;

    67

    68

	/* If 0 or 1 bits are set in n, or if no bits that match the bits to remove,

    69

	 * then allow it */

    70

	if ((n & (n - 1)) != 0 && (n & remove) != 0) {

    71

		Town *t;

    72

		*edge_road = false;

    73

		/* you can remove all kind of roads with extra dynamite */

    74

		if (_patches.extra_dynamite) return true;

    75

    76

		t = ClosestTownFromTile(tile, (uint)-1);

    77

    78

		SetDParam(0, t->index);

    79

		_error_message = STR_2009_LOCAL_AUTHORITY_REFUSES;

    80

		return false;

    81

	}

    82

    83

	return true;

    84

}

    85

    86

static bool CheckAllowRemoveRoad(TileIndex tile, RoadBits remove, bool *edge_road)

    87

{

    88

	return CheckAllowRemoveRoad(tile, remove, IsLevelCrossingTile(tile) ? GetCrossingRoadOwner(tile) : GetTileOwner(tile), edge_road);

    89

}

    90

    91

/** Delete a piece of road.

    92

 * @param tile tile where to remove road from

    93

 * @param p1 bit 0..3 road pieces to remove (RoadBits)

    94

 * @param p2 unused

    95

 */

    96

int32 CmdRemoveRoad(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)

    97

{

    98

	/* cost for removing inner/edge -roads */

    99

	static const uint16 road_remove_cost[2] = {50, 18};

   100

   101

	Owner owner;

   102

	Town *t;

   103

	/* true if the roadpiece was always removeable,

   104

	 * false if it was a center piece. Affects town ratings drop */

   105

	bool edge_road;

   106

   107

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   108

   109

	if (!IsTileType(tile, MP_STREET)) return CMD_ERROR;

   110

   111

	owner = IsLevelCrossingTile(tile) ? GetCrossingRoadOwner(tile) : GetTileOwner(tile);

   112

   113

	if (owner == OWNER_TOWN && _game_mode != GM_EDITOR) {

   114

		t = GetTownByTile(tile);

   115

	} else {

   116

		t = NULL;

   117

	}

   118

   119

	RoadBits pieces = Extract<RoadBits, 0>(p1);

   120

   121

	if (!CheckAllowRemoveRoad(tile, pieces, &edge_road)) return CMD_ERROR;

   122

   123

	if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   124

   125

	/* check if you're allowed to remove the street owned by a town

   126

	 * removal allowance depends on difficulty setting */

   127

	if (!CheckforTownRating(flags, t, ROAD_REMOVE)) return CMD_ERROR;

   128

   129

	switch (GetRoadTileType(tile)) {

   130

		case ROAD_TILE_NORMAL: {

   131

			RoadBits present = GetRoadBits(tile);

   132

			RoadBits c = pieces;

   133

   134

			if (HasRoadWorks(tile)) return_cmd_error(STR_ROAD_WORKS_IN_PROGRESS);

   135

   136

			if (GetTileSlope(tile, NULL) != SLOPE_FLAT  &&

   137

					(present == ROAD_Y || present == ROAD_X)) {

   138

				c |= (RoadBits)((c & 0xC) >> 2);

   139

				c |= (RoadBits)((c & 0x3) << 2);

   140

			}

   141

   142

			/* limit the bits to delete to the existing bits. */

   143

			c &= present;

   144

			if (c == 0) return CMD_ERROR;

   145

   146

			if (flags & DC_EXEC) {

   147

				ChangeTownRating(t, -road_remove_cost[(byte)edge_road], RATING_ROAD_MINIMUM);

   148

   149

				present ^= c;

   150

				if (present == 0) {

   151

					DoClearSquare(tile);

   152

				} else {

   153

					SetRoadBits(tile, present);

   154

					MarkTileDirtyByTile(tile);

   155

				}

   156

			}

   157

			return CountRoadBits(c) * _price.remove_road;

   158

		}

   159

   160

		case ROAD_TILE_CROSSING: {

   161

			if (pieces & ComplementRoadBits(GetCrossingRoadBits(tile))) {

   162

				return CMD_ERROR;

   163

			}

   164

   165

			if (flags & DC_EXEC) {

   166

				ChangeTownRating(t, -road_remove_cost[(byte)edge_road], RATING_ROAD_MINIMUM);

   167

   168

				MakeRailNormal(tile, GetTileOwner(tile), GetCrossingRailBits(tile), GetRailType(tile));

   169

				MarkTileDirtyByTile(tile);

   170

				YapfNotifyTrackLayoutChange(tile, FindFirstTrack(GetTrackBits(tile)));

   171

			}

   172

			return _price.remove_road * 2;

   173

		}

   174

   175

		default:

   176

		case ROAD_TILE_DEPOT:

   177

			return CMD_ERROR;

   178

	}

   179

}

   180

   181

   182

static const RoadBits _valid_tileh_slopes_road[][15] = {

   183

	/* set of normal ones */

   184

	{

   185

		ROAD_ALL, ROAD_NONE, ROAD_NONE,

   186

		ROAD_X,   ROAD_NONE, ROAD_NONE,  // 3, 4, 5

   187

		ROAD_Y,   ROAD_NONE, ROAD_NONE,

   188

		ROAD_Y,   ROAD_NONE, ROAD_NONE,  // 9, 10, 11

   189

		ROAD_X,   ROAD_NONE, ROAD_NONE

   190

	},

   191

	/* allowed road for an evenly raised platform */

   192

	{

   193

		ROAD_NONE,

   194

		ROAD_SW | ROAD_NW,

   195

		ROAD_SW | ROAD_SE,

   196

		ROAD_Y  | ROAD_SW,

   197

   198

		ROAD_SE | ROAD_NE, // 4

   199

		ROAD_ALL,

   200

		ROAD_X  | ROAD_SE,

   201

		ROAD_ALL,

   202

   203

		ROAD_NW | ROAD_NE, // 8

   204

		ROAD_X  | ROAD_NW,

   205

		ROAD_ALL,

   206

		ROAD_ALL,

   207

   208

		ROAD_Y  | ROAD_NE, // 12

   209

		ROAD_ALL,

   210

		ROAD_ALL

   211

	},

   212

};

   213

   214

   215

static uint32 CheckRoadSlope(Slope tileh, RoadBits* pieces, RoadBits existing)

   216

{

   217

	RoadBits road_bits;

   218

   219

	if (IsSteepSlope(tileh)) {

   220

		if (existing == 0) {

   221

			/* force full pieces. */

   222

			*pieces |= (RoadBits)((*pieces & 0xC) >> 2);

   223

			*pieces |= (RoadBits)((*pieces & 0x3) << 2);

   224

			if (*pieces == ROAD_X || *pieces == ROAD_Y) return _price.terraform;

   225

		}

   226

		return CMD_ERROR;

   227

	}

   228

	road_bits = *pieces | existing;

   229

   230

	/* no special foundation */

   231

	if ((~_valid_tileh_slopes_road[0][tileh] & road_bits) == 0) {

   232

		/* force that all bits are set when we have slopes */

   233

		if (tileh != SLOPE_FLAT) *pieces |= _valid_tileh_slopes_road[0][tileh];

   234

		return 0; // no extra cost

   235

	}

   236

   237

	/* foundation is used. Whole tile is leveled up */

   238

	if ((~_valid_tileh_slopes_road[1][tileh] & road_bits) == 0) {

   239

		return existing != 0 ? 0 : _price.terraform;

   240

	}

   241

   242

	/* partly leveled up tile, only if there's no road on that tile */

   243

	if (existing == 0 && (tileh == SLOPE_W || tileh == SLOPE_S || tileh == SLOPE_E || tileh == SLOPE_N)) {

   244

		/* force full pieces. */

   245

		*pieces |= (RoadBits)((*pieces & 0xC) >> 2);

   246

		*pieces |= (RoadBits)((*pieces & 0x3) << 2);

   247

		if (*pieces == ROAD_X || *pieces == ROAD_Y) return _price.terraform;

   248

	}

   249

	return CMD_ERROR;

   250

}

   251

   252

/** Build a piece of road.

   253

 * @param tile tile where to build road

   254

 * @param p1 bit 0..3 road pieces to build (RoadBits)

   255

 * @param p2 the town that is building the road (0 if not applicable)

   256

 */

   257

int32 CmdBuildRoad(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)

   258

{

   259

	int32 cost = 0;

   260

	int32 ret;

   261

	RoadBits existing = ROAD_NONE;

   262

	Slope tileh;

   263

   264

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   265

   266

	/* Road pieces are max 4 bitset values (NE, NW, SE, SW) and town can only be non-zero

   267

	 * if a non-player is building the road */

   268

	if ((IsValidPlayer(_current_player) && p2 != 0) || (_current_player == OWNER_TOWN && !IsValidTownID(p2))) return CMD_ERROR;

   269

   270

	RoadBits pieces = Extract<RoadBits, 0>(p1);

   271

   272

	tileh = GetTileSlope(tile, NULL);

   273

   274

	switch (GetTileType(tile)) {

   275

		case MP_STREET:

   276

			switch (GetRoadTileType(tile)) {

   277

				case ROAD_TILE_NORMAL:

   278

					if (HasRoadWorks(tile)) return_cmd_error(STR_ROAD_WORKS_IN_PROGRESS);

   279

   280

					existing = GetRoadBits(tile);

   281

					if ((existing & pieces) == pieces) {

   282

						return_cmd_error(STR_1007_ALREADY_BUILT);

   283

					}

   284

					if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   285

					break;

   286

   287

				case ROAD_TILE_CROSSING:

   288

					if (pieces != GetCrossingRoadBits(tile)) { // XXX is this correct?

   289

						return_cmd_error(STR_1007_ALREADY_BUILT);

   290

					}

   291

					goto do_clear;

   292

   293

				default:

   294

				case ROAD_TILE_DEPOT:

   295

					goto do_clear;

   296

			}

   297

			break;

   298

   299

		case MP_RAILWAY: {

   300

			Axis roaddir;

   301

   302

			if (IsSteepSlope(tileh)) {

   303

				return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   304

			}

   305

   306

#define M(x) (1 << (x))

   307

			/* Level crossings may only be built on these slopes */

   308

			if (!HASBIT(M(SLOPE_SEN) | M(SLOPE_ENW) | M(SLOPE_NWS) | M(SLOPE_NS) | M(SLOPE_WSE) | M(SLOPE_EW) | M(SLOPE_FLAT), tileh)) {

   309

				return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   310

			}

   311

#undef M

   312

   313

			if (GetRailTileType(tile) != RAIL_TILE_NORMAL) goto do_clear;

   314

			switch (GetTrackBits(tile)) {

   315

				case TRACK_BIT_X:

   316

					if (pieces & ROAD_X) goto do_clear;

   317

					roaddir = AXIS_Y;

   318

					break;

   319

   320

				case TRACK_BIT_Y:

   321

					if (pieces & ROAD_Y) goto do_clear;

   322

					roaddir = AXIS_X;

   323

					break;

   324

   325

				default: goto do_clear;

   326

			}

   327

   328

			if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   329

   330

			if (flags & DC_EXEC) {

   331

				YapfNotifyTrackLayoutChange(tile, FindFirstTrack(GetTrackBits(tile)));

   332

				MakeRoadCrossing(tile, _current_player, GetTileOwner(tile), roaddir, GetRailType(tile), p2);

   333

				MarkTileDirtyByTile(tile);

   334

			}

   335

			return _price.build_road * 2;

   336

		}

   337

   338

		default:

   339

do_clear:;

   340

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

   341

			if (CmdFailed(ret)) return ret;

   342

			cost += ret;

   343

	}

   344

   345

	ret = CheckRoadSlope(tileh, &pieces, existing);

   346

	/* Return an error if we need to build a foundation (ret != 0) but the

   347

	 * current patch-setting is turned off (or stupid AI@work) */

   348

	if (CmdFailed(ret) || (ret != 0 && (!_patches.build_on_slopes || _is_old_ai_player)))

   349

		return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   350

   351

	cost += ret;

   352

   353

	if (IsTileType(tile, MP_STREET)) {

   354

		/* Don't put the pieces that already exist */

   355

		pieces &= ComplementRoadBits(existing);

   356

	}

   357

   358

	cost += CountRoadBits(pieces) * _price.build_road;

   359

   360

	if (flags & DC_EXEC) {

   361

		if (IsTileType(tile, MP_STREET)) {

   362

			SetRoadBits(tile, existing | pieces);

   363

		} else {

   364

			MakeRoadNormal(tile, _current_player, pieces, p2);

   365

		}

   366

   367

		MarkTileDirtyByTile(tile);

   368

	}

   369

	return cost;

   370

}

   371

   372

/**

   373

 * Switches the rail type on a level crossing.

   374

 * @param tile        The tile on which the railtype is to be convert.

   375

 * @param totype      The railtype we want to convert to

   376

 * @param exec        Switches between test and execute mode

   377

 * @return            The cost and state of the operation

   378

 * @retval CMD_ERROR  An error occured during the operation.

   379

 */

   380

int32 DoConvertStreetRail(TileIndex tile, RailType totype, bool exec)

   381

{

   382

	/* not a railroad crossing? */

   383

	if (!IsLevelCrossing(tile)) return CMD_ERROR;

   384

   385

	/* not owned by me? */

   386

	if (!CheckTileOwnership(tile) || !EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   387

   388

	if (GetRailType(tile) == totype) return CMD_ERROR;

   389

   390

	/* 'hidden' elrails can't be downgraded to normal rail when elrails are disabled */

   391

	if (_patches.disable_elrails && totype == RAILTYPE_RAIL && GetRailType(tile) == RAILTYPE_ELECTRIC) return CMD_ERROR;

   392

   393

	if (exec) {

   394

		SetRailType(tile, totype);

   395

		MarkTileDirtyByTile(tile);

   396

		YapfNotifyTrackLayoutChange(tile, FindFirstTrack(GetCrossingRailBits(tile)));

   397

	}

   398

   399

	return _price.build_rail / 2;

   400

}

   401

   402

   403

/** Build a long piece of road.

   404

 * @param end_tile end tile of drag

   405

 * @param p1 start tile of drag

   406

 * @param p2 various bitstuffed elements

   407

 * - p2 = (bit 0) - start tile starts in the 2nd half of tile (p2 & 1)

   408

 * - p2 = (bit 1) - end tile starts in the 2nd half of tile (p2 & 2)

   409

 * - p2 = (bit 2) - direction: 0 = along x-axis, 1 = along y-axis (p2 & 4)

   410

 */

   411

int32 CmdBuildLongRoad(TileIndex end_tile, uint32 flags, uint32 p1, uint32 p2)

   412

{

   413

	TileIndex start_tile, tile;

   414

	int32 cost, ret;

   415

   416

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   417

   418

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

   419

   420

	start_tile = p1;

   421

   422

	/* Only drag in X or Y direction dictated by the direction variable */

   423

	if (!HASBIT(p2, 2) && TileY(start_tile) != TileY(end_tile)) return CMD_ERROR; // x-axis

   424

	if (HASBIT(p2, 2)  && TileX(start_tile) != TileX(end_tile)) return CMD_ERROR; // y-axis

   425

   426

	/* Swap start and ending tile, also the half-tile drag var (bit 0 and 1) */

   427

	if (start_tile > end_tile || (start_tile == end_tile && HASBIT(p2, 0))) {

   428

		TileIndex t = start_tile;

   429

		start_tile = end_tile;

   430

		end_tile = t;

   431

		p2 ^= IS_INT_INSIDE(p2&3, 1, 3) ? 3 : 0;

   432

	}

   433

   434

	cost = 0;

   435

	tile = start_tile;

   436

	/* Start tile is the small number. */

   437

	for (;;) {

   438

		RoadBits bits = HASBIT(p2, 2) ? ROAD_Y : ROAD_X;

   439

   440

		if (tile == end_tile && !HASBIT(p2, 1)) bits &= ROAD_NW | ROAD_NE;

   441

		if (tile == start_tile && HASBIT(p2, 0)) bits &= ROAD_SE | ROAD_SW;

   442

   443

		ret = DoCommand(tile, bits, 0, flags, CMD_BUILD_ROAD);

   444

		if (CmdFailed(ret)) {

   445

			if (_error_message != STR_1007_ALREADY_BUILT) return CMD_ERROR;

   446

			_error_message = INVALID_STRING_ID;

   447

		} else {

   448

			cost += ret;

   449

		}

   450

   451

		if (tile == end_tile) break;

   452

   453

		tile += HASBIT(p2, 2) ? TileDiffXY(0, 1) : TileDiffXY(1, 0);

   454

	}

   455

   456

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

   457

}

   458

   459

/** Remove a long piece of road.

   460

 * @param end_tile end tile of drag

   461

 * @param p1 start tile of drag

   462

 * @param p2 various bitstuffed elements

   463

 * - p2 = (bit 0) - start tile starts in the 2nd half of tile (p2 & 1)

   464

 * - p2 = (bit 1) - end tile starts in the 2nd half of tile (p2 & 2)

   465

 * - p2 = (bit 2) - direction: 0 = along x-axis, 1 = along y-axis (p2 & 4)

   466

 */

   467

int32 CmdRemoveLongRoad(TileIndex end_tile, uint32 flags, uint32 p1, uint32 p2)

   468

{

   469

	TileIndex start_tile, tile;

   470

	int32 cost, ret;

   471

   472

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   473

   474

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

   475

   476

	start_tile = p1;

   477

   478

	/* Only drag in X or Y direction dictated by the direction variable */

   479

	if (!HASBIT(p2, 2) && TileY(start_tile) != TileY(end_tile)) return CMD_ERROR; // x-axis

   480

	if (HASBIT(p2, 2)  && TileX(start_tile) != TileX(end_tile)) return CMD_ERROR; // y-axis

   481

   482

	/* Swap start and ending tile, also the half-tile drag var (bit 0 and 1) */

   483

	if (start_tile > end_tile || (start_tile == end_tile && HASBIT(p2, 0))) {

   484

		TileIndex t = start_tile;

   485

		start_tile = end_tile;

   486

		end_tile = t;