1

/* $Id$ */

     2

     3

/** @file road_cmd.cpp Commands related to road tiles. */

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

    13

#include "sprite.h"

    14

#include "tile_cmd.h"

    15

#include "landscape.h"

    16

#include "town_map.h"

    17

#include "viewport_func.h"

    18

#include "command_func.h"

    19

#include "town.h"

    20

#include "yapf/yapf.h"

    21

#include "depot_base.h"

    22

#include "depot_func.h"

    23

#include "newgrf.h"

    24

#include "station_map.h"

    25

#include "tunnel_map.h"

    26

#include "variables.h"

    27

#include "autoslope.h"

    28

#include "transparency.h"

    29

#include "tunnelbridge_map.h"

    30

#include "window_func.h"

    31

#include "strings_func.h"

    32

#include "vehicle_func.h"

    33

#include "vehicle_base.h"

    34

#include "sound_func.h"

    35

#include "road_func.h"

    36

#include "tunnelbridge.h"

    37

#include "cheat_func.h"

    38

#include "functions.h"

    39

#include "effectvehicle_func.h"

    40

#include "elrail_func.h"

    41

#include "oldpool_func.h"

    42

    43

#include "table/sprites.h"

    44

#include "table/strings.h"

    45

    46

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

    47

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

    48

static const uint32 VALID_LEVEL_CROSSING_SLOPES = (M(SLOPE_SEN) | M(SLOPE_ENW) | M(SLOPE_NWS) | M(SLOPE_NS) | M(SLOPE_WSE) | M(SLOPE_EW) | M(SLOPE_FLAT));

    49

#undef M

    50

    51

/* Invalid RoadBits on slopes  */

    52

static const RoadBits _invalid_tileh_slopes_road[2][15] = {

    53

	/* The inverse of the mixable RoadBits on a leveled slope */

    54

	{

    55

		ROAD_NONE,         // SLOPE_FLAT

    56

		ROAD_NE | ROAD_SE, // SLOPE_W

    57

		ROAD_NE | ROAD_NW, // SLOPE_S

    58

    59

		ROAD_NE,           // SLOPE_SW

    60

		ROAD_NW | ROAD_SW, // SLOPE_E

    61

		ROAD_NONE,         // SLOPE_EW

    62

    63

		ROAD_NW,           // SLOPE_SE

    64

		ROAD_NONE,         // SLOPE_WSE

    65

		ROAD_SE | ROAD_SW, // SLOPE_N

    66

    67

		ROAD_SE,           // SLOPE_NW

    68

		ROAD_NONE,         // SLOPE_NS

    69

		ROAD_NONE,         // SLOPE_ENW

    70

    71

		ROAD_SW,           // SLOPE_NE

    72

		ROAD_NONE,         // SLOPE_SEN

    73

		ROAD_NONE          // SLOPE_NWS

    74

	},

    75

	/* The inverse of the allowed straight roads on a slope

    76

	 * (with and without a foundation). */

    77

	{

    78

		ROAD_NONE, // SLOPE_FLAT

    79

		ROAD_NONE, // SLOPE_W    Foundation

    80

		ROAD_NONE, // SLOPE_S    Foundation

    81

    82

		ROAD_Y,    // SLOPE_SW

    83

		ROAD_NONE, // SLOPE_E    Foundation

    84

		ROAD_ALL,  // SLOPE_EW

    85

    86

		ROAD_X,    // SLOPE_SE

    87

		ROAD_ALL,  // SLOPE_WSE

    88

		ROAD_NONE, // SLOPE_N    Foundation

    89

    90

		ROAD_X,    // SLOPE_NW

    91

		ROAD_ALL,  // SLOPE_NS

    92

		ROAD_ALL,  // SLOPE_ENW

    93

    94

		ROAD_Y,    // SLOPE_NE

    95

		ROAD_ALL,  // SLOPE_SEN

    96

		ROAD_ALL   // SLOPE_NW

    97

	}

    98

};

    99

   100

Foundation GetRoadFoundation(Slope tileh, RoadBits bits);

   101

   102

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

   103

