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

#include "transparency.h"

    37

    38

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

    39

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

    40

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

    41

#undef M

    42

    43

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

    44

{

    45

	RoadBits present;

    46

	RoadBits n;

    47

	*edge_road = true;

    48

    49

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

    50

    51

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

    52

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

    53

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

    54

	if (_current_player == OWNER_WATER ||

    55

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

    56

    57

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

    58

	 * by a town */

    59

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

    60

    61

	if (_cheats.magic_bulldozer.value) return true;

    62

    63

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

    64

	n = ROAD_NONE;

    65

	present = GetAnyRoadBits(tile, rt);

    66

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

    67

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

    68

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

    69

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

    70

    71

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

    72

	 * then allow it */

    73

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

    74

		Town *t;

    75

		*edge_road = false;

    76

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

    77

		if (_patches.extra_dynamite) return true;

    78

    79

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

    80

    81

		SetDParam(0, t->index);

    82

		_error_message = STR_2009_LOCAL_AUTHORITY_REFUSES;

    83

		return false;

    84

	}

    85

    86

	return true;

    87

}

    88

    89

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

    90

{

    91

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

    92

}

    93

    94

/** Delete a piece of road.

    95

 * @param tile tile where to remove road from

    96

 * @param flags operation to perform

    97

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

    98

 *           bit 4..5 road type

    99

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

   100

 *                    yet when removing the road bits when not actually doing

   101

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

   102

 *                    be removed from a level crossing without physically

   103

 *                    removing the tram bits before the test.

   104

 * @param p2 unused

   105

 */

   106

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

   107

{

   108

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

   109

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

   110

   111

	/* true if the roadpiece was always removeable,

   112

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

   113

	bool edge_road;

   114

   115

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   116

   117

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

   118

	if (!IsValidRoadType(rt)) return CMD_ERROR;

   119

   120

	Town *t = NULL;

   121

	switch (GetTileType(tile)) {

   122

		case MP_ROAD:

   123

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

   124

			break;

   125

   126

		case MP_STATION:

   127

			if (!IsDriveThroughStopTile(tile)) return CMD_ERROR;

   128

			break;

   129

   130

		case MP_TUNNELBRIDGE:

   131

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

   132

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

   133

			break;

   134

   135

		default:

   136

			return CMD_ERROR;

   137

	}

   138

   139

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

   140

	RoadTypes rts = GetRoadTypes(tile);

   141

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

   142

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

   143

   144

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

   145

   146

	if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   147

   148

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

   149

	 * removal allowance depends on difficulty setting */

   150

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

   151

   152

	if (!IsTileType(tile, MP_ROAD)) {

   153

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

   154

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

   155

   156

		CommandCost cost;

   157

		if (IsTileType(tile, MP_TUNNELBRIDGE)) {

   158

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

   159

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

   160

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

   161

			if (flags & DC_EXEC) {

   162

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

   163

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

   164

   165

				/* Mark tiles diry that have been repaved */

   166

				MarkTileDirtyByTile(tile);

   167

				MarkTileDirtyByTile(other_end);

   168

				if (IsBridge(tile)) {

   169

					TileIndexDiff delta = TileOffsByDiagDir(GetBridgeRampDirection(tile));

   170

   171

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

   172

				}

   173

			}

   174

		} else {

   175

			cost.AddCost(_price.remove_road);

   176

			if (flags & DC_EXEC) {

   177

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

   178

				MarkTileDirtyByTile(tile);

   179

			}

   180

		}

   181

		return CommandCost(cost);

   182

	}

   183

   184

	switch (GetRoadTileType(tile)) {

   185

		case ROAD_TILE_NORMAL: {

   186

			RoadBits present = GetRoadBits(tile, rt);

   187

			RoadBits c = pieces;

   188

   189

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

   190

   191

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

   192

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

   193

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

   194

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

   195

			}

   196

   197

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

   198

			c &= present;

   199

			if (c == ROAD_NONE) return CMD_ERROR;

   200

   201

			if (flags & DC_EXEC) {

   202

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

   203

   204

				present ^= c;

   205

				if (present == ROAD_NONE) {

   206

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

   207

					if (rts == ROADTYPES_NONE) {

   208

						/* Includes MarkTileDirtyByTile() */

   209

						DoClearSquare(tile);

   210

					} else {

   211

						SetRoadBits(tile, ROAD_NONE, rt);

   212

						SetRoadTypes(tile, rts);

   213

						MarkTileDirtyByTile(tile);

   214

					}

   215

				} else {

   216

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

   217

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

   218

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

   219

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

   220

					SetRoadBits(tile, present, rt);

   221

					MarkTileDirtyByTile(tile);

   222

				}

   223

			}

   224

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

   225

		}

   226

   227

		case ROAD_TILE_CROSSING: {

   228

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

   229

				return CMD_ERROR;

   230

			}

   231

   232

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

   233

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

   234

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

   235

   236

			if (flags & DC_EXEC) {

   237

				if (rt == ROADTYPE_ROAD) {

   238

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

   239

				}

   240

   241

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

   242

				if (rts == ROADTYPES_NONE) {

   243

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

   244

				} else {

   245

					SetRoadTypes(tile, rts);

   246

				}

   247

				MarkTileDirtyByTile(tile);

   248

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

   249

			}

   250

			return CommandCost(_price.remove_road * 2);

   251

		}

   252

   253

		default:

   254

		case ROAD_TILE_DEPOT:

   255

			return CMD_ERROR;

   256

	}

   257

}

   258

   259

   260

