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

    47

bool RoadVehiclesAreBuilt()

    48

{

    49

	const Vehicle* v;

    50

    51

	FOR_ALL_VEHICLES(v) {

    52

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

    53

	}

    54

	return false;

    55

}

    56

    57

/**

    58

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

    59

 * @param tile unused

    60

 * @param flags operation to perform

    61

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

    62

 * @param p2 unused

    63

 */

    64

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

    65

{

    66

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

    67

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

    68

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

    69

    70

	if (flags & DC_EXEC) {

    71

		if (_game_mode == GM_MENU) {

    72

			_settings_newgame.vehicle.road_side = p1;

    73

		} else {

    74

			_settings_game.vehicle.road_side = p1;

    75

		}

    76

		InvalidateWindow(WC_GAME_OPTIONS, 0);

    77

	}

    78

	return CommandCost();

    79

}

    80

    81

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

    82

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

    83

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

    84

#undef M

    85

    86

/* Invalid RoadBits on slopes  */

    87

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

    88

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

    89

	{

    90

		ROAD_NONE,         // SLOPE_FLAT

    91

		ROAD_NE | ROAD_SE, // SLOPE_W

    92

		ROAD_NE | ROAD_NW, // SLOPE_S

    93

    94

		ROAD_NE,           // SLOPE_SW

    95

		ROAD_NW | ROAD_SW, // SLOPE_E

    96

		ROAD_NONE,         // SLOPE_EW

    97

    98

		ROAD_NW,           // SLOPE_SE

    99

		ROAD_NONE,         // SLOPE_WSE

   100

		ROAD_SE | ROAD_SW, // SLOPE_N

   101

   102

		ROAD_SE,           // SLOPE_NW

   103

		ROAD_NONE,         // SLOPE_NS

   104

		ROAD_NONE,         // SLOPE_ENW

   105

   106

		ROAD_SW,           // SLOPE_NE

   107

		ROAD_NONE,         // SLOPE_SEN

   108

		ROAD_NONE          // SLOPE_NWS

   109

	},

   110

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

   111

	 * (with and without a foundation). */

   112

	{

   113

		ROAD_NONE, // SLOPE_FLAT

   114

		ROAD_NONE, // SLOPE_W    Foundation

   115

		ROAD_NONE, // SLOPE_S    Foundation

   116

   117

		ROAD_Y,    // SLOPE_SW

   118

		ROAD_NONE, // SLOPE_E    Foundation

   119

		ROAD_ALL,  // SLOPE_EW

   120

   121

		ROAD_X,    // SLOPE_SE

   122

		ROAD_ALL,  // SLOPE_WSE

   123

		ROAD_NONE, // SLOPE_N    Foundation

   124

   125

		ROAD_X,    // SLOPE_NW

   126

		ROAD_ALL,  // SLOPE_NS

   127

		ROAD_ALL,  // SLOPE_ENW

   128

   129

		ROAD_Y,    // SLOPE_NE

   130

		ROAD_ALL,  // SLOPE_SEN

   131

		ROAD_ALL   // SLOPE_NW

   132

	}

   133

};

   134

   135

Foundation GetRoadFoundation(Slope tileh, RoadBits bits);

   136

   137

/**

   138

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

   139

 * @param tile      the tile to remove the road from

   140

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

   141

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

   142

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

   143

 * @param flags     command flags

   144

 * @param town_check Shall the town rating checked/affected

   145

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

   146

 */

   147

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

   148

{

   149

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

   150

   151

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

   152

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

   153

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

   154

	if (_current_player == OWNER_WATER ||

   155

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

   156

   157

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

   158

	 * by a town */

   159

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

   160

   161

	if (!town_check) return true;

   162

   163

	if (_cheats.magic_bulldozer.value) return true;

   164

   165

	Town *t = ClosestTownFromTile(tile, UINT_MAX);

   166

	if (t == NULL) return true;

   167

   168

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

   169

	 * removal allowance depends on difficulty setting */

   170

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

   171

   172

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

   173

	RoadBits n = ROAD_NONE;

   174

	RoadBits present = GetAnyRoadBits(tile, rt);

   175

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

   176

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

   177

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

   178

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

   179

   180

	int rating_decrease = RATING_ROAD_DOWN_STEP_EDGE;

   181

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

   182

	 * then allow it */

   183

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

   184

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

   185

		if (!_settings_game.construction.extra_dynamite) {

   186

			SetDParam(0, t->index);

   187

			_error_message = STR_2009_LOCAL_AUTHORITY_REFUSES;

   188

			return false;

   189

		}

   190

		rating_decrease = RATING_ROAD_DOWN_STEP_INNER;

   191

	}

   192

	ChangeTownRating(t, rating_decrease, RATING_ROAD_MINIMUM);

   193

   194

	return true;

   195

}

   196

   197

   198

