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 "sprite.h"

    13

#include "table/sprites.h"

    14

#include "table/strings.h"

    15

#include "strings.h"

    16

#include "functions.h"

    17

#include "window.h"

    18

#include "map.h"

    19

#include "landscape.h"

    20

#include "tile.h"

    21

#include "town_map.h"

    22

#include "vehicle.h"

    23

#include "viewport.h"

    24

#include "command.h"

    25

#include "player.h"

    26

#include "town.h"

    27

#include "gfx.h"

    28

#include "sound.h"

    29

#include "yapf/yapf.h"

    30

#include "depot.h"

    31

#include "newgrf.h"

    32

#include "station_map.h"

    33

#include "tunnel_map.h"

    34

#include "misc/autoptr.hpp"

    35

#include "autoslope.h"

    36

    37

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

    38

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

    39

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

    40

#undef M

    41

    42

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

    43

{

    44

	RoadBits present;

    45

	RoadBits n;

    46

	*edge_road = true;

    47

    48

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

    49

    50

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

    51

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

    52

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

    53

	if (_current_player == OWNER_WATER ||

    54

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

    55

    56

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

    57

	 * by a town */

    58

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

    59

    60

	if (_cheats.magic_bulldozer.value) return true;

    61

    62

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

    63

	n = ROAD_NONE;

    64

	present = GetAnyRoadBits(tile, rt);

    65

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

    66

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

    67

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

    68

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

    69

    70

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

    71

	 * then allow it */

    72

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

    73

		Town *t;

    74

		*edge_road = false;

    75

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

    76

		if (_patches.extra_dynamite) return true;

    77

    78

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

    79

    80

		SetDParam(0, t->index);

    81

		_error_message = STR_2009_LOCAL_AUTHORITY_REFUSES;

    82

		return false;

    83

	}

    84

    85

	return true;

    86

}

    87

    88

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

    89

{

    90

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

    91

}

    92

    93

/** Delete a piece of road.

    94

 * @param tile tile where to remove road from

    95

 * @param flags operation to perform

    96

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

    97

 *           bit 4..5 road type

    98

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

    99

 *                    yet when removing the road bits when not actually doing

   100

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

   101

 *                    be removed from a level crossing without physically

   102

 *                    removing the tram bits before the test.

   103

 * @param p2 unused

   104

 */

   105

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

   106