{

   104

	*edge_road = true;

   105

   106

	if (_game_mode == GM_EDITOR || remove == ROAD_NONE) return true;

   107

   108

	/* Water can always flood and towns can always remove "normal" road pieces.

   109

	 * Towns are not be allowed to remove non "normal" road pieces, like tram

   110

	 * tracks as that would result in trams that cannot turn. */

   111

	if (_current_player == OWNER_WATER ||

   112

			(rt == ROADTYPE_ROAD && !IsValidPlayer(_current_player))) return true;

   113

   114

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

   115

	 * by a town */

   116

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

   117

   118

	if (_cheats.magic_bulldozer.value) return true;

   119

   120

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

   121

	RoadBits n = ROAD_NONE;

   122

	RoadBits present = GetAnyRoadBits(tile, rt);

   123

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

   124

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

   125

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

   126

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

   127

   128

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

   129

	 * then allow it */

   130

	if (KillFirstBit(n) != ROAD_NONE && (n & remove) != ROAD_NONE) {

   131

		*edge_road = false;

   132

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

   133

		if (_patches.extra_dynamite) return true;

   134

   135

		const Town *t = ClosestTownFromTile(tile, (uint)-1);

   136

   137

		SetDParam(0, t->index);

   138

		_error_message = STR_2009_LOCAL_AUTHORITY_REFUSES;

   139

		return false;

   140

	}

   141

   142

	return true;

   143

}

   144

   145

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

   146

{

   147

	return CheckAllowRemoveRoad(tile, remove, GetRoadOwner(tile, rt), edge_road, rt);

   148

}

   149

   150

   151

/** Delete a piece of road.

   152

 * @param tile tile where to remove road from

   153

 * @param flags operation to perform

   154

 * @param pieces roadbits to remove

   155

 * @param rt roadtype to remove

   156

 * @param crossing_check should we check if there is a tram track when we are removing road from crossing?

   157

 */

   158

static CommandCost RemoveRoad(TileIndex tile, uint32 flags, RoadBits pieces, RoadType rt, bool crossing_check, bool town_check = true)

   159

