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

    22

#include "newgrf.h"

    23

#include "station_map.h"

    24

#include "tunnel_map.h"

    25

#include "misc/autoptr.hpp"

    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

    38

#include "table/sprites.h"

    39

#include "table/strings.h"

    40

    41

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

    42

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

    43

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));

    44

#undef M

    45

    46

/* Invalid RoadBits on slopes  */

    47

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

    48

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

    49

	{

    50

		ROAD_NONE,         // SLOPE_FLAT

    51

		ROAD_NE | ROAD_SE, // SLOPE_W

    52

		ROAD_NE | ROAD_NW, // SLOPE_S

    53

    54

		ROAD_NE,           // SLOPE_SW

    55

		ROAD_NW | ROAD_SW, // SLOPE_E

    56

		ROAD_NONE,         // SLOPE_EW

    57

    58

		ROAD_NW,           // SLOPE_SE

    59

		ROAD_NONE,         // SLOPE_WSE

    60

		ROAD_SE | ROAD_SW, // SLOPE_N

    61

    62

		ROAD_SE,           // SLOPE_NW

    63

		ROAD_NONE,         // SLOPE_NS

    64

		ROAD_NONE,         // SLOPE_ENW

    65

    66

		ROAD_SW,           // SLOPE_NE

    67

		ROAD_NONE,         // SLOPE_SEN

    68

		ROAD_NONE          // SLOPE_NWS

    69

	},

    70

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

    71

	 * (with and without a foundation). */

    72

	{

    73

		ROAD_NONE, // SLOPE_FLAT

    74

		ROAD_NONE, // SLOPE_W    Foundation

    75

		ROAD_NONE, // SLOPE_S    Foundation

    76

    77

		ROAD_Y,    // SLOPE_SW

    78

		ROAD_NONE, // SLOPE_E    Foundation

    79

		ROAD_ALL,  // SLOPE_EW

    80

    81

		ROAD_X,    // SLOPE_SE

    82

		ROAD_ALL,  // SLOPE_WSE

    83

		ROAD_NONE, // SLOPE_N    Foundation

    84

    85

		ROAD_X,    // SLOPE_NW

    86

		ROAD_ALL,  // SLOPE_NS

    87

		ROAD_ALL,  // SLOPE_ENW

    88

    89

		ROAD_Y,    // SLOPE_NE

    90

		ROAD_ALL,  // SLOPE_SEN

    91

		ROAD_ALL   // SLOPE_NW

    92

	}

    93

};

    94

    95

Foundation GetRoadFoundation(Slope tileh, RoadBits bits);

    96

    97

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

    98

{

    99

	*edge_road = true;

   100

   101

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

   102

   103

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

   104

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

   105

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

   106

	if (_current_player == OWNER_WATER ||

   107

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

   108

   109

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

   110

	 * by a town */

   111

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

   112

   113

	if (_cheats.magic_bulldozer.value) return true;

   114

   115

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

   116

	RoadBits n = ROAD_NONE;

   117

	RoadBits present = GetAnyRoadBits(tile, rt);

   118

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

   119

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

   120

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

   121

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

   122

   123

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

   124

	 * then allow it */

   125

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

   126

		*edge_road = false;

   127

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

   128

		if (_patches.extra_dynamite) return true;

   129

   130

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

   131

   132

		SetDParam(0, t->index);

   133

		_error_message = STR_2009_LOCAL_AUTHORITY_REFUSES;

   134

		return false;

   135

	}

   136

   137

	return true;

   138

}

   139

   140

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

   141

{

   142

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

   143

}

   144

   145

   146

/** Delete a piece of road.

   147

 * @param tile tile where to remove road from

   148

 * @param flags operation to perform

   149

 * @param pieces roadbits to remove

   150

 * @param rt roadtype to remove

   151

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

   152

 */

   153

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

   154