static const RoadBits _valid_tileh_slopes_road[][15] = {

   261

	/* set of normal ones */

   262

	{

   263

		ROAD_ALL,  // SLOPE_FLAT

   264

		ROAD_NONE, // SLOPE_W

   265

		ROAD_NONE, // SLOPE_S

   266

   267

		ROAD_X,    // SLOPE_SW

   268

		ROAD_NONE, // SLOPE_E

   269

		ROAD_NONE, // SLOPE_EW

   270

   271

		ROAD_Y,    // SLOPE_SE

   272

		ROAD_NONE, // SLOPE_WSE

   273

		ROAD_NONE, // SLOPE_N

   274

   275

		ROAD_Y,    // SLOPE_NW

   276

		ROAD_NONE, // SLOPE_NS

   277

		ROAD_NONE, // SLOPE_NE

   278

   279

		ROAD_X,    // SLOPE_ENW

   280

		ROAD_NONE, // SLOPE_SEN

   281

		ROAD_NONE  // SLOPE_ELEVATED

   282

	},

   283

	/* allowed road for an evenly raised platform */

   284

	{

   285

		ROAD_NONE,         // SLOPE_FLAT

   286

		ROAD_SW | ROAD_NW, // SLOPE_W

   287

		ROAD_SW | ROAD_SE, // SLOPE_S

   288

   289

		ROAD_Y  | ROAD_SW, // SLOPE_SW

   290

		ROAD_SE | ROAD_NE, // SLOPE_E

   291

		ROAD_ALL,          // SLOPE_EW

   292

   293

		ROAD_X  | ROAD_SE, // SLOPE_SE

   294

		ROAD_ALL,          // SLOPE_WSE

   295

		ROAD_NW | ROAD_NE, // SLOPE_N

   296

   297

		ROAD_X  | ROAD_NW, // SLOPE_NW

   298

		ROAD_ALL,          // SLOPE_NS

   299

		ROAD_ALL,          // SLOPE_NE

   300

   301

		ROAD_Y  | ROAD_NE, // SLOPE_ENW

   302

		ROAD_ALL,          // SLOPE_SEN

   303

		ROAD_ALL           // SLOPE_ELEVATED

   304

	},

   305

	/* Singe bits on slopes */

   306

	{

   307

		ROAD_ALL,          // SLOPE_FLAT

   308

		ROAD_NE | ROAD_SE, // SLOPE_W

   309

		ROAD_NE | ROAD_NW, // SLOPE_S

   310

   311

		ROAD_NE,           // SLOPE_SW

   312

		ROAD_NW | ROAD_SW, // SLOPE_E

   313

		ROAD_ALL,          // SLOPE_EW

   314

   315

		ROAD_NW,           // SLOPE_SE

   316

		ROAD_ALL,          // SLOPE_WSE

   317

		ROAD_SE | ROAD_SW, // SLOPE_N

   318

   319

		ROAD_SE,           // SLOPE_NW

   320

		ROAD_ALL,          // SLOPE_NS

   321

		ROAD_ALL,          // SLOPE_NE

   322

   323

		ROAD_SW,           // SLOPE_ENW

   324

		ROAD_ALL,          // SLOPE_SEN

   325

		ROAD_ALL,          // SLOPE_ELEVATED

   326

	},

   327

};

   328

   329

/**

   330

 * Calculate the costs for roads on slopes

   331

 *  Aside modify the RoadBits to fit on the slopes

   332

 *

   333

 * @note The RoadBits are modified too!

   334

 * @param tileh The current slope

   335

 * @param pieces The RoadBits we want to add

   336

 * @param existing The existent RoadBits

   337

 * @return The costs for these RoadBits on this slope

   338

 */

   339

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

   340

{

   341

	if (IsSteepSlope(tileh)) {

   342

		/* Force straight roads. */

   343

		*pieces |= MirrorRoadBits(*pieces);

   344

   345

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

   346

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

   347

		}

   348

		return CMD_ERROR;

   349

	}

   350

   351

	RoadBits road_bits = *pieces | existing;

   352

   353

	/* Single bits on slopes.

   354

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

   355

	if (_patches.build_on_slopes && !_is_old_ai_player &&

   356

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

   357

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

   358

		return CommandCost(_price.terraform);

   359

	}

   360

   361

	/* no special foundation */

   362

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

   363

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

   364

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

   365

		return CommandCost(); // no extra cost

   366

	}

   367

   368

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

   369

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

   370

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

   371

	}

   372

   373

	/* Force straight roads. */

   374

	*pieces |= MirrorRoadBits(*pieces);

   375

   376

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

   377

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

   378

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

   379

	}

   380

	return CMD_ERROR;

   381

}

   382

   383

/** Build a piece of road.

   384

 * @param tile tile where to build road

   385

 * @param flags operation to perform

   386

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

   387

 *           bit 4..5 road type

   388

 *           bit 6..7 disallowed directions to toggle

   389

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

   390

 */

   391

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

   392

{

   393

	CommandCost cost;

   394

	CommandCost ret;

   395

	RoadBits existing = ROAD_NONE;

   396

	RoadBits all_bits = ROAD_NONE;

   397

	Slope tileh;

   398

   399

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   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

   483

				default: goto do_clear;

   484

			}