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

    41

    42

#include "table/sprites.h"

    43

#include "table/strings.h"

    44

    45

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

    46

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

    47

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

    48

#undef M

    49

    50

/* Invalid RoadBits on slopes  */

    51

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

    52

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

    53

	{

    54

		ROAD_NONE,         // SLOPE_FLAT

    55

		ROAD_NE | ROAD_SE, // SLOPE_W

    56

		ROAD_NE | ROAD_NW, // SLOPE_S

    57

    58

		ROAD_NE,           // SLOPE_SW

    59

		ROAD_NW | ROAD_SW, // SLOPE_E

    60

		ROAD_NONE,         // SLOPE_EW

    61

    62

		ROAD_NW,           // SLOPE_SE

    63

		ROAD_NONE,         // SLOPE_WSE

    64

		ROAD_SE | ROAD_SW, // SLOPE_N

    65

    66

		ROAD_SE,           // SLOPE_NW

    67

		ROAD_NONE,         // SLOPE_NS

    68

		ROAD_NONE,         // SLOPE_ENW

    69

    70

		ROAD_SW,           // SLOPE_NE

    71

		ROAD_NONE,         // SLOPE_SEN

    72

		ROAD_NONE          // SLOPE_NWS

    73

	},

    74

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

    75

	 * (with and without a foundation). */

    76

	{

    77

		ROAD_NONE, // SLOPE_FLAT

    78

		ROAD_NONE, // SLOPE_W    Foundation

    79

		ROAD_NONE, // SLOPE_S    Foundation

    80

    81

		ROAD_Y,    // SLOPE_SW

    82

		ROAD_NONE, // SLOPE_E    Foundation

    83

		ROAD_ALL,  // SLOPE_EW

    84

    85

		ROAD_X,    // SLOPE_SE

    86

		ROAD_ALL,  // SLOPE_WSE

    87

		ROAD_NONE, // SLOPE_N    Foundation

    88

    89

		ROAD_X,    // SLOPE_NW

    90

		ROAD_ALL,  // SLOPE_NS

    91

		ROAD_ALL,  // SLOPE_ENW

    92

    93

		ROAD_Y,    // SLOPE_NE

    94

		ROAD_ALL,  // SLOPE_SEN

    95

		ROAD_ALL   // SLOPE_NW

    96

	}

    97

};

    98

    99

Foundation GetRoadFoundation(Slope tileh, RoadBits bits);

   100

   101

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

   102

{

   103

	*edge_road = true;

   104

   105

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

   106

   107

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

   108

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

   109

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

   110

	if (_current_player == OWNER_WATER ||

   111

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

   112

   113

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

   114

	 * by a town */

   115

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

   116

   117

	if (_cheats.magic_bulldozer.value) return true;

   118

   119

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

   120

	RoadBits n = ROAD_NONE;

   121

	RoadBits present = GetAnyRoadBits(tile, rt);

   122

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

   123

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

   124

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

   125

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

   126

   127

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

   128

	 * then allow it */

   129

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

   130

		*edge_road = false;

   131

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

   132

		if (_patches.extra_dynamite) return true;

   133

   134

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

   135

   136

		SetDParam(0, t->index);

   137

		_error_message = STR_2009_LOCAL_AUTHORITY_REFUSES;

   138

		return false;

   139

	}

   140

   141

	return true;

   142

}

   143

   144

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

   145

{

   146

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

   147

}

   148

   149

   150

/** Delete a piece of road.

   151

 * @param tile tile where to remove road from

   152

 * @param flags operation to perform

   153

 * @param pieces roadbits to remove

   154

 * @param rt roadtype to remove

   155

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

   156

 */

   157

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

   158