/** Delete a piece of road.

   199

 * @param tile tile where to remove road from

   200

 * @param flags operation to perform

   201

 * @param pieces roadbits to remove

   202

 * @param rt roadtype to remove

   203

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

   204

 */

   205

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

   206

{

   207

	RoadTypes rts = GetRoadTypes(tile);

   208

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

   209

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

   210

   211

	bool town_road_under_stop = false;

   212

   213

	switch (GetTileType(tile)) {

   214

		case MP_ROAD:

   215

			if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   216

			break;

   217

   218

		case MP_STATION:

   219

			if (!IsDriveThroughStopTile(tile)) return CMD_ERROR;

   220

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

   221

			if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   222

			break;

   223

   224

		case MP_TUNNELBRIDGE:

   225

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

   226

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

   227

			break;

   228

   229

		default:

   230

			return CMD_ERROR;

   231

	}

   232

   233

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

   234

   235

	if (!IsTileType(tile, MP_ROAD)) {

   236

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

   237

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

   238

   239

		CommandCost cost(EXPENSES_CONSTRUCTION);

   240

		if (IsTileType(tile, MP_TUNNELBRIDGE)) {

   241

			TileIndex other_end = GetOtherTunnelBridgeEnd(tile);

   242

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

   243

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

   244

			if (flags & DC_EXEC) {

   245

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

   246

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

   247

   248

				/* Mark tiles diry that have been repaved */

   249

				MarkTileDirtyByTile(tile);

   250

				MarkTileDirtyByTile(other_end);

   251

				if (IsBridge(tile)) {

   252

					TileIndexDiff delta = TileOffsByDiagDir(GetTunnelBridgeDirection(tile));

   253

   254

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

   255

				}

   256

			}

   257

		} else {

   258

			assert(IsDriveThroughStopTile(tile));

   259

			cost.AddCost(_price.remove_road * 2);

   260

			if (flags & DC_EXEC) {

   261

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

   262

				MarkTileDirtyByTile(tile);

   263

			}

   264

		}

   265

		return cost;

   266

	}

   267

   268

	switch (GetRoadTileType(tile)) {

   269

		case ROAD_TILE_NORMAL: {

   270

			const Slope tileh = GetTileSlope(tile, NULL);

   271

			RoadBits present = GetRoadBits(tile, rt);

   272

			const RoadBits other = GetOtherRoadBits(tile, rt);

   273

			const Foundation f = GetRoadFoundation(tileh, present);

   274

   275

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

   276

   277

			/* Autocomplete to a straight road

   278

			 * @li on steep slopes

   279

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

   280

			 * @li if build on slopes is disabled */

   281

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

   282

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

   283

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

   284

				pieces |= MirrorRoadBits(pieces);

   285

			}

   286

   287

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

   288

			pieces &= present;

   289

			if (pieces == ROAD_NONE) return CMD_ERROR;

   290

   291

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

   292

			present ^= pieces;

   293

   294

			/* Check for invalid RoadBit combinations on slopes */

   295

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

   296

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

   297

				return CMD_ERROR;

   298

			}

   299

   300

			if (flags & DC_EXEC) {

   301

				if (HasRoadWorks(tile)) {

   302

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

   303

					assert(_current_player == OWNER_WATER);

   304

					Vehicle *v;

   305

					FOR_ALL_VEHICLES(v) {

   306

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

   307

							delete v;

   308

						}

   309

					}

   310

				}

   311

				if (present == ROAD_NONE) {

   312

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

   313

					if (rts == ROADTYPES_NONE) {

   314

						/* Includes MarkTileDirtyByTile() */

   315

						DoClearSquare(tile);

   316

					} else {

   317

						SetRoadBits(tile, ROAD_NONE, rt);

   318

						SetRoadTypes(tile, rts);

   319

						MarkTileDirtyByTile(tile);

   320

					}

   321

				} else {

   322

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

   323

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

   324

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

   325

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

   326

					SetRoadBits(tile, present, rt);

   327

					MarkTileDirtyByTile(tile);

   328

				}

   329

			}

   330

   331

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

   332

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

   333

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

   334

		}

   335

   336

		case ROAD_TILE_CROSSING: {

   337

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

   338

				return CMD_ERROR;

   339

			}

   340

   341

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

   342

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

   343

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

   344

   345

			if (flags & DC_EXEC) {

   346

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

   347

				if (rts == ROADTYPES_NONE) {

   348

					TrackBits tracks = GetCrossingRailBits(tile);

   349

					bool reserved = GetCrossingReservation(tile);

   350

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

   351

					if (reserved) SetTrackReservation(tile, tracks);

   352

				} else {

   353

					SetRoadTypes(tile, rts);

   354

				}

   355

				MarkTileDirtyByTile(tile);

   356

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

   357

			}

   358

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

   359

		}

   360

   361

		default:

   362

		case ROAD_TILE_DEPOT:

   363

			return CMD_ERROR;

   364

	}

   365

}

   366

   367

   368