{

   107

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

   108

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

   109

   110

	/* true if the roadpiece was always removeable,

   111

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

   112

	bool edge_road;

   113

   114

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   115

   116

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

   117

	if (!IsValidRoadType(rt)) return CMD_ERROR;

   118

   119

	Town *t = NULL;

   120

	switch (GetTileType(tile)) {

   121

		case MP_ROAD:

   122

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

   123

			break;

   124

   125

		case MP_STATION:

   126

			if (!IsDriveThroughStopTile(tile)) return CMD_ERROR;

   127

			break;

   128

   129

		case MP_TUNNELBRIDGE:

   130

			if ((IsTunnel(tile) && GetTunnelTransportType(tile) != TRANSPORT_ROAD) ||

   131

					(IsBridge(tile) && GetBridgeTransportType(tile) != TRANSPORT_ROAD)) return CMD_ERROR;

   132

			break;

   133

   134

		default:

   135

			return CMD_ERROR;

   136

	}

   137

   138

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

   139

	RoadTypes rts = GetRoadTypes(tile);

   140

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

   141

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

   142

   143

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

   144

   145

	if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   146

   147

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

   148

	 * removal allowance depends on difficulty setting */

   149

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

   150

   151

	if (!IsTileType(tile, MP_ROAD)) {

   152

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

   153

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

   154

   155

		CommandCost cost;

   156

		if (IsTileType(tile, MP_TUNNELBRIDGE)) {

   157

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

   158

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

   159

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

   160

			if (flags & DC_EXEC) {

   161

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

   162

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

   163

   164

				/* Mark tiles diry that have been repaved */

   165

				MarkTileDirtyByTile(tile);

   166

				MarkTileDirtyByTile(other_end);

   167

				if (IsBridge(tile)) {

   168

					TileIndexDiff delta = TileOffsByDiagDir(GetBridgeRampDirection(tile));

   169

   170

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

   171

				}

   172

			}

   173

		} else {

   174

			cost.AddCost(_price.remove_road);

   175

			if (flags & DC_EXEC) {

   176

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

   177

				MarkTileDirtyByTile(tile);

   178

			}

   179

		}

   180

		return CommandCost(cost);

   181

	}

   182

   183

	switch (GetRoadTileType(tile)) {

   184

		case ROAD_TILE_NORMAL: {

   185

			RoadBits present = GetRoadBits(tile, rt);

   186

			RoadBits c = pieces;

   187

   188

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

   189

   190

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

   191

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

   192

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

   193

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

   194

			}

   195

   196

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

   197

			c &= present;

   198

			if (c == ROAD_NONE) return CMD_ERROR;

   199

   200

			if (flags & DC_EXEC) {

   201

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

   202

   203

				present ^= c;

   204

				if (present == ROAD_NONE) {

   205

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

   206

					if (rts == ROADTYPES_NONE) {

   207

						/* Includes MarkTileDirtyByTile() */

   208

						DoClearSquare(tile);

   209

					} else {

   210

						SetRoadBits(tile, ROAD_NONE, rt);

   211

						SetRoadTypes(tile, rts);

   212

						MarkTileDirtyByTile(tile);

   213

					}

   214

				} else {

   215

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

   216

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

   217

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

   218

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

   219

					SetRoadBits(tile, present, rt);

   220

					MarkTileDirtyByTile(tile);

   221

				}

   222

			}

   223

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

   224

		}

   225

   226

		case ROAD_TILE_CROSSING: {

   227

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

   228

				return CMD_ERROR;

   229

			}

   230

   231

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

   232

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

   233

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

   234

   235

			if (flags & DC_EXEC) {

   236

				if (rt == ROADTYPE_ROAD) {

   237

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

   238

				}

   239

   240

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

   241

				if (rts == ROADTYPES_NONE) {

   242

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

   243

				} else {

   244

					SetRoadTypes(tile, rts);

   245

				}

   246

				MarkTileDirtyByTile(tile);

   247

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

   248

			}

   249

			return CommandCost(_price.remove_road * 2);

   250

		}

   251

   252

		default:

   253

		case ROAD_TILE_DEPOT:

   254

			return CMD_ERROR;

   255

	}

   256

}

   257

   258

   259

