1

/* $Id$ */

     2

     3

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

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "map_func.h"

     8

#include "bridge_map.h"

     9

#include "bridge.h"

    10

#include "cmd_helper.h"

    11

#include "rail_map.h"

    12

#include "road_map.h"

    13

#include "road_internal.h"

    14

#include "sprite.h"

    15

#include "tile_cmd.h"

    16

#include "landscape.h"

    17

#include "town_map.h"

    18

#include "viewport_func.h"

    19

#include "command_func.h"

    20

#include "town.h"

    21

#include "yapf/yapf.h"

    22

#include "depot_base.h"

    23

#include "depot_func.h"

    24

#include "newgrf.h"

    25

#include "station_map.h"

    26

#include "tunnel_map.h"

    27

#include "variables.h"

    28

#include "autoslope.h"

    29

#include "transparency.h"

    30

#include "tunnelbridge_map.h"

    31

#include "window_func.h"

    32

#include "strings_func.h"

    33

#include "vehicle_func.h"

    34

#include "vehicle_base.h"

    35

#include "sound_func.h"

    36

#include "road_func.h"

    37

#include "tunnelbridge.h"

    38

#include "cheat_func.h"

    39

#include "functions.h"

    40

#include "effectvehicle_func.h"

    41

#include "elrail_func.h"

    42

#include "oldpool_func.h"

    43

    44

#include "table/sprites.h"

    45

#include "table/strings.h"

    46

    47

/**

    48

 * Verify whether a road vehicle is available.

    49

 * @return \c true if at least one road vehicle is available, \c false if not

    50

 */

    51

bool RoadVehiclesAreBuilt()

    52

{

    53

	const Vehicle* v;

    54

    55

	FOR_ALL_VEHICLES(v) {

    56

		if (v->type == VEH_ROAD) return true;

    57

	}

    58

	return false;

    59

}

    60

    61

/**

    62

 * Change the side of the road vehicles drive on (server only).

    63

 * @param tile unused

    64

 * @param flags operation to perform

    65

 * @param p1 the side of the road; 0 = left side and 1 = right side

    66

 * @param p2 unused

    67

 */

    68

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

    69

{

    70

	/* Check boundaries and you can only change this if NO vehicles have been built yet,

    71

	 * except in the intro-menu where of course it's always possible to do so. */

    72

	if (p1 > 1 || (_game_mode != GM_MENU && RoadVehiclesAreBuilt())) return CMD_ERROR;

    73

    74

	if (flags & DC_EXEC) {

    75

		if (_game_mode == GM_MENU) {

    76

			_settings_newgame.vehicle.road_side = p1;

    77

		} else {

    78

			_settings_game.vehicle.road_side = p1;

    79

		}

    80

		InvalidateWindow(WC_GAME_OPTIONS, 0);

    81

	}

    82

	return CommandCost();

    83

}

    84

    85

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

    86

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

    87

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

    88

#undef M

    89

    90

/* Invalid RoadBits on slopes  */

    91

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

    92

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

    93

	{

    94

		ROAD_NONE,         // SLOPE_FLAT

    95

		ROAD_NE | ROAD_SE, // SLOPE_W

    96

		ROAD_NE | ROAD_NW, // SLOPE_S

    97

    98

		ROAD_NE,           // SLOPE_SW

    99

		ROAD_NW | ROAD_SW, // SLOPE_E

   100

		ROAD_NONE,         // SLOPE_EW

   101

   102

		ROAD_NW,           // SLOPE_SE

   103

		ROAD_NONE,         // SLOPE_WSE

   104

		ROAD_SE | ROAD_SW, // SLOPE_N

   105

   106

		ROAD_SE,           // SLOPE_NW

   107

		ROAD_NONE,         // SLOPE_NS

   108

		ROAD_NONE,         // SLOPE_ENW

   109

   110

		ROAD_SW,           // SLOPE_NE

   111

		ROAD_NONE,         // SLOPE_SEN

   112

		ROAD_NONE          // SLOPE_NWS

   113

	},

   114

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

   115

	 * (with and without a foundation). */

   116

	{

   117

		ROAD_NONE, // SLOPE_FLAT

   118

		ROAD_NONE, // SLOPE_W    Foundation

   119

		ROAD_NONE, // SLOPE_S    Foundation

   120

   121

		ROAD_Y,    // SLOPE_SW

   122

		ROAD_NONE, // SLOPE_E    Foundation

   123

		ROAD_ALL,  // SLOPE_EW

   124

   125

		ROAD_X,    // SLOPE_SE

   126

		ROAD_ALL,  // SLOPE_WSE

   127

		ROAD_NONE, // SLOPE_N    Foundation

   128

   129

		ROAD_X,    // SLOPE_NW

   130

		ROAD_ALL,  // SLOPE_NS

   131

		ROAD_ALL,  // SLOPE_ENW

   132

   133

		ROAD_Y,    // SLOPE_NE

   134

		ROAD_ALL,  // SLOPE_SEN

   135

		ROAD_ALL   // SLOPE_NW

   136

	}

   137

};

   138

   139

