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

    37

#include "table/sprites.h"

    38

#include "table/strings.h"

    39

    40

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

    41

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

    42

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

    43

#undef M

    44

    45

Foundation GetRoadFoundation(Slope tileh, RoadBits bits);

    46

    47

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

    48

{

    49

	RoadBits present;

    50

	RoadBits n;

    51

	*edge_road = true;

    52

    53

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

    54

    55

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

    56

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

    57

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

    58

	if (_current_player == OWNER_WATER ||

    59

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

    60

    61

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

    62

	 * by a town */

    63

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

    64

    65

	if (_cheats.magic_bulldozer.value) return true;

    66

    67

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

    68

	n = ROAD_NONE;

    69

	present = GetAnyRoadBits(tile, rt);

    70

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

    71

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

    72

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

    73

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

    74

    75

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

    76

	 * then allow it */

    77

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

    78

		Town *t;

    79

		*edge_road = false;

    80

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

    81

		if (_patches.extra_dynamite) return true;

    82

    83

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

    84

    85

		SetDParam(0, t->index);

    86

		_error_message = STR_2009_LOCAL_AUTHORITY_REFUSES;

    87

		return false;

    88

	}

    89

    90

	return true;

    91

}

    92

    93

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

    94

{

    95

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

    96

}

    97

    98

/** Delete a piece of road.

    99

 * @param tile tile where to remove road from

   100

 * @param flags operation to perform

   101

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

   102

 *           bit 4..5 road type

   103

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

   104

 *                    yet when removing the road bits when not actually doing

   105

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

   106

 *                    be removed from a level crossing without physically

   107

 *                    removing the tram bits before the test.

   108

 * @param p2 unused

   109

 */

   110

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

   111

{

   112

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

   113

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

   114

   115

	/* true if the roadpiece was always removeable,

   116

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

   117

	bool edge_road;

   118

   119

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

   120

	if (!IsValidRoadType(rt)) return CMD_ERROR;

   121

   122

	Town *t = NULL;

   123

	switch (GetTileType(tile)) {

   124

		case MP_ROAD:

   125

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

   126

			if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   127

			break;

   128

   129

		case MP_STATION:

   130

			if (!IsDriveThroughStopTile(tile)) return CMD_ERROR;

   131

			if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   132

			break;

   133

   134

		case MP_TUNNELBRIDGE:

   138

   139

		default:

   140

			return CMD_ERROR;

   141

	}

   142

   143

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

   144

	RoadTypes rts = GetRoadTypes(tile);

   145

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

   146

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

   147

   148

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

   149

   150

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

   151

	 * removal allowance depends on difficulty setting */

   152

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

   153

   154

	if (!IsTileType(tile, MP_ROAD)) {

   155

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

   156

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

   157

   158

		CommandCost cost(EXPENSES_CONSTRUCTION);

   159

		if (IsTileType(tile, MP_TUNNELBRIDGE)) {

   160

			TileIndex other_end = GetOtherTunnelBridgeEnd(tile);

   161

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

   162

			cost.AddCost((DistanceManhattan(other_end, tile) + 1) * _price.remove_road);

   163

			if (flags & DC_EXEC) {

   164

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

   165

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

   166

   167

				/* Mark tiles diry that have been repaved */

   168

				MarkTileDirtyByTile(tile);

   169

				MarkTileDirtyByTile(other_end);

   170

				if (IsBridge(tile)) {

   171

					TileIndexDiff delta = TileOffsByDiagDir(GetTunnelBridgeDirection(tile));

   172

   173

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

   174

				}

   175

			}

   176

		} else {

   177

			cost.AddCost(_price.remove_road);

   178

			if (flags & DC_EXEC) {

   179

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

   180

				MarkTileDirtyByTile(tile);

   181

			}

   182

		}

   183

		return cost;

   184

	}

   185

   186

	switch (GetRoadTileType(tile)) {

   187

		case ROAD_TILE_NORMAL: {

   188

			RoadBits present = GetRoadBits(tile, rt);

   189

			RoadBits c = pieces;

   190

   191

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

   192

   193

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

   194

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

   195

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

   196

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

   197

			}

   198

   199

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

   200

			c &= present;

   201

			if (c == ROAD_NONE) return CMD_ERROR;

   202

   203

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

   204

			if (flags & DC_EXEC) {

   205

				present ^= c;

   206

				if (present == ROAD_NONE) {

   207

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

   208

					if (rts == ROADTYPES_NONE) {

   209

						/* Includes MarkTileDirtyByTile() */

   210

						DoClearSquare(tile);

   211

					} else {

   212

						SetRoadBits(tile, ROAD_NONE, rt);

   213

						SetRoadTypes(tile, rts);

   214

						MarkTileDirtyByTile(tile);

   215

					}

   216

				} else {

   217

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

   218

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

   219

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

   220

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

   221

					SetRoadBits(tile, present, rt);

   222

					MarkTileDirtyByTile(tile);

   223

				}

   224

			}

   225

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

   226

		}

   227

   228

		case ROAD_TILE_CROSSING: {

   229

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

   230

				return CMD_ERROR;

   231

			}

   232

   233

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

   234

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

   235

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

   236

   237

			if (rt == ROADTYPE_ROAD) {

   238

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

   239

			}

   240

   241

			if (flags & DC_EXEC) {

   242

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

   243

				if (rts == ROADTYPES_NONE) {

   244

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

   245

				} else {

   246

					SetRoadTypes(tile, rts);

   247

				}

   248

				MarkTileDirtyByTile(tile);

   249

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

   250

			}

   251

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

   252

		}

   253

   254

		default:

   255

		case ROAD_TILE_DEPOT:

   256

			return CMD_ERROR;

   257

	}

   258

}

   259

   260

   261

static const RoadBits _valid_tileh_slopes_road[][15] = {

   262

	/* set of normal ones */

   263

	{

   264

		ROAD_ALL,  // SLOPE_FLAT

   265

		ROAD_NONE, // SLOPE_W

   266

		ROAD_NONE, // SLOPE_S

   267

   268

		ROAD_X,    // SLOPE_SW

   269

		ROAD_NONE, // SLOPE_E

   270

		ROAD_NONE, // SLOPE_EW

   271

   272

		ROAD_Y,    // SLOPE_SE

   273

		ROAD_NONE, // SLOPE_WSE

   274

		ROAD_NONE, // SLOPE_N

   275

   276

		ROAD_Y,    // SLOPE_NW

   277

		ROAD_NONE, // SLOPE_NS

   278

		ROAD_NONE, // SLOPE_NE

   279

   280

		ROAD_X,    // SLOPE_ENW

   281

		ROAD_NONE, // SLOPE_SEN

   282

		ROAD_NONE  // SLOPE_ELEVATED

   283

	},

   284

	/* allowed road for an evenly raised platform */

   285

	{

   286

		ROAD_NONE,         // SLOPE_FLAT

   287

		ROAD_SW | ROAD_NW, // SLOPE_W

   288

		ROAD_SW | ROAD_SE, // SLOPE_S

   289

   290

		ROAD_Y  | ROAD_SW, // SLOPE_SW

   291

		ROAD_SE | ROAD_NE, // SLOPE_E

   292

		ROAD_ALL,          // SLOPE_EW

   293

   294

		ROAD_X  | ROAD_SE, // SLOPE_SE

   295

		ROAD_ALL,          // SLOPE_WSE

   296

		ROAD_NW | ROAD_NE, // SLOPE_N

   297

   298

		ROAD_X  | ROAD_NW, // SLOPE_NW

   299

		ROAD_ALL,          // SLOPE_NS

   300

		ROAD_ALL,          // SLOPE_NE

   301

   302

		ROAD_Y  | ROAD_NE, // SLOPE_ENW

   303

		ROAD_ALL,          // SLOPE_SEN

   304

		ROAD_ALL           // SLOPE_ELEVATED

   305

	},

   306

	/* Singe bits on slopes */

   307

	{

   308

		ROAD_ALL,          // SLOPE_FLAT

   309

		ROAD_NE | ROAD_SE, // SLOPE_W

   310

		ROAD_NE | ROAD_NW, // SLOPE_S

   311

   312

		ROAD_NE,           // SLOPE_SW

   313

		ROAD_NW | ROAD_SW, // SLOPE_E

   314

		ROAD_ALL,          // SLOPE_EW

   315

   316

		ROAD_NW,           // SLOPE_SE

   317

		ROAD_ALL,          // SLOPE_WSE

   318

		ROAD_SE | ROAD_SW, // SLOPE_N

   319

   320

		ROAD_SE,           // SLOPE_NW

   321

		ROAD_ALL,          // SLOPE_NS

   322

		ROAD_ALL,          // SLOPE_NE

   323

   324

		ROAD_SW,           // SLOPE_ENW

   325

		ROAD_ALL,          // SLOPE_SEN

   326

		ROAD_ALL,          // SLOPE_ELEVATED

   327

	},

   328

};

   329

   330