{

   155

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

   156

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

   157

   158

	/* true if the roadpiece was always removeable,

   159

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

   160

	bool edge_road;

   161

   162

	Town *t = NULL;

   163

	switch (GetTileType(tile)) {

   164

		case MP_ROAD:

   165

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

   166

			if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   167

			break;

   168

   169

		case MP_STATION:

   170

			if (!IsDriveThroughStopTile(tile)) return CMD_ERROR;

   171

			if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   172

			break;

   173

   174

		case MP_TUNNELBRIDGE:

   175

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

   176

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

   177

			break;

   178

   179

		default:

   180

			return CMD_ERROR;

   181

	}

   182

   183

	RoadTypes rts = GetRoadTypes(tile);

   184

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

   185

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

   186

   187

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

   188

   189

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

   190

	 * removal allowance depends on difficulty setting */

   191

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

   192

   193

	if (!IsTileType(tile, MP_ROAD)) {

   194

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

   195

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

   196

   197

		CommandCost cost(EXPENSES_CONSTRUCTION);

   198

		if (IsTileType(tile, MP_TUNNELBRIDGE)) {

   199

			TileIndex other_end = GetOtherTunnelBridgeEnd(tile);

   200

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

   201

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

   202

			if (flags & DC_EXEC) {

   203

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

   204

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

   205

   206

				/* Mark tiles diry that have been repaved */

   207

				MarkTileDirtyByTile(tile);

   208

				MarkTileDirtyByTile(other_end);

   209

				if (IsBridge(tile)) {

   210

					TileIndexDiff delta = TileOffsByDiagDir(GetTunnelBridgeDirection(tile));

   211

   212

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

   213

				}

   214

			}

   215

		} else {

   216

			cost.AddCost(_price.remove_road);

   217

			if (flags & DC_EXEC) {

   218

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

   219

				MarkTileDirtyByTile(tile);

   220

			}

   221

		}

   222

		return cost;

   223

	}

   224

   225

	switch (GetRoadTileType(tile)) {

   226

		case ROAD_TILE_NORMAL: {

   227

			const Slope tileh = GetTileSlope(tile, NULL);

   228

			RoadBits present = GetRoadBits(tile, rt);

   229

			const RoadBits other = GetOtherRoadBits(tile, rt);

   230

			const Foundation f = GetRoadFoundation(tileh, present);

   231

   232

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

   233

   234

			/* Autocomplete to a straight road

   235

			 * @li on steep slopes

   236

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

   237

			 * @li if build on slopes is disabled */

   238

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

   239

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

   240

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

   241

				pieces |= MirrorRoadBits(pieces);

   242

			}

   243

   244

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

   245

			pieces &= present;

   246

			if (pieces == ROAD_NONE) return CMD_ERROR;

   247

   248

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

   249

			present ^= pieces;

   250

   251

			/* Check for invalid RoadBit combinations on slopes */

   252

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

   253

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

   254

				return CMD_ERROR;

   255

			}

   256

   257

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

   258

			if (flags & DC_EXEC) {

   259

				if (present == ROAD_NONE) {

   260

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

   261

					if (rts == ROADTYPES_NONE) {

   262

						/* Includes MarkTileDirtyByTile() */

   263

						DoClearSquare(tile);

   264

					} else {

   265

						SetRoadBits(tile, ROAD_NONE, rt);

   266

						SetRoadTypes(tile, rts);

   267

						MarkTileDirtyByTile(tile);

   268

					}

   269

				} else {

   270

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

   271

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

   272

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

   273

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

   274

					SetRoadBits(tile, present, rt);

   275

					MarkTileDirtyByTile(tile);

   276

				}

   277

			}

   278

   279

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

   280

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

   281

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

   282

		}

   283

   284

		case ROAD_TILE_CROSSING: {

   285

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

   286

				return CMD_ERROR;

   287

			}

   288

   289

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

   290

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

   291

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

   292

   293

			if (rt == ROADTYPE_ROAD) {

   294

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

   295

			}

   296

   297

			if (flags & DC_EXEC) {

   298

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

   299

				if (rts == ROADTYPES_NONE) {

   300

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

   301

				} else {

   302

					SetRoadTypes(tile, rts);

   303

				}

   304

				MarkTileDirtyByTile(tile);

   305

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

   306

			}

   307

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

   308

		}

   309

   310

		default:

   311

		case ROAD_TILE_DEPOT:

   312

			return CMD_ERROR;

   313

	}

   314

}

   315

   316

   317

/** Delete a piece of road.

   318

 * @param tile tile where to remove road from

   319

 * @param flags operation to perform

   320

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

   321

 *           bit 4..5 road type

   322

 * @param p2 unused

   323

 */

   324

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

   325

{

   326

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

   327

	if (!IsValidRoadType(rt)) return CMD_ERROR;

   328

   329

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

   330

   331

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

   332

}

   333

   334

