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 "table/sprites.h"

    15

#include "table/strings.h"

    16

#include "tile_cmd.h"

    17

#include "landscape.h"

    18

#include "town_map.h"

    19

#include "viewport.h"

    20

#include "command_func.h"

    21

#include "player.h"

    22

#include "town.h"

    23

#include "yapf/yapf.h"

    24

#include "depot.h"

    25

#include "newgrf.h"

    26

#include "station_map.h"

    27

#include "tunnel_map.h"

    28

#include "misc/autoptr.hpp"

    29

#include "autoslope.h"

    30

#include "transparency.h"

    31

#include "tunnelbridge_map.h"

    32

#include "window_func.h"

    33

#include "strings_func.h"

    34

#include "vehicle_func.h"

    35

#include "vehicle_base.h"

    36

#include "sound_func.h"

    37

    38

    39

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

    40

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

    41

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

    42

#undef M

    43

    44

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

    45

{

    46

	RoadBits present;

    47

	RoadBits n;

    48

	*edge_road = true;

    49

    50

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

    51

    52

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

    53

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

    54

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

    55

	if (_current_player == OWNER_WATER ||

    56

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

    57

    58

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

    59

	 * by a town */

    60

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

    61

    62

	if (_cheats.magic_bulldozer.value) return true;

    63

    64

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

    65

	n = ROAD_NONE;

    66

	present = GetAnyRoadBits(tile, rt);

    67

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

    68

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

    69

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

    70

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

    71

    72

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

    73

	 * then allow it */

    74

	if ((n & (n - 1)) != 0 && (n & remove) != 0) {

    75

		Town *t;

    76

		*edge_road = false;

    77

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

    78

		if (_patches.extra_dynamite) return true;

    79

    80

		t = ClosestTownFromTile(tile, (uint)-1);

    81

    82

		SetDParam(0, t->index);

    83

		_error_message = STR_2009_LOCAL_AUTHORITY_REFUSES;

    84

		return false;

    85

	}

    86

    87

	return true;

    88

}

    89

    90

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

    91

{

    92

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

    93

}

    94

    95

/** Delete a piece of road.

    96

 * @param tile tile where to remove road from

    97

 * @param flags operation to perform

    98

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

    99

 *           bit 4..5 road type

   100

 *           bit    6 ignore the fact that the tram track has not been removed

   101

 *                    yet when removing the road bits when not actually doing

   102

 *                    it. Makes it possible to test whether the road bits can

   103

 *                    be removed from a level crossing without physically

   104

 *                    removing the tram bits before the test.

   105

 * @param p2 unused

   106

 */

   107

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

   108

{

   109

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

   110

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

   111

   112

	/* true if the roadpiece was always removeable,

   113

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

   114

	bool edge_road;

   115

   116

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   117

   118

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

   119

	if (!IsValidRoadType(rt)) return CMD_ERROR;

   120

   121

	Town *t = NULL;

   122

	switch (GetTileType(tile)) {

   123

		case MP_ROAD:

   124

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

   125

			if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   126

			break;

   127

   128

		case MP_STATION:

   129

			if (!IsDriveThroughStopTile(tile)) return CMD_ERROR;

   130

			if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   131

			break;

   132

   133

		case MP_TUNNELBRIDGE:

   134

			{

   135

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

   136

				TileIndex endtile = IsTunnel(tile) ? GetOtherTunnelEnd(tile) : GetOtherBridgeEnd(tile);

   137

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

   138

			} break;

   139

   140

		default:

   141

			return CMD_ERROR;

   142

	}

   143

   144

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

   145

	RoadTypes rts = GetRoadTypes(tile);

   146

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

   147

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

   148

   149

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

   150

   151

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

   152

	 * removal allowance depends on difficulty setting */

   153

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

   154

   155

	if (!IsTileType(tile, MP_ROAD)) {

   156

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

   157

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

   158

   159

		CommandCost cost;

   160

		if (IsTileType(tile, MP_TUNNELBRIDGE)) {

   161

			TileIndex other_end = IsTunnel(tile) ? GetOtherTunnelEnd(tile) : GetOtherBridgeEnd(tile);

   162

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

   163

			cost.AddCost((DistanceManhattan(IsTunnel(tile) ? GetOtherTunnelEnd(tile) : GetOtherBridgeEnd(tile), tile) + 1) * _price.remove_road);

   164

			if (flags & DC_EXEC) {

   165

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

   166

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

   167

   168

				/* Mark tiles diry that have been repaved */

   169

				MarkTileDirtyByTile(tile);

   170

				MarkTileDirtyByTile(other_end);

   171

				if (IsBridge(tile)) {

   172

					TileIndexDiff delta = TileOffsByDiagDir(GetTunnelBridgeDirection(tile));

   173

   174

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

   175

				}

   176

			}

   177

		} else {

   178

			cost.AddCost(_price.remove_road);

   179

			if (flags & DC_EXEC) {

   180

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

   181

				MarkTileDirtyByTile(tile);

   182

			}

   183

		}

   184

		return CommandCost(cost);

   185

	}

   186

   187

	switch (GetRoadTileType(tile)) {

   188

		case ROAD_TILE_NORMAL: {

   189

			RoadBits present = GetRoadBits(tile, rt);

   190

			RoadBits c = pieces;

   191

   192

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

   193

   194

			if (GetTileSlope(tile, NULL) != SLOPE_FLAT  &&

   195

					(present == ROAD_Y || present == ROAD_X)) {

   196

				c |= (RoadBits)((c & 0xC) >> 2);

   197

				c |= (RoadBits)((c & 0x3) << 2);

   198

			}

   199

   200

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

   201

			c &= present;

   202

			if (c == ROAD_NONE) return CMD_ERROR;

   203

   204

			if (flags & DC_EXEC) {

   207

				present ^= c;

   208

				if (present == ROAD_NONE) {

   209

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

   210

					if (rts == ROADTYPES_NONE) {

   211

						/* Includes MarkTileDirtyByTile() */

   212

						DoClearSquare(tile);

   213

					} else {

   214

						SetRoadBits(tile, ROAD_NONE, rt);

   215

						SetRoadTypes(tile, rts);

   216

						MarkTileDirtyByTile(tile);

   217

					}

   218

				} else {

   219

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

   220

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

   221

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

   222

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

   223

					SetRoadBits(tile, present, rt);

   224

					MarkTileDirtyByTile(tile);

   225

				}

   226

			}

   227

			return CommandCost(CountBits(c) * _price.remove_road);

   228

		}

   229

   230

		case ROAD_TILE_CROSSING: {

   231

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

   232

				return CMD_ERROR;

   233

			}

   234

   235

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

   236

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

   237

			if (rt == ROADTYPE_ROAD && HasBit(GetRoadTypes(tile), ROADTYPE_TRAM) && ((flags & DC_EXEC) || !HasBit(p1, 6))) return CMD_ERROR;

   238

   243

   244

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

   245

				if (rts == ROADTYPES_NONE) {

   246

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

   247

				} else {

   248

					SetRoadTypes(tile, rts);

   249

				}

   250

				MarkTileDirtyByTile(tile);

   251

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

   252

			}

   253

			return CommandCost(_price.remove_road * 2);

   254

		}

   255

   256

		default:

   257

		case ROAD_TILE_DEPOT:

   258

			return CMD_ERROR;

   259

	}

   260

}

   261

   262

   263