{

   160

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

   161

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

   162

   163

	/* true if the roadpiece was always removeable,

   164

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

   165

	bool edge_road;

   166

   167

	Town *t = NULL;

   168

	switch (GetTileType(tile)) {

   169

		case MP_ROAD:

   170

			if (_game_mode != GM_EDITOR && GetRoadOwner(tile, rt) == OWNER_TOWN) t = GetTownByTile(tile);

   171

			if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   172

			break;

   173

   174

		case MP_STATION:

   175

			if (!IsDriveThroughStopTile(tile)) return CMD_ERROR;

   176

			if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   177

			break;

   178

   179

		case MP_TUNNELBRIDGE:

   180

			if (GetTunnelBridgeTransportType(tile) != TRANSPORT_ROAD) return CMD_ERROR;

   181

			if (GetVehicleTunnelBridge(tile, GetOtherTunnelBridgeEnd(tile)) != NULL) return CMD_ERROR;

   182

			break;

   183

   184

		default:

   185

			return CMD_ERROR;

   186

	}

   187

   188

	RoadTypes rts = GetRoadTypes(tile);

   189

	/* The tile doesn't have the given road type */

   190

	if (!HasBit(rts, rt)) return CMD_ERROR;

   191

   192

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

   193

   194

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

   195

	 * removal allowance depends on difficulty setting */

   196

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

   197

   198

	if (!IsTileType(tile, MP_ROAD)) {

   199

		/* If it's the last roadtype, just clear the whole tile */

   200

		if (rts == RoadTypeToRoadTypes(rt)) return DoCommand(tile, 0, 0, flags, CMD_LANDSCAPE_CLEAR);

   201

   202

		CommandCost cost(EXPENSES_CONSTRUCTION);

   203

		if (IsTileType(tile, MP_TUNNELBRIDGE)) {

   204

			TileIndex other_end = GetOtherTunnelBridgeEnd(tile);

   205

			/* Pay for *every* tile of the bridge or tunnel */

   206

			cost.AddCost((GetTunnelBridgeLength(other_end, tile) + 2) * _price.remove_road);

   207

			if (flags & DC_EXEC) {

   208

				SetRoadTypes(other_end, GetRoadTypes(other_end) & ~RoadTypeToRoadTypes(rt));

   209

				SetRoadTypes(tile, GetRoadTypes(tile) & ~RoadTypeToRoadTypes(rt));

   210

   211

				/* Mark tiles diry that have been repaved */

   212

				MarkTileDirtyByTile(tile);

   213

				MarkTileDirtyByTile(other_end);

   214

				if (IsBridge(tile)) {

   215

					TileIndexDiff delta = TileOffsByDiagDir(GetTunnelBridgeDirection(tile));

   216

   217

					for (TileIndex t = tile + delta; t != other_end; t += delta) MarkTileDirtyByTile(t);

   218

				}

   219

			}

   220

		} else {

   221

			cost.AddCost(_price.remove_road);

   222

			if (flags & DC_EXEC) {

   223

				SetRoadTypes(tile, GetRoadTypes(tile) & ~RoadTypeToRoadTypes(rt));

   224

				MarkTileDirtyByTile(tile);

   225

			}

   226

		}

   227

		return cost;

   228

	}

   229

   230

	switch (GetRoadTileType(tile)) {

   231

		case ROAD_TILE_NORMAL: {

   232

			const Slope tileh = GetTileSlope(tile, NULL);

   233

			RoadBits present = GetRoadBits(tile, rt);

   234

			const RoadBits other = GetOtherRoadBits(tile, rt);

   235

			const Foundation f = GetRoadFoundation(tileh, present);

   236

   237

			if (HasRoadWorks(tile) && _current_player != OWNER_WATER) return_cmd_error(STR_ROAD_WORKS_IN_PROGRESS);

   238

   239

			/* Autocomplete to a straight road

   240

			 * @li on steep slopes

   241

			 * @li if the bits of the other roadtypes result in another foundation

   242

			 * @li if build on slopes is disabled */

   243

			if (IsSteepSlope(tileh) || (IsStraightRoad(other) &&

   244

					(other & _invalid_tileh_slopes_road[0][tileh & SLOPE_ELEVATED]) != ROAD_NONE) ||

   245

					(tileh != SLOPE_FLAT && !_patches.build_on_slopes)) {

   246

				pieces |= MirrorRoadBits(pieces);

   247

			}

   248

   249

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

   250

			pieces &= present;

   251

			if (pieces == ROAD_NONE) return CMD_ERROR;

   252

   253

			/* Now set present what it will be after the remove */

   254

			present ^= pieces;

   255

   256

			/* Check for invalid RoadBit combinations on slopes */

   257

			if (tileh != SLOPE_FLAT && present != ROAD_NONE &&

   258

					(present & _invalid_tileh_slopes_road[0][tileh & SLOPE_ELEVATED]) == present) {

   259

				return CMD_ERROR;

   260

			}

   261

   262

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

   263

			if (flags & DC_EXEC) {

   264

				if (HasRoadWorks(tile)) {

   265

					/* flooding tile with road works, don't forget to remove the effect vehicle too */

   266

					assert(_current_player == OWNER_WATER);

   267

					Vehicle *v;

   268

					FOR_ALL_VEHICLES(v) {

   269

						if (v->type == VEH_EFFECT && TileVirtXY(v->x_pos, v->y_pos) == tile) {

   270

							delete v;

   271

						}

   272

					}

   273

				}

   274

				if (present == ROAD_NONE) {

   275

					RoadTypes rts = GetRoadTypes(tile) & ComplementRoadTypes(RoadTypeToRoadTypes(rt));

   276

					if (rts == ROADTYPES_NONE) {

   277

						/* Includes MarkTileDirtyByTile() */

   278

						DoClearSquare(tile);

   279

					} else {

   280

						SetRoadBits(tile, ROAD_NONE, rt);

   281

						SetRoadTypes(tile, rts);

   282

						MarkTileDirtyByTile(tile);

   283

					}

   284

				} else {

   285

					/* When bits are removed, you *always* end up with something that

   286

					 * is not a complete straight road tile. However, trams do not have

   287

					 * onewayness, so they cannot remove it either. */

   288

					if (rt != ROADTYPE_TRAM) SetDisallowedRoadDirections(tile, DRD_NONE);

   289

					SetRoadBits(tile, present, rt);

   290

					MarkTileDirtyByTile(tile);

   291

				}

   292

			}

   293

   294

			/* If we change the foundation we have to pay for it. */

   295

			return CommandCost(EXPENSES_CONSTRUCTION, CountBits(pieces) * _price.remove_road +

   296

					((GetRoadFoundation(tileh, present) != f) ? _price.terraform : (Money)0));

   297

		}

   298

   299

		case ROAD_TILE_CROSSING: {

   300

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

   301

				return CMD_ERROR;

   302

			}

   303

   304

			/* Don't allow road to be removed from the crossing when there is tram;

   305

			 * we can't draw the crossing without trambits ;) */

   306

			if (rt == ROADTYPE_ROAD && HasTileRoadType(tile, ROADTYPE_TRAM) && (flags & DC_EXEC || crossing_check)) return CMD_ERROR;

   307

   308

			if (rt == ROADTYPE_ROAD) {

   309

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

   310

			}

   311

   312

			if (flags & DC_EXEC) {

   313

				RoadTypes rts = GetRoadTypes(tile) & ComplementRoadTypes(RoadTypeToRoadTypes(rt));

   314

				if (rts == ROADTYPES_NONE) {

   315

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

   316

				} else {

   317

					SetRoadTypes(tile, rts);

   318

				}

   319

				MarkTileDirtyByTile(tile);

   320

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

   321

			}

   322

			return CommandCost(EXPENSES_CONSTRUCTION, _price.remove_road * 2);

   323

		}

   324

   325

		default:

   326

		case ROAD_TILE_DEPOT:

   327

			return CMD_ERROR;

   328

	}

   329

}

   330

   331

   332