Foundation GetRoadFoundation(Slope tileh, RoadBits bits);

   140

   141

/**

   142

 * Is it allowed to remove the given road bits from the given tile?

   143

 * @param tile      the tile to remove the road from

   144

 * @param remove    the roadbits that are going to be removed

   145

 * @param owner     the actual owner of the roadbits of the tile

   146

 * @param rt        the road type to remove the bits from

   147

 * @param flags     command flags

   148

 * @param town_check Shall the town rating checked/affected

   149

 * @return true when it is allowed to remove the road bits

   150

 */

   151

bool CheckAllowRemoveRoad(TileIndex tile, RoadBits remove, Owner owner, RoadType rt, uint32 flags, bool town_check)

   152

{

   153

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

   154

   155

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

   156

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

   157

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

   158

	if (_current_company == OWNER_WATER ||

   159

			(rt == ROADTYPE_ROAD && !IsValidCompanyID(_current_company))) return true;

   160

   161

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

   162

	 * by a town */

   163

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

   164

   165

	if (!town_check) return true;

   166

   167

	if (_cheats.magic_bulldozer.value) return true;

   168

   169

	Town *t = ClosestTownFromTile(tile, UINT_MAX);

   170

	if (t == NULL) return true;

   171

   172

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

   173

	 * removal allowance depends on difficulty setting */

   174

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

   175

   176

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

   177

	RoadBits n = ROAD_NONE;

   178

	RoadBits present = GetAnyRoadBits(tile, rt);

   179

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

   180

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

   181

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

   182

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

   183

   184

	int rating_decrease = RATING_ROAD_DOWN_STEP_EDGE;

   185

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

   186

	 * then allow it */

   187

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

   188

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

   189

		if (!_settings_game.construction.extra_dynamite) {

   190

			SetDParam(0, t->index);

   191

			_error_message = STR_2009_LOCAL_AUTHORITY_REFUSES;

   192

			return false;

   193

		}

   194

		rating_decrease = RATING_ROAD_DOWN_STEP_INNER;

   195

	}

   196

	ChangeTownRating(t, rating_decrease, RATING_ROAD_MINIMUM);

   197

   198

	return true;

   199

}

   200

   201

   202

/** Delete a piece of road.

   203

 * @param tile tile where to remove road from

   204

 * @param flags operation to perform

   205

 * @param pieces roadbits to remove

   206

 * @param rt roadtype to remove

   207

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

   208

 */

   209

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

   210

