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

Foundation GetRoadFoundation(Slope tileh, RoadBits bits);

    47

    48

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

    49

{

    50

	RoadBits present;

    51

	RoadBits n;

    52

	*edge_road = true;

    53

    54

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

    55

    56

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

    57

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

    58

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

    59

	if (_current_player == OWNER_WATER ||

    60

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

    61

    62

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

    63

	 * by a town */

    64

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

    65

    66

	if (_cheats.magic_bulldozer.value) return true;

    67

    68

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

    69

	n = ROAD_NONE;

    70

	present = GetAnyRoadBits(tile, rt);

    71

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

    72

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

    73

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

    74

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

    75

    76

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

    77

	 * then allow it */

    78

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

    79

		Town *t;

    80

		*edge_road = false;

    81

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

    82

		if (_patches.extra_dynamite) return true;

    83

    84

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

    85

    86

		SetDParam(0, t->index);

    87

		_error_message = STR_2009_LOCAL_AUTHORITY_REFUSES;

    88

		return false;

    89

	}

    90

    91

	return true;

    92

}

    93

    94

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

    95

{

    96

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

    97

}

    98

    99

/** Delete a piece of road.

   100

 * @param tile tile where to remove road from

   101

 * @param flags operation to perform

   102

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

   103

 *           bit 4..5 road type

   104

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

   105

 *                    yet when removing the road bits when not actually doing

   106

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

   107

 *                    be removed from a level crossing without physically

   108

 *                    removing the tram bits before the test.

   109

 * @param p2 unused

   110

 */

   111

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

   112

{

   113

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

   114

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

   115

   116

	/* true if the roadpiece was always removeable,

   117

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

   118

	bool edge_road;

   119

   120

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

   121

	if (!IsValidRoadType(rt)) return CMD_ERROR;

   122

   123

	Town *t = NULL;

   124

	switch (GetTileType(tile)) {

   125

		case MP_ROAD:

   126

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

   127

			if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   128

			break;

   129

   130

		case MP_STATION:

   131

			if (!IsDriveThroughStopTile(tile)) return CMD_ERROR;

   132

			if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   133

			break;

   134

   135

		case MP_TUNNELBRIDGE:

   136

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

   137

			if (GetVehicleTunnelBridge(tile, GetOtherTunnelBridgeEnd(tile)) != 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(EXPENSES_CONSTRUCTION);

   160

		if (IsTileType(tile, MP_TUNNELBRIDGE)) {

   161

			TileIndex other_end = GetOtherTunnelBridgeEnd(tile);

   162

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

   163

			cost.AddCost((GetTunnelBridgeLength(other_end, tile) + 2) * _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 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

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

   205

			if (flags & DC_EXEC) {

   206

				present ^= c;

   207

				if (present == ROAD_NONE) {

   208

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

   209

					if (rts == ROADTYPES_NONE) {

   210

						/* Includes MarkTileDirtyByTile() */

   211

						DoClearSquare(tile);

   212

					} else {

   213

						SetRoadBits(tile, ROAD_NONE, rt);

   214

						SetRoadTypes(tile, rts);

   215

						MarkTileDirtyByTile(tile);

   216

					}

   217

				} else {

   218

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

   219

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

   220

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

   221

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

   222

					SetRoadBits(tile, present, rt);

   223

					MarkTileDirtyByTile(tile);

   224

				}

   225

			}

   226

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

   227

		}

   228

   229

		case ROAD_TILE_CROSSING: {

   230

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

   231

				return CMD_ERROR;

   232

			}

   233

   234

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

   235

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

   236

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

   237

   238

			if (rt == ROADTYPE_ROAD) {

   239

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

   240

			}

   241

   242

			if (flags & DC_EXEC) {

   243

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

   244

				if (rts == ROADTYPES_NONE) {

   245

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

   246

				} else {

   247

					SetRoadTypes(tile, rts);

   248

				}

   249

				MarkTileDirtyByTile(tile);

   250

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

   251

			}

   252

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

   253

		}

   254

   255

		default:

   256

		case ROAD_TILE_DEPOT:

   257

			return CMD_ERROR;

   258

	}

   259

}

   260

   261

   262