/** Delete a piece of road.

   333

 * @param tile tile where to remove road from

   334

 * @param flags operation to perform

   335

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

   336

 *           bit 4..5 road type

   337

 * @param p2 unused

   338

 */

   339

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

   340

{

   341

	RoadType rt = (RoadType)GB(p1, 4, 2);

   342

	if (!IsValidRoadType(rt)) return CMD_ERROR;

   343

   344

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

   345

   346

	return RemoveRoad(tile, flags, pieces, rt, true);

   347

}

   348

   349

/**

   350

 * Calculate the costs for roads on slopes

   351

 *  Aside modify the RoadBits to fit on the slopes

   352

 *

   353

 * @note The RoadBits are modified too!

   354

 * @param tileh The current slope

   355

 * @param pieces The RoadBits we want to add

   356

 * @param existing The existent RoadBits of the current type

   357

 * @param other The other existent RoadBits

   358

 * @return The costs for these RoadBits on this slope

   359

 */

   360

static CommandCost CheckRoadSlope(Slope tileh, RoadBits *pieces, RoadBits existing, RoadBits other)

   361

{

   362

	/* Remove already build pieces */

   363

	CLRBITS(*pieces, existing);

   364

   365

	/* If we can't build anything stop here */

   366

	if (*pieces == ROAD_NONE) return CMD_ERROR;

   367

   368

	/* All RoadBit combos are valid on flat land */

   369

	if (tileh == SLOPE_FLAT) return CommandCost();

   370

   371

	/* Proceed steep Slopes first to reduce lookup table size */

   372

	if (IsSteepSlope(tileh)) {

   373

		/* Force straight roads. */

   374

		*pieces |= MirrorRoadBits(*pieces);

   375

   376

		/* Use existing as all existing since only straight

   377

		 * roads are allowed here. */

   378

		existing |= other;

   379

   380

		if ((existing == ROAD_NONE || existing == *pieces) && IsStraightRoad(*pieces)) {

   381

			return CommandCost(EXPENSES_CONSTRUCTION, _price.terraform);

   382

		}

   383

		return CMD_ERROR;

   384

	}

   385

   386

	/* Save the merge of all bits of the current type */

   387

	RoadBits type_bits = existing | *pieces;

   388

   389

	/* Roads on slopes */

   390

	if (_patches.build_on_slopes && (_invalid_tileh_slopes_road[0][tileh] & (other | type_bits)) == ROAD_NONE) {

   391

   392

		/* If we add leveling we've got to pay for it */

   393

		if ((other | existing) == ROAD_NONE) return CommandCost(EXPENSES_CONSTRUCTION, _price.terraform);

   394

   395

		return CommandCost();

   396

	}

   397

   398

	/* Autocomplete uphill roads */

   399

	*pieces |= MirrorRoadBits(*pieces);

   400

	type_bits = existing | *pieces;

   401

   402

	/* Uphill roads */

   403

	if (IsStraightRoad(type_bits) && (other == type_bits || other == ROAD_NONE) &&

   404

			(_invalid_tileh_slopes_road[1][tileh] & (other | type_bits)) == ROAD_NONE) {

   405

   406

		/* Slopes with foundation ? */

   407

		if (IsSlopeWithOneCornerRaised(tileh)) {

   408

   409

			/* Prevent build on slopes if it isn't allowed */

   410

			if (_patches.build_on_slopes) {

   411

   412

				/* If we add foundation we've got to pay for it */

   413

				if ((other | existing) == ROAD_NONE) return CommandCost(EXPENSES_CONSTRUCTION, _price.terraform);

   414

   415

				return CommandCost();

   416

			}

   417

		} else {

   418

			if (CountBits(existing) == 1) return CommandCost(EXPENSES_CONSTRUCTION, _price.terraform);

   419

			return CommandCost();

   420

		}

   421

	}

   422

	return CMD_ERROR;

   423

}

   424

   425