{

   159

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

   160

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

   161

   162

	/* true if the roadpiece was always removeable,

   163

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

   164

	bool edge_road;

   165

   166

	Town *t = NULL;

   167

	switch (GetTileType(tile)) {

   168

		case MP_ROAD:

   169

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

   170

			if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   171

			break;

   172

   173

		case MP_STATION:

   174

			if (!IsDriveThroughStopTile(tile)) return CMD_ERROR;

   175

			if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   176

			break;

   177

   178

		case MP_TUNNELBRIDGE:

   179

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

   180

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

   181

			break;

   182

   183

		default:

   184

			return CMD_ERROR;

   185

	}

   186

   187

	RoadTypes rts = GetRoadTypes(tile);

   188

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

   189

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

   190

   191

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

   192

   193

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

   194

	 * removal allowance depends on difficulty setting */

   195

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

   196

   197

	if (!IsTileType(tile, MP_ROAD)) {

   198

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

   199

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

   200

   201

		CommandCost cost(EXPENSES_CONSTRUCTION);

   202

		if (IsTileType(tile, MP_TUNNELBRIDGE)) {

   203

			TileIndex other_end = GetOtherTunnelBridgeEnd(tile);

   204

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

   205

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

   206

			if (flags & DC_EXEC) {

   207

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

   208

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

   209

   210

				/* Mark tiles diry that have been repaved */

   211

				MarkTileDirtyByTile(tile);

   212

				MarkTileDirtyByTile(other_end);

   213

				if (IsBridge(tile)) {

   214

					TileIndexDiff delta = TileOffsByDiagDir(GetTunnelBridgeDirection(tile));

   215

   216

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

   217

				}

   218

			}

   219

		} else {

   220

			cost.AddCost(_price.remove_road);

   221

			if (flags & DC_EXEC) {

   222

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

   223

				MarkTileDirtyByTile(tile);

   224

			}

   225

		}

   226

		return cost;

   227

	}

   228

   229

	switch (GetRoadTileType(tile)) {

   230

		case ROAD_TILE_NORMAL: {

   231

			const Slope tileh = GetTileSlope(tile, NULL);

   232

			RoadBits present = GetRoadBits(tile, rt);

   233

			const RoadBits other = GetOtherRoadBits(tile, rt);

   234

			const Foundation f = GetRoadFoundation(tileh, present);

   235

   236

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

   237

   238

			/* Autocomplete to a straight road

   239

			 * @li on steep slopes

   240

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

   241

			 * @li if build on slopes is disabled */

   242

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

   243

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

   244

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

   245

				pieces |= MirrorRoadBits(pieces);

   246

			}

   247

   248

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

   249

			pieces &= present;

   250

			if (pieces == ROAD_NONE) return CMD_ERROR;

   251

   252

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

   253

			present ^= pieces;

   254

   255

			/* Check for invalid RoadBit combinations on slopes */

   256

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

   257

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

   258

				return CMD_ERROR;

   259

			}

   260

   261

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

   262

			if (flags & DC_EXEC) {

   263

				if (HasRoadWorks(tile)) {

   264

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

   265

					assert(_current_player == OWNER_WATER);

   266

					Vehicle *v;

   267

					FOR_ALL_VEHICLES(v) {

   268

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

   269

							delete v;

   270

						}

   271

					}

   272

				}

   273

				if (present == ROAD_NONE) {

   274

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

   275

					if (rts == ROADTYPES_NONE) {

   276

						/* Includes MarkTileDirtyByTile() */

   277

						DoClearSquare(tile);

   278

					} else {

   279

						SetRoadBits(tile, ROAD_NONE, rt);

   280

						SetRoadTypes(tile, rts);

   281

						MarkTileDirtyByTile(tile);

   282

					}

   283

				} else {

   284

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

   285

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

   286

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

   287

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

   288

					SetRoadBits(tile, present, rt);

   289

					MarkTileDirtyByTile(tile);

   290

				}

   291

			}

   292

   293

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

   294

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

   295

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

   296

		}

   297

   298

		case ROAD_TILE_CROSSING: {

   299

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

   300

				return CMD_ERROR;

   301

			}

   302

   303

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

   304

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

   305

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

   306

   307

			if (rt == ROADTYPE_ROAD) {

   308

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

   309

			}

   310

   311

			if (flags & DC_EXEC) {

   312

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

   313

				if (rts == ROADTYPES_NONE) {

   314

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

   315

				} else {

   316

					SetRoadTypes(tile, rts);

   317

				}

   318

				MarkTileDirtyByTile(tile);

   319

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

   320

			}

   321

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

   322

		}

   323

   324

		default:

   325

		case ROAD_TILE_DEPOT:

   326

			return CMD_ERROR;

   327

	}

   328

}

   329

   330

   331