/** Delete a piece of road.

   369

 * @param tile tile where to remove road from

   370

 * @param flags operation to perform

   371

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

   372

 *           bit 4..5 road type

   373

 * @param p2 unused

   374

 */

   375

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

   376

{

   377

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

   378

	if (!IsValidRoadType(rt)) return CMD_ERROR;

   379

   380

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

   381

   382

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

   383

}

   384

   385

/**

   386

 * Calculate the costs for roads on slopes

   387

 *  Aside modify the RoadBits to fit on the slopes

   388

 *

   389

 * @note The RoadBits are modified too!

   390

 * @param tileh The current slope

   391

 * @param pieces The RoadBits we want to add

   392

 * @param existing The existent RoadBits of the current type

   393

 * @param other The other existent RoadBits

   394

 * @return The costs for these RoadBits on this slope

   395

 */

   396

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

   397

{

   398

	/* Remove already build pieces */

   399

	CLRBITS(*pieces, existing);

   400

   401

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

   402

	if (*pieces == ROAD_NONE) return CMD_ERROR;

   403

   404

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

   405

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

   406

   407

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

   408

	if (IsSteepSlope(tileh)) {

   409

		/* Force straight roads. */

   410

		*pieces |= MirrorRoadBits(*pieces);

   411

   412

		/* Use existing as all existing since only straight

   413

		 * roads are allowed here. */

   414

		existing |= other;

   415

   416

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

   417

			return CommandCost(EXPENSES_CONSTRUCTION, _price.terraform);

   418

		}

   419

		return CMD_ERROR;

   420

	}

   421

   422

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

   423

	RoadBits type_bits = existing | *pieces;

   424

   425

	/* Roads on slopes */

   426

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

   427

   428

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

   429

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

   430

   431

		return CommandCost();

   432

	}

   433

   434

	/* Autocomplete uphill roads */

   435

	*pieces |= MirrorRoadBits(*pieces);

   436

	type_bits = existing | *pieces;

   437

   438

	/* Uphill roads */

   439

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

   440

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

   441

   442

		/* Slopes with foundation ? */

   443

		if (IsSlopeWithOneCornerRaised(tileh)) {

   444

   445

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

   446

			if (_settings_game.construction.build_on_slopes) {

   447

   448

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

   449

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

   450

   451

				return CommandCost();

   452

			}

   453

		} else {

   454

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

   455

			return CommandCost();

   456

		}

   457

	}

   458

	return CMD_ERROR;

   459

}

   460

   461

/** Build a piece of road.

   462

 * @param tile tile where to build road

   463

 * @param flags operation to perform

   464

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

   465

 *           bit 4..5 road type

   466

 *           bit 6..7 disallowed directions to toggle

   467

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

   468

 */

   469

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

   470

{

   471

	CommandCost cost(EXPENSES_CONSTRUCTION);

   472

   473

	RoadBits existing = ROAD_NONE;

   474

	RoadBits other_bits = ROAD_NONE;

   475

   476

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

   477

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

   478

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

   479

   480

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

   481

   482

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

   483

	if (pieces == ROAD_NONE) return CMD_ERROR;

   484