static const RoadBits _valid_tileh_slopes_road[][15] = {

   264

	/* set of normal ones */

   265

	{

   266

		ROAD_ALL,  // SLOPE_FLAT

   267

		ROAD_NONE, // SLOPE_W

   268

		ROAD_NONE, // SLOPE_S

   269

   270

		ROAD_X,    // SLOPE_SW

   271

		ROAD_NONE, // SLOPE_E

   272

		ROAD_NONE, // SLOPE_EW

   273

   274

		ROAD_Y,    // SLOPE_SE

   275

		ROAD_NONE, // SLOPE_WSE

   276

		ROAD_NONE, // SLOPE_N

   277

   278

		ROAD_Y,    // SLOPE_NW

   279

		ROAD_NONE, // SLOPE_NS

   280

		ROAD_NONE, // SLOPE_NE

   281

   282

		ROAD_X,    // SLOPE_ENW

   283

		ROAD_NONE, // SLOPE_SEN

   284

		ROAD_NONE  // SLOPE_ELEVATED

   285

	},

   286

	/* allowed road for an evenly raised platform */

   287

	{

   288

		ROAD_NONE,         // SLOPE_FLAT

   289

		ROAD_SW | ROAD_NW, // SLOPE_W

   290

		ROAD_SW | ROAD_SE, // SLOPE_S

   291

   292

		ROAD_Y  | ROAD_SW, // SLOPE_SW

   293

		ROAD_SE | ROAD_NE, // SLOPE_E

   294

		ROAD_ALL,          // SLOPE_EW

   295

   296

		ROAD_X  | ROAD_SE, // SLOPE_SE

   297

		ROAD_ALL,          // SLOPE_WSE

   298

		ROAD_NW | ROAD_NE, // SLOPE_N

   299

   300

		ROAD_X  | ROAD_NW, // SLOPE_NW

   301

		ROAD_ALL,          // SLOPE_NS

   302

		ROAD_ALL,          // SLOPE_NE

   303

   304

		ROAD_Y  | ROAD_NE, // SLOPE_ENW

   305

		ROAD_ALL,          // SLOPE_SEN

   306

		ROAD_ALL           // SLOPE_ELEVATED

   307

	},

   308

	/* Singe bits on slopes */

   309

	{

   310

		ROAD_ALL,          // SLOPE_FLAT

   311

		ROAD_NE | ROAD_SE, // SLOPE_W

   312

		ROAD_NE | ROAD_NW, // SLOPE_S

   313

   314

		ROAD_NE,           // SLOPE_SW

   315

		ROAD_NW | ROAD_SW, // SLOPE_E

   316

		ROAD_ALL,          // SLOPE_EW

   317

   318

		ROAD_NW,           // SLOPE_SE

   319

		ROAD_ALL,          // SLOPE_WSE

   320

		ROAD_SE | ROAD_SW, // SLOPE_N

   321

   322

		ROAD_SE,           // SLOPE_NW

   323

		ROAD_ALL,          // SLOPE_NS

   324

		ROAD_ALL,          // SLOPE_NE

   325

   326

		ROAD_SW,           // SLOPE_ENW

   327

		ROAD_ALL,          // SLOPE_SEN

   328

		ROAD_ALL,          // SLOPE_ELEVATED

   329

	},

   330

};

   331

   332