static const RoadBits _valid_tileh_slopes_road[][15] = {

   263

	/* set of normal ones */

   264

	{

   265

		ROAD_ALL,  // SLOPE_FLAT

   266

		ROAD_NONE, // SLOPE_W

   267

		ROAD_NONE, // SLOPE_S

   268

   269

		ROAD_X,    // SLOPE_SW

   270

		ROAD_NONE, // SLOPE_E

   271

		ROAD_NONE, // SLOPE_EW

   272

   273

		ROAD_Y,    // SLOPE_SE

   274

		ROAD_NONE, // SLOPE_WSE

   275

		ROAD_NONE, // SLOPE_N

   276

   277

		ROAD_Y,    // SLOPE_NW

   278

		ROAD_NONE, // SLOPE_NS

   279

		ROAD_NONE, // SLOPE_NE

   280

   281

		ROAD_X,    // SLOPE_ENW

   282

		ROAD_NONE, // SLOPE_SEN

   283

		ROAD_NONE  // SLOPE_ELEVATED

   284

	},

   285

	/* allowed road for an evenly raised platform */

   286

	{

   287

		ROAD_NONE,         // SLOPE_FLAT

   288

		ROAD_SW | ROAD_NW, // SLOPE_W

   289

		ROAD_SW | ROAD_SE, // SLOPE_S

   290

   291

		ROAD_Y  | ROAD_SW, // SLOPE_SW

   292

		ROAD_SE | ROAD_NE, // SLOPE_E

   293

		ROAD_ALL,          // SLOPE_EW

   294

   295

		ROAD_X  | ROAD_SE, // SLOPE_SE

   296

		ROAD_ALL,          // SLOPE_WSE

   297

		ROAD_NW | ROAD_NE, // SLOPE_N

   298

   299

		ROAD_X  | ROAD_NW, // SLOPE_NW

   300

		ROAD_ALL,          // SLOPE_NS

   301

		ROAD_ALL,          // SLOPE_NE

   302

   303

		ROAD_Y  | ROAD_NE, // SLOPE_ENW

   304

		ROAD_ALL,          // SLOPE_SEN

   305

		ROAD_ALL           // SLOPE_ELEVATED

   306

	},

   307

	/* Singe bits on slopes */

   308

	{

   309

		ROAD_ALL,          // SLOPE_FLAT

   310

		ROAD_NE | ROAD_SE, // SLOPE_W

   311

		ROAD_NE | ROAD_NW, // SLOPE_S

   312

   313

		ROAD_NE,           // SLOPE_SW

   314

		ROAD_NW | ROAD_SW, // SLOPE_E

   315

		ROAD_ALL,          // SLOPE_EW

   316

   317

		ROAD_NW,           // SLOPE_SE

   318

		ROAD_ALL,          // SLOPE_WSE

   319

		ROAD_SE | ROAD_SW, // SLOPE_N

   320

   321

		ROAD_SE,           // SLOPE_NW

   322

		ROAD_ALL,          // SLOPE_NS

   323

		ROAD_ALL,          // SLOPE_NE

   324

   325

		ROAD_SW,           // SLOPE_ENW

   326

		ROAD_ALL,          // SLOPE_SEN

   327

		ROAD_ALL,          // SLOPE_ELEVATED

   328

	},

   329

};

   330

   331

/**

   332

 * Calculate the costs for roads on slopes

   333

 *  Aside modify the RoadBits to fit on the slopes

   334

 *

   335

 * @note The RoadBits are modified too!

   336

 * @param tileh The current slope

   337

 * @param pieces The RoadBits we want to add

   338

 * @param existing The existent RoadBits

   339

 * @return The costs for these RoadBits on this slope

   340

 */

   341

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

   342