/** Delete a piece of road.

   332

 * @param tile tile where to remove road from

   333

 * @param flags operation to perform

   334

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

   335

 *           bit 4..5 road type

   336

 * @param p2 unused

   337

 */

   338

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

   339

{

   340

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

   341

	if (!IsValidRoadType(rt)) return CMD_ERROR;

   342

   343

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

   344

   345

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

   346

}

   347

   348

/**

   349

 * Calculate the costs for roads on slopes

   350

 *  Aside modify the RoadBits to fit on the slopes

   351

 *

   352

 * @note The RoadBits are modified too!

   353

 * @param tileh The current slope

   354

 * @param pieces The RoadBits we want to add

   355

 * @param existing The existent RoadBits of the current type

   356

 * @param other The other existent RoadBits

   357

 * @return The costs for these RoadBits on this slope

   358

 */

   359

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

   360

{

   361

	/* Remove already build pieces */

   362

	CLRBITS(*pieces, existing);

   363

   364

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

   365

	if (*pieces == ROAD_NONE) return CMD_ERROR;

   366

   367

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

   368

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

   369

   370

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

   371

	if (IsSteepSlope(tileh)) {

   372

		/* Force straight roads. */

   373

		*pieces |= MirrorRoadBits(*pieces);

   374

   375

		/* Use existing as all existing since only straight

   376

		 * roads are allowed here. */

   377

		existing |= other;

   378

   379

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

   380

			return CommandCost(EXPENSES_CONSTRUCTION, _price.terraform);

   381

		}

   382

		return CMD_ERROR;

   383

	}

   384

   385

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

   386

	RoadBits type_bits = existing | *pieces;

   387

   388

	/* Roads on slopes */

   389

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

   390

   391

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

   392

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

   393

   394

		return CommandCost();

   395

	}

   396

   397

	/* Autocomplete uphill roads */

   398

	*pieces |= MirrorRoadBits(*pieces);

   399

	type_bits = existing | *pieces;

   400

   401

	/* Uphill roads */

   402

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

   403

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

   404

   405

		/* Slopes with foundation ? */

   406

		if (IsSlopeWithOneCornerRaised(tileh)) {

   407

   408

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

   409

			if (_patches.build_on_slopes) {

   410

   411

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

   412

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

   413

   414

				return CommandCost();

   415

			}

   416

		} else {

   417

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

   418

			return CommandCost();

   419

		}

   420

	}

   421

	return CMD_ERROR;

   422

}

   423

   424

/** Build a piece of road.

   425

 * @param tile tile where to build road

   426

 * @param flags operation to perform

   427

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

   428

 *           bit 4..5 road type

   429

 *           bit 6..7 disallowed directions to toggle

   430

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

   431

 */

   432

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

   433

{

   434

	CommandCost cost(EXPENSES_CONSTRUCTION);

   435

   436

	RoadBits existing = ROAD_NONE;

   437

	RoadBits other_bits = ROAD_NONE;

   438

   439

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

   440

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

   441

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

   442

   443

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

   444

   445

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

   446

	if (pieces == ROAD_NONE) return CMD_ERROR;

   447

   448

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

   449

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

   450

   451

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

   452

   453

	Slope tileh = GetTileSlope(tile, NULL);

   454

   455

	switch (GetTileType(tile)) {

   456

		case MP_ROAD:

   457

			switch (GetRoadTileType(tile)) {

   458

				case ROAD_TILE_NORMAL: {

   459

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

   460

   461

					other_bits = GetOtherRoadBits(tile, rt);

   462

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

   463

   464

					existing = GetRoadBits(tile, rt);

   465

					bool crossing = !IsStraightRoad(existing | pieces);

   466

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

   467

						/* Junctions cannot be one-way */

   468

						return_cmd_error(STR_ERR_ONEWAY_ROADS_CAN_T_HAVE_JUNCTION);

   469

					}

   470

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

   471

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

   472

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

   473

							if (crossing) return_cmd_error(STR_ERR_ONEWAY_ROADS_CAN_T_HAVE_JUNCTION);

   474

   475

							if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   476

   477

							/* Ignore half built tiles */

   478

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

   479

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

   480

								MarkTileDirtyByTile(tile);

   481

							}

   482

							return CommandCost();

   483

						}