{

   211

	RoadTypes rts = GetRoadTypes(tile);

   212

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

   213

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

   214

   215

	bool town_road_under_stop = false;

   216

   217

	switch (GetTileType(tile)) {

   218

		case MP_ROAD:

   219

			if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   220

			break;

   221

   222

		case MP_STATION:

   223

			if (!IsDriveThroughStopTile(tile)) return CMD_ERROR;

   224

			if (rt == ROADTYPE_ROAD) town_road_under_stop = GetStopBuiltOnTownRoad(tile);

   225

			if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   226

			break;

   227

   228

		case MP_TUNNELBRIDGE:

   229

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

   230

			if (HasVehicleOnTunnelBridge(tile, GetOtherTunnelBridgeEnd(tile))) return CMD_ERROR;

   231

			break;

   232

   233

		default:

   234

			return CMD_ERROR;

   235

	}

   236

   237

	if (!CheckAllowRemoveRoad(tile, pieces, town_road_under_stop ? OWNER_TOWN : GetRoadOwner(tile, rt), rt, flags, town_check)) return CMD_ERROR;

   238

   239

	if (!IsTileType(tile, MP_ROAD)) {

   240

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

   241

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

   242

   243

		CommandCost cost(EXPENSES_CONSTRUCTION);

   244

		if (IsTileType(tile, MP_TUNNELBRIDGE)) {

   245

			TileIndex other_end = GetOtherTunnelBridgeEnd(tile);

   246

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

   247

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

   248

			if (flags & DC_EXEC) {

   249

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

   250

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

   251

   252

				/* Mark tiles diry that have been repaved */

   253

				MarkTileDirtyByTile(tile);

   254

				MarkTileDirtyByTile(other_end);

   255

				if (IsBridge(tile)) {

   256

					TileIndexDiff delta = TileOffsByDiagDir(GetTunnelBridgeDirection(tile));

   257

   258

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

   259

				}

   260

			}

   261

		} else {

   262

			assert(IsDriveThroughStopTile(tile));

   263

			cost.AddCost(_price.remove_road * 2);

   264

			if (flags & DC_EXEC) {

   265

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

   266

				MarkTileDirtyByTile(tile);

   267

			}

   268

		}

   269

		return cost;

   270

	}

   271

   272

	switch (GetRoadTileType(tile)) {

   273

		case ROAD_TILE_NORMAL: {

   274

			const Slope tileh = GetTileSlope(tile, NULL);

   275

			RoadBits present = GetRoadBits(tile, rt);

   276

			const RoadBits other = GetOtherRoadBits(tile, rt);

   277

			const Foundation f = GetRoadFoundation(tileh, present);

   278

   279

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

   280

   281

			/* Autocomplete to a straight road

   282

			 * @li on steep slopes

   283

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

   284

			 * @li if build on slopes is disabled */

   285

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

   286

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

   287

					(tileh != SLOPE_FLAT && !_settings_game.construction.build_on_slopes)) {

   288

				pieces |= MirrorRoadBits(pieces);

   289

			}

   290

   291

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

   292

			pieces &= present;

   293

			if (pieces == ROAD_NONE) return CMD_ERROR;

   294

   295

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

   296

			present ^= pieces;

   297

   298

			/* Check for invalid RoadBit combinations on slopes */

   299

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

   300

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

   301

				return CMD_ERROR;

   302

			}

   303

   304

			if (flags & DC_EXEC) {

   305

				if (HasRoadWorks(tile)) {

   306

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

   307

					assert(_current_company == OWNER_WATER);

   308

					Vehicle *v;

   309

					FOR_ALL_VEHICLES(v) {

   310

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

   311

							delete v;

   312

						}

   313

					}

   314

				}

   315

				if (present == ROAD_NONE) {

   316

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

   317

					if (rts == ROADTYPES_NONE) {

   318

						/* Includes MarkTileDirtyByTile() */

   319

						DoClearSquare(tile);

   320

					} else {

   321

						if (rt == ROADTYPE_ROAD && IsRoadOwner(tile, ROADTYPE_ROAD, OWNER_TOWN)) {

   322

							/* Update nearest-town index */

   323

							const Town *town = CalcClosestTownFromTile(tile, UINT_MAX);

   324

							SetTownIndex(tile, town == NULL ? (TownID)INVALID_TOWN : town->index);

   325

						}

   326

						SetRoadBits(tile, ROAD_NONE, rt);

   327

						SetRoadTypes(tile, rts);

   328

						MarkTileDirtyByTile(tile);

   329

					}

   330

				} else {

   331

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

   332

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

   333

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

   334

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

   335

					SetRoadBits(tile, present, rt);

   336

					MarkTileDirtyByTile(tile);

   337

				}

   338

			}

   339

   340

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

   341

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

   342

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

   343

		}

   344

   345

		case ROAD_TILE_CROSSING: {

   346

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

   347

				return CMD_ERROR;

   348

			}

   349

   350

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

   351

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

   352

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

   353

   354

			if (flags & DC_EXEC) {

   355

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

   356

				if (rts == ROADTYPES_NONE) {

   357

					TrackBits tracks = GetCrossingRailBits(tile);

   358

					bool reserved = GetCrossingReservation(tile);

   359

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

   360

					if (reserved) SetTrackReservation(tile, tracks);

   361

				} else {

   362

					SetRoadTypes(tile, rts);

   363

					/* If we ever get HWAY and it is possible without road then we will need to promote ownership and invalidate town index here, too */

   364

				}

   365

				MarkTileDirtyByTile(tile);

   366

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

   367

			}

   368

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

   369

		}

   370

   371

		default:

   372

		case ROAD_TILE_DEPOT:

   373

			return CMD_ERROR;

   374

	}

   375

}

   376

   377

   378

/** Delete a piece of road.

   379

 * @param tile tile where to remove road from

   380

 * @param flags operation to perform

   381

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

   382

 *           bit 4..5 road type

   383

 * @param p2 unused

   384

 */

   385

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

   386

{

   387

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

   388

	if (!IsValidRoadType(rt)) return CMD_ERROR;

   389

   390

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

   391

   392

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

   393

}

   394

   395

/**

   396

 * Calculate the costs for roads on slopes

   397

 *  Aside modify the RoadBits to fit on the slopes

   398

 *

   399

 * @note The RoadBits are modified too!

   400

 * @param tileh The current slope

   401

 * @param pieces The RoadBits we want to add

   402

 * @param existing The existent RoadBits of the current type

   403

 * @param other The other existent RoadBits

   404

 * @return The costs for these RoadBits on this slope

   405

 */

   406

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

   407

{

   408

	/* Remove already build pieces */

   409

	CLRBITS(*pieces, existing);

   410

   411

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

   412

	if (*pieces == ROAD_NONE) return CMD_ERROR;

   413

   414

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

   415

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

   416

   417

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

   418

	if (IsSteepSlope(tileh)) {

   419

		/* Force straight roads. */

   420

		*pieces |= MirrorRoadBits(*pieces);

   421

   422

		/* Use existing as all existing since only straight

   423

		 * roads are allowed here. */

   424

		existing |= other;

   425

   426

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

   427

			return CommandCost(EXPENSES_CONSTRUCTION, _price.terraform);

   428

		}

   429

		return CMD_ERROR;

   430

	}

   431

   432

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

   433

	RoadBits type_bits = existing | *pieces;

   434

   435

	/* Roads on slopes */

   436

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

   437

   438

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

   439

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

   440

   441

		return CommandCost();

   442

	}

   443

   444

	/* Autocomplete uphill roads */

   445

	*pieces |= MirrorRoadBits(*pieces);

   446

	type_bits = existing | *pieces;

   447

   448

	/* Uphill roads */

   449

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

   450

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

   451

   452

		/* Slopes with foundation ? */

   453

		if (IsSlopeWithOneCornerRaised(tileh)) {

   454

   455

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

   456

			if (_settings_game.construction.build_on_slopes) {

   457

   458

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

   459

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

   460

   461

				return CommandCost();

   462

			}

   463

		} else {

   464

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

   465

			return CommandCost();

   466

		}

   467

	}

   468

	return CMD_ERROR;

   469

}

   470

   471

/** Build a piece of road.

   472

 * @param tile tile where to build road

   473

 * @param flags operation to perform

   474

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

   475

 *           bit 4..5 road type

   476

 *           bit 6..7 disallowed directions to toggle

   477

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

   478

 */

   479

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

   480

{

   481

	CommandCost cost(EXPENSES_CONSTRUCTION);

   482

   483

	RoadBits existing = ROAD_NONE;

   484

	RoadBits other_bits = ROAD_NONE;

   485