/** Build a piece of road.

   426

 * @param tile tile where to build road

   427

 * @param flags operation to perform

   428

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

   429

 *           bit 4..5 road type

   430

 *           bit 6..7 disallowed directions to toggle

   431

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

   432

 */

   433

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

   434

{

   435

	CommandCost cost(EXPENSES_CONSTRUCTION);

   436

   437

	RoadBits existing = ROAD_NONE;

   438

	RoadBits other_bits = ROAD_NONE;

   439

   440

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

   441

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

   442

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

   443

   444

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

   445

   446

	/* do not allow building 'zero' road bits, code wouldn't handle it */

   447

	if (pieces == ROAD_NONE) return CMD_ERROR;

   448

   449

	RoadType rt = (RoadType)GB(p1, 4, 2);

   450

	if (!IsValidRoadType(rt) || !ValParamRoadType(rt)) return CMD_ERROR;

   451

   452

	DisallowedRoadDirections toggle_drd = (DisallowedRoadDirections)GB(p1, 6, 2);

   453

   454

	Slope tileh = GetTileSlope(tile, NULL);

   455

   456

	switch (GetTileType(tile)) {

   457

		case MP_ROAD:

   458

			switch (GetRoadTileType(tile)) {

   459

				case ROAD_TILE_NORMAL: {

   460

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

   461

   462

					other_bits = GetOtherRoadBits(tile, rt);

   463

					if (!HasTileRoadType(tile, rt)) break;

   464

   465

					existing = GetRoadBits(tile, rt);

   466

					bool crossing = !IsStraightRoad(existing | pieces);

   467

					if (rt != ROADTYPE_TRAM && (GetDisallowedRoadDirections(tile) != DRD_NONE || toggle_drd != DRD_NONE) && crossing) {

   468

						/* Junctions cannot be one-way */

   469

						return_cmd_error(STR_ERR_ONEWAY_ROADS_CAN_T_HAVE_JUNCTION);

   470

					}

   471

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

   472

						/* We only want to set the (dis)allowed road directions */

   473

						if (toggle_drd != DRD_NONE && rt != ROADTYPE_TRAM && GetRoadOwner(tile, ROADTYPE_ROAD) == _current_player) {

   474

							if (crossing) return_cmd_error(STR_ERR_ONEWAY_ROADS_CAN_T_HAVE_JUNCTION);

   475

   476

							if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   477

   478

							/* Ignore half built tiles */

   479

							if (flags & DC_EXEC && rt != ROADTYPE_TRAM && IsStraightRoad(existing)) {

   480

								SetDisallowedRoadDirections(tile, GetDisallowedRoadDirections(tile) ^ toggle_drd);

   481

								MarkTileDirtyByTile(tile);

   482

							}

   483

							return CommandCost();

   484

						}