{

   343

	if (IsSteepSlope(tileh)) {

   344

		/* Force straight roads. */

   345

		*pieces |= MirrorRoadBits(*pieces);

   346

   347

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

   348

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

   349

		}

   350

		return CMD_ERROR;

   351

	}

   352

   353

	RoadBits road_bits = *pieces | existing;

   354

   355

	/* Single bits on slopes.

   356

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

   357

	if (_patches.build_on_slopes && !_is_old_ai_player &&

   358

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

   359

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

   360

		return CommandCost(EXPENSES_CONSTRUCTION, _price.terraform);

   361

	}

   362

   363

	/* no special foundation */

   364

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

   365

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

   366

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

   367

		return CommandCost(); // no extra cost

   368

	}

   369

   370

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

   371

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

   372

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

   373

	}

   374

   375

	/* Force straight roads. */

   376

	*pieces |= MirrorRoadBits(*pieces);

   377

   378

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

   380

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

   381

	}

   382

	return CMD_ERROR;

   383

}

   384

   385

/** Build a piece of road.

   386

 * @param tile tile where to build road

   387

 * @param flags operation to perform

   388

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

   389

 *           bit 4..5 road type

   390

 *           bit 6..7 disallowed directions to toggle

   391

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

   392

 */

   393

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

   394

{

   395

	CommandCost cost(EXPENSES_CONSTRUCTION);

   396

	CommandCost ret;

   397

	RoadBits existing = ROAD_NONE;

   398

	RoadBits all_bits = ROAD_NONE;

   399

	Slope tileh;

   400

   401

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

   402

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

   403

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

   404

   405

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

   406

   407

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

   408

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

   409

   410

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

   411

   412

	tileh = GetTileSlope(tile, NULL);

   413

   414

	switch (GetTileType(tile)) {

   415

		case MP_ROAD:

   416

			switch (GetRoadTileType(tile)) {

   417

				case ROAD_TILE_NORMAL: {

   418

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

   419

					if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   420

   421

					all_bits = GetAllRoadBits(tile);

   422

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

   423

   424

					existing = GetRoadBits(tile, rt);

   425

					RoadBits merged = existing | pieces;

   426

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

   427

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

   428

						/* Junctions cannot be one-way */

   429

						return_cmd_error(STR_ERR_ONEWAY_ROADS_CAN_T_HAVE_JUNCTION);

   430

					}

   431

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

   432

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

   433

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

   434

							if (crossing) return_cmd_error(STR_ERR_ONEWAY_ROADS_CAN_T_HAVE_JUNCTION);

   435

   436

							/* Ignore half built tiles */

   437

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

   438

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

   439

								MarkTileDirtyByTile(tile);

   440

							}

   441

							return CommandCost();

   442

						}

   443

						return_cmd_error(STR_1007_ALREADY_BUILT);

   444

					}

   445

				} break;

   446

   447

				case ROAD_TILE_CROSSING:

   448

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

   449

					all_bits = GetCrossingRoadBits(tile);

   450

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

   451

					break;

   452

   453

				default:

   454

				case ROAD_TILE_DEPOT:

   455

					goto do_clear;

   456

			}

   457

			break;

   458

   459

		case MP_RAILWAY: {

   460

			Axis roaddir;

   461

   462

			if (IsSteepSlope(tileh)) {

   463

				return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   464

			}

   465

   466

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

   467

			if (!HasBit(VALID_LEVEL_CROSSING_SLOPES, tileh)) {

   468

				return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   469

			}

   470

   471

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

   472

			switch (GetTrackBits(tile)) {

   473

				case TRACK_BIT_X:

   474

					if (pieces & ROAD_X) goto do_clear;

   475

					roaddir = AXIS_Y;

   476

					break;

   477

   478

				case TRACK_BIT_Y:

   479

					if (pieces & ROAD_Y) goto do_clear;

   480

					roaddir = AXIS_X;

   481

					break;

   482