/**

   333

 * Calculate the costs for roads on slopes

   334

 *  Aside modify the RoadBits to fit on the slopes

   335

 *

   336

 * @note The RoadBits are modified too!

   337

 * @param tileh The current slope

   338

 * @param pieces The RoadBits we want to add

   339

 * @param existing The existent RoadBits

   340

 * @return The costs for these RoadBits on this slope

   341

 */

   342

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

   343

{

   344

	if (IsSteepSlope(tileh)) {

   345

		/* Force straight roads. */

   346

		*pieces |= MirrorRoadBits(*pieces);

   347

   348

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

   349

			if (*pieces == ROAD_X || *pieces == ROAD_Y) return _price.terraform;

   350

		}

   351

		return CMD_ERROR;

   352

	}

   353

   354

	RoadBits road_bits = *pieces | existing;

   355

   356

	/* Single bits on slopes.

   357

	 * We check for the roads that need at least 2 bits */

   358

	if (_patches.build_on_slopes && !_is_old_ai_player &&

   359

			existing == ROAD_NONE && CountBits(*pieces) == 1 &&

   360

			(_valid_tileh_slopes_road[2][tileh] & *pieces) == ROAD_NONE) {

   361

		return CommandCost(_price.terraform);

   362

	}

   363

   364

	/* no special foundation */

   365

	if ((~_valid_tileh_slopes_road[0][tileh] & road_bits) == ROAD_NONE) {

   366

		/* force that all bits are set when we have slopes */

   367

		if (tileh != SLOPE_FLAT) *pieces |= _valid_tileh_slopes_road[0][tileh];

   368

		return CommandCost(); // no extra cost

   369

	}

   370

   371

	/* foundation is used. Whole tile is leveled up */

   372

	if ((~_valid_tileh_slopes_road[1][tileh] & road_bits) == ROAD_NONE) {

   373

		return CommandCost(existing != ROAD_NONE ? (Money)0 : _price.terraform);

   374

	}

   375

   376

	/* Force straight roads. */

   377

	*pieces |= MirrorRoadBits(*pieces);

   378

   379

	/* partly leveled up tile, only if there's no road on that tile */

   380

	if ((existing == ROAD_NONE || existing == *pieces) && (tileh == SLOPE_W || tileh == SLOPE_S || tileh == SLOPE_E || tileh == SLOPE_N)) {

   381

		if (*pieces == ROAD_X || *pieces == ROAD_Y) return _price.terraform;

   382

	}

   383

	return CMD_ERROR;

   384

}

   385

   386

/** Build a piece of road.

   387

 * @param tile tile where to build road

   388

 * @param flags operation to perform

   389

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

   390

 *           bit 4..5 road type

   391

 *           bit 6..7 disallowed directions to toggle

   392

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

   393

 */

   394

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

   395

{

   396

	CommandCost cost;

   397

	CommandCost ret;

   398

	RoadBits existing = ROAD_NONE;

   399

	RoadBits all_bits = ROAD_NONE;

   400

	Slope tileh;

   401

   402

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   403

   404

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

   405

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

   406

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

   407

   408

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

   409

   410

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

   411

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

   412

   413

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

   414

   415

	tileh = GetTileSlope(tile, NULL);

   416

   417

	switch (GetTileType(tile)) {

   418

		case MP_ROAD:

   419

			switch (GetRoadTileType(tile)) {

   420

				case ROAD_TILE_NORMAL: {

   421

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

   422

					if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   423

   424

					all_bits = GetAllRoadBits(tile);

   425

					if (!HasBit(GetRoadTypes(tile), rt)) break;

   426

   427

					existing = GetRoadBits(tile, rt);

   428

					RoadBits merged = existing | pieces;

   429

					bool crossing = (merged != ROAD_X && merged != ROAD_Y);

   430

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

   431

						/* Junctions cannot be one-way */

   432

						return_cmd_error(STR_ERR_ONEWAY_ROADS_CAN_T_HAVE_JUNCTION);

   433

					}

   434

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

   435

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

   436

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

   437

							if (crossing) return_cmd_error(STR_ERR_ONEWAY_ROADS_CAN_T_HAVE_JUNCTION);

   438

   439

							/* Ignore half built tiles */

   440

							if (flags & DC_EXEC && rt != ROADTYPE_TRAM && (existing == ROAD_X || existing == ROAD_Y)) {

   441

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

   442

								MarkTileDirtyByTile(tile);

   443

							}

   444

							return CommandCost();

   445

						}

   446

						return_cmd_error(STR_1007_ALREADY_BUILT);

   447

					}

   448

				} break;

   449

   450

				case ROAD_TILE_CROSSING:

   451

					if (HasBit(GetRoadTypes(tile), rt)) return_cmd_error(STR_1007_ALREADY_BUILT);

   452

					all_bits = GetCrossingRoadBits(tile);

   453

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

   454

					break;

   455

   456

				default:

   457

				case ROAD_TILE_DEPOT:

   458

					goto do_clear;

   459

			}

   460

			break;

   461

   462

		case MP_RAILWAY: {

   463

			Axis roaddir;

   464

   465

			if (IsSteepSlope(tileh)) {

   466

				return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   467

			}

   468

   469

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

   470

			if (!HasBit(VALID_LEVEL_CROSSING_SLOPES, tileh)) {

   471

				return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   472

			}

   473

   474

			if (GetRailTileType(tile) != RAIL_TILE_NORMAL) goto do_clear;

   475

			switch (GetTrackBits(tile)) {

   476

				case TRACK_BIT_X:

   477

					if (pieces & ROAD_X) goto do_clear;

   478

					roaddir = AXIS_Y;

   479

					break;

   480

   481

				case TRACK_BIT_Y:

   482

					if (pieces & ROAD_Y) goto do_clear;

   483

					roaddir = AXIS_X;