/**

   335

 * Calculate the costs for roads on slopes

   336

 *  Aside modify the RoadBits to fit on the slopes

   337

 *

   338

 * @note The RoadBits are modified too!

   339

 * @param tileh The current slope

   340

 * @param pieces The RoadBits we want to add

   341

 * @param existing The existent RoadBits of the current type

   342

 * @param other The other existent RoadBits

   343

 * @return The costs for these RoadBits on this slope

   344

 */

   345

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

   346

{

   347

	/* Remove already build pieces */

   348

	CLRBITS(*pieces, existing);

   349

   350

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

   351

	if (*pieces == ROAD_NONE) return CMD_ERROR;

   352

   353

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

   354

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

   355

   356

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

   357

	if (IsSteepSlope(tileh)) {

   358

		/* Force straight roads. */

   359

		*pieces |= MirrorRoadBits(*pieces);

   360

   361

		/* Use existing as all existing since only straight

   362

		 * roads are allowed here. */

   363

		existing |= other;

   364

   365

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

   366

			return CommandCost(EXPENSES_CONSTRUCTION, _price.terraform);

   367

		}

   368

		return CMD_ERROR;

   369

	}

   370

   371

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

   372

	RoadBits type_bits = existing | *pieces;

   373

   374

	/* Roads on slopes */

   375

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

   376

   377

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

   378

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

   379

   380

		return CommandCost();

   381

	}

   382

   383

	/* Autocomplete uphill roads */

   384

	*pieces |= MirrorRoadBits(*pieces);

   385

	type_bits = existing | *pieces;

   386

   387

	/* Uphill roads */

   388

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

   389

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

   390

   391

		/* Slopes with foundation ? */

   392

		if (IsSlopeWithOneCornerRaised(tileh)) {

   393

   394

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

   395

			if (_patches.build_on_slopes) {

   396

   397

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

   398

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

   399

   400

				return CommandCost();

   401

			}

   402

		} else {

   403

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

   404

			return CommandCost();

   405

		}

   406

	}

   407

	return CMD_ERROR;

   408

}

   409

   410

/** Build a piece of road.

   411

 * @param tile tile where to build road

   412

 * @param flags operation to perform

   413

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

   414

 *           bit 4..5 road type

   415

 *           bit 6..7 disallowed directions to toggle

   416

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

   417

 */

   418

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

   419

{

   420

	CommandCost cost(EXPENSES_CONSTRUCTION);

   421

	CommandCost ret;

   422

	RoadBits existing = ROAD_NONE;

   423

	RoadBits other_bits = ROAD_NONE;

   424

   425

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

   426

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

   427

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

   428

   429

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

   430

   431

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

   432

	if (pieces == ROAD_NONE) return CMD_ERROR;

   433

   434

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

   435

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

   436

   437

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

   438

   439

	Slope tileh = GetTileSlope(tile, NULL);

   440

   441

	switch (GetTileType(tile)) {

   442

		case MP_ROAD:

   443

			switch (GetRoadTileType(tile)) {

   444

				case ROAD_TILE_NORMAL: {

   445

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

   446

   447

					other_bits = GetOtherRoadBits(tile, rt);

   448

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

   449

   450

					existing = GetRoadBits(tile, rt);

   451

					bool crossing = !IsStraightRoad(existing | pieces);

   452

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

   453

						/* Junctions cannot be one-way */

   454

						return_cmd_error(STR_ERR_ONEWAY_ROADS_CAN_T_HAVE_JUNCTION);

   455

					}

   456

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

   457

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

   458

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

   459

							if (crossing) return_cmd_error(STR_ERR_ONEWAY_ROADS_CAN_T_HAVE_JUNCTION);

   460

   461

							if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   462

   463

							/* Ignore half built tiles */

   464

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

   465

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

   466

								MarkTileDirtyByTile(tile);

   467

							}

   468

							return CommandCost();

   469

						}

   470

						return_cmd_error(STR_1007_ALREADY_BUILT);

   471

					}

   472

				} break;

   473

   474

				case ROAD_TILE_CROSSING:

   475

					if (HasTileRoadType(tile, rt)) return_cmd_error(STR_1007_ALREADY_BUILT);

   476

					other_bits = GetCrossingRoadBits(tile);

   477

					if (pieces & ComplementRoadBits(other_bits)) goto do_clear;

   478

					break;

   479

   480

				default:

   481

				case ROAD_TILE_DEPOT:

   482

					goto do_clear;

   483

			}

   484

			break;