/**

   331

 * Calculate the costs for roads on slopes

   332

 *  Aside modify the RoadBits to fit on the slopes

   333

 *

   334

 * @note The RoadBits are modified too!

   335

 * @param tileh The current slope

   336

 * @param pieces The RoadBits we want to add

   337

 * @param existing The existent RoadBits

   338

 * @return The costs for these RoadBits on this slope

   339

 */

   340

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

   341

{

   342

	if (IsSteepSlope(tileh)) {

   343

		/* Force straight roads. */

   344

		*pieces |= MirrorRoadBits(*pieces);

   345

   346

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

   347

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

   348

		}

   349

		return CMD_ERROR;

   350

	}

   351

   352

	RoadBits road_bits = *pieces | existing;

   353

   354

	/* Single bits on slopes.

   355

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

   356

	if (_patches.build_on_slopes && !_is_old_ai_player &&

   357

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

   358

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

   359

		return CommandCost(EXPENSES_CONSTRUCTION, _price.terraform);

   360

	}

   361

   362

	/* no special foundation */

   363

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

   364

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

   365

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

   366

		return CommandCost(); // no extra cost

   367

	}

   368

   369

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

   370

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

   371

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

   372

	}

   373

   374

	/* Force straight roads. */

   375

	*pieces |= MirrorRoadBits(*pieces);

   376

   377

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

   378

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

   379

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

   380

	}

   381

	return CMD_ERROR;

   382

}

   383

   384

/** Build a piece of road.

   385

 * @param tile tile where to build road

   386

 * @param flags operation to perform

   387

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

   388

 *           bit 4..5 road type

   389

 *           bit 6..7 disallowed directions to toggle

   390

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

   391

 */

   392

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

   393

{

   394

	CommandCost cost(EXPENSES_CONSTRUCTION);

   395

	CommandCost ret;

   396

	RoadBits existing = ROAD_NONE;

   397

	RoadBits all_bits = ROAD_NONE;

   398

	Slope tileh;

   399

   400

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

   401

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

   402

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

   403

   404

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

   405

   406

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

   407

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

   408

   409

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

   410

   411

	tileh = GetTileSlope(tile, NULL);

   412

   413

	switch (GetTileType(tile)) {

   414

		case MP_ROAD:

   415

			switch (GetRoadTileType(tile)) {

   416

				case ROAD_TILE_NORMAL: {

   417

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

   418

					if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   419

   420

					all_bits = GetAllRoadBits(tile);

   421

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

   422

   423

					existing = GetRoadBits(tile, rt);

   424

					RoadBits merged = existing | pieces;

   425

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

   426

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

   427

						/* Junctions cannot be one-way */

   428

						return_cmd_error(STR_ERR_ONEWAY_ROADS_CAN_T_HAVE_JUNCTION);

   429

					}

   430

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

   431

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

   432

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

   433

							if (crossing) return_cmd_error(STR_ERR_ONEWAY_ROADS_CAN_T_HAVE_JUNCTION);

   434

   435

							/* Ignore half built tiles */

   436

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

   437

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

   438

								MarkTileDirtyByTile(tile);

   439

							}

   440

							return CommandCost();

   441

						}

   442

						return_cmd_error(STR_1007_ALREADY_BUILT);

   443

					}

   444

				} break;

   445

   446

				case ROAD_TILE_CROSSING:

   447

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

   448

					all_bits = GetCrossingRoadBits(tile);

   449

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

   450

					break;

   451

   452

				default:

   453

				case ROAD_TILE_DEPOT:

   454

					goto do_clear;

   455

			}

   456

			break;

   457

   458

		case MP_RAILWAY: {

   459

			Axis roaddir;

   460

   461

			if (IsSteepSlope(tileh)) {

   462

				return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   463

			}

   464

   465

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

   466

			if (!HasBit(VALID_LEVEL_CROSSING_SLOPES, tileh)) {

   467

				return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   468

			}

   469

   470

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

   471

			switch (GetTrackBits(tile)) {

   472

				case TRACK_BIT_X:

   473

					if (pieces & ROAD_X) goto do_clear;

   474

					roaddir = AXIS_Y;

   475

					break;

   476

   477

				case TRACK_BIT_Y:

   478

					if (pieces & ROAD_Y) goto do_clear;

   479

					roaddir = AXIS_X;

   480

					break;

   481

   482

				default: goto do_clear;