static const RoadBits _valid_tileh_slopes_road[][15] = {

   260

	/* set of normal ones */

   261

	{

   262

		ROAD_ALL,  // SLOPE_FLAT

   263

		ROAD_NONE, // SLOPE_W

   264

		ROAD_NONE, // SLOPE_S

   265

   266

		ROAD_X,    // SLOPE_SW

   267

		ROAD_NONE, // SLOPE_E

   268

		ROAD_NONE, // SLOPE_EW

   269

   270

		ROAD_Y,    // SLOPE_SE

   271

		ROAD_NONE, // SLOPE_WSE

   272

		ROAD_NONE, // SLOPE_N

   273

   274

		ROAD_Y,    // SLOPE_NW

   275

		ROAD_NONE, // SLOPE_NS

   276

		ROAD_NONE, // SLOPE_NE

   277

   278

		ROAD_X,    // SLOPE_ENW

   279

		ROAD_NONE, // SLOPE_SEN

   280

		ROAD_NONE  // SLOPE_ELEVATED

   281

	},

   282

	/* allowed road for an evenly raised platform */

   283

	{

   284

		ROAD_NONE,         // SLOPE_FLAT

   285

		ROAD_SW | ROAD_NW, // SLOPE_W

   286

		ROAD_SW | ROAD_SE, // SLOPE_S

   287

   288

		ROAD_Y  | ROAD_SW, // SLOPE_SW

   289

		ROAD_SE | ROAD_NE, // SLOPE_E

   290

		ROAD_ALL,          // SLOPE_EW

   291

   292

		ROAD_X  | ROAD_SE, // SLOPE_SE

   293

		ROAD_ALL,          // SLOPE_WSE

   294

		ROAD_NW | ROAD_NE, // SLOPE_N

   295

   296

		ROAD_X  | ROAD_NW, // SLOPE_NW

   297

		ROAD_ALL,          // SLOPE_NS

   298

		ROAD_ALL,          // SLOPE_NE

   299

   300

		ROAD_Y  | ROAD_NE, // SLOPE_ENW

   301

		ROAD_ALL,          // SLOPE_SEN

   302

		ROAD_ALL           // SLOPE_ELEVATED

   303

	},

   304

	/* Singe bits on slopes */

   305

	{

   306

		ROAD_ALL,          // SLOPE_FLAT

   307

		ROAD_NE | ROAD_SE, // SLOPE_W

   308

		ROAD_NE | ROAD_NW, // SLOPE_S

   309

   310

		ROAD_NE,           // SLOPE_SW

   311

		ROAD_NW | ROAD_SW, // SLOPE_E

   312

		ROAD_ALL,          // SLOPE_EW

   313

   314

		ROAD_NW,           // SLOPE_SE

   315

		ROAD_ALL,          // SLOPE_WSE

   316

		ROAD_SE | ROAD_SW, // SLOPE_N

   317

   318

		ROAD_SE,           // SLOPE_NW

   319

		ROAD_ALL,          // SLOPE_NS

   320

		ROAD_ALL,          // SLOPE_NE

   321

   322

		ROAD_SW,           // SLOPE_ENW

   323

		ROAD_ALL,          // SLOPE_SEN

   324

		ROAD_ALL,          // SLOPE_ELEVATED

   325

	},

   326

};

   327

   328

/**

   329

 * Calculate the costs for roads on slopes

   330

 *  Aside modify the RoadBits to fit on the slopes

   331

 *

   332

 * @note The RoadBits are modified too!

   333

 * @param tileh The current slope

   334

 * @param pieces The RoadBits we want to add

   335

 * @param existing The existent RoadBits

   336

 * @return The costs for these RoadBits on this slope

   337

 */

   338

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

   339

{

   340

	if (IsSteepSlope(tileh)) {

   341

		/* Force straight roads. */

   342

		*pieces |= MirrorRoadBits(*pieces);

   343

   344

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

   345

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

   346

		}

   347

		return CMD_ERROR;

   348

	}

   349

   350

	RoadBits road_bits = *pieces | existing;

   351

   352

	/* Single bits on slopes.

   353

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

   354

	if (_patches.build_on_slopes && !_is_old_ai_player &&

   355

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

   356

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

   357

		return CommandCost(_price.terraform);

   358

	}

   359

   360

	/* no special foundation */

   361

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

   362

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

   363

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

   364

		return CommandCost(); // no extra cost

   365

	}

   366

   367

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

   368

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

   370

	}

   371

   372

	/* Force straight roads. */

   373

	*pieces |= MirrorRoadBits(*pieces);

   374

   375

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

   376

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

   377

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

   378

	}

   379

	return CMD_ERROR;

   380

}

   381

   382

/** Build a piece of road.

   383

 * @param tile tile where to build road

   384

 * @param flags operation to perform

   385

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

   386

 *           bit 4..5 road type

   387

 *           bit 6..7 disallowed directions to toggle

   388

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

   389

 */

   390

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

   391

{

   392

	CommandCost cost;

   393

	CommandCost ret;

   394

	RoadBits existing = ROAD_NONE;

   395

	RoadBits all_bits = ROAD_NONE;

   396

	Slope tileh;

   397

   398

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

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

   483

			}

   484