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

    16

#include "map.h"

    17

#include "landscape.h"

    18

#include "tile.h"

    19

#include "town_map.h"

    20

#include "vehicle.h"

    21

#include "viewport.h"

    22

#include "command.h"

    23

#include "player.h"

    24

#include "town.h"

    25

#include "gfx.h"

    26

#include "sound.h"

    27

#include "yapf/yapf.h"

    28

#include "depot.h"

    29

#include "newgrf.h"

    30

    31

    32

static uint CountRoadBits(RoadBits r)

    33

{

    34

	uint count = 0;

    35

    36

	if (r & ROAD_NW) ++count;

    37

	if (r & ROAD_SW) ++count;

    38

	if (r & ROAD_SE) ++count;

    39

	if (r & ROAD_NE) ++count;

    40

	return count;

    41

}

    42

    43

    44

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

    45

{

    46

	RoadBits present;

    47

	RoadBits n;

    48

	*edge_road = true;

    49

    50

	if (_game_mode == GM_EDITOR) return true;

    51

    52

	/* Only do the special processing for actual players. */

    53

	if (!IsValidPlayer(_current_player)) return true;

    54

    55

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

    56

	 * by a town */

    57

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

    58

    59

	if (_cheats.magic_bulldozer.value) return true;

    60

    61

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

    62

	n = ROAD_NONE;

    63

	present = GetAnyRoadBits(tile);

    64

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

    65

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

    66

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

    67

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

    68

    69

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

    70

	 * then allow it */

    71

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

    72

		Town *t;

    73

		*edge_road = false;

    74

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

    75

		if (_patches.extra_dynamite) return true;

    76

    77

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

    78

    79

		SetDParam(0, t->index);

    80

		_error_message = STR_2009_LOCAL_AUTHORITY_REFUSES;

    81

		return false;

    82

	}

    83

    84

	return true;

    85

}

    86

    87

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

    88

{

    89

	return CheckAllowRemoveRoad(tile, remove, IsLevelCrossingTile(tile) ? GetCrossingRoadOwner(tile) : GetTileOwner(tile), edge_road);

    90

}

    91

    92

/** Delete a piece of road.

    93

 * @param tile tile where to remove road from

    94

 * @param flags operation to perform

    95

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

    96

 * @param p2 unused

    97

 */

    98

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

    99

{

   100

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

   101

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

   102

   103

	Owner owner;

   104

	Town *t;

   105

	/* true if the roadpiece was always removeable,

   106

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

   107

	bool edge_road;

   108

   109

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   110

   111

	if (!IsTileType(tile, MP_STREET)) return CMD_ERROR;

   112

   113

	owner = IsLevelCrossingTile(tile) ? GetCrossingRoadOwner(tile) : GetTileOwner(tile);

   114

   115

	if (owner == OWNER_TOWN && _game_mode != GM_EDITOR) {

   116

		t = GetTownByTile(tile);

   117

	} else {

   118

		t = NULL;

   119

	}

   120

   121

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

   122

   123

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

   124

   125

	if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   126

   127

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

   128

	 * removal allowance depends on difficulty setting */

   129

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

   130

   131

	switch (GetRoadTileType(tile)) {

   132

		case ROAD_TILE_NORMAL: {

   133

			RoadBits present = GetRoadBits(tile);

   134

			RoadBits c = pieces;

   135

   136

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

   137

   138

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

   139

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

   140

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

   141

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

   142

			}

   143

   144

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

   145

			c &= present;

   146

			if (c == 0) return CMD_ERROR;

   147

   148

			if (flags & DC_EXEC) {

   149

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

   150

   151

				present ^= c;

   152

				if (present == 0) {

   153

					DoClearSquare(tile);

   154

				} else {

   155

					SetRoadBits(tile, present);

   156

					MarkTileDirtyByTile(tile);

   157

				}

   158

			}

   159

			return CountRoadBits(c) * _price.remove_road;

   160

		}

   161

   162

		case ROAD_TILE_CROSSING: {

   163

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

   164

				return CMD_ERROR;

   165

			}

   166

   167

			if (flags & DC_EXEC) {

   168

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

   169

   170

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

   171

				MarkTileDirtyByTile(tile);

   172

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

   173

			}

   174

			return _price.remove_road * 2;

   175

		}

   176

   177

		default:

   178

		case ROAD_TILE_DEPOT:

   179

			return CMD_ERROR;

   180

	}

   181

}

   182

   183

   184

static const RoadBits _valid_tileh_slopes_road[][15] = {

   185

	/* set of normal ones */

   186

	{

   187

		ROAD_ALL, ROAD_NONE, ROAD_NONE,

   188

		ROAD_X,   ROAD_NONE, ROAD_NONE,  // 3, 4, 5

   189

		ROAD_Y,   ROAD_NONE, ROAD_NONE,

   190

		ROAD_Y,   ROAD_NONE, ROAD_NONE,  // 9, 10, 11

   191

		ROAD_X,   ROAD_NONE, ROAD_NONE

   192

	},

   193

	/* allowed road for an evenly raised platform */

   194

	{

   195

		ROAD_NONE,

   196

		ROAD_SW | ROAD_NW,

   197

		ROAD_SW | ROAD_SE,

   198

		ROAD_Y  | ROAD_SW,

   199

   200

		ROAD_SE | ROAD_NE, // 4

   201

		ROAD_ALL,

   202

		ROAD_X  | ROAD_SE,

   203

		ROAD_ALL,

   204

   205

		ROAD_NW | ROAD_NE, // 8

   206

		ROAD_X  | ROAD_NW,

   207

		ROAD_ALL,

   208

		ROAD_ALL,

   209

   210

		ROAD_Y  | ROAD_NE, // 12

   211

		ROAD_ALL,

   212

		ROAD_ALL

   213

	},

   214

};

   215

   216

   217

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

   218

{

   219

	RoadBits road_bits;

   220

   221

	if (IsSteepSlope(tileh)) {

   222

		if (existing == 0) {

   223

			/* force full pieces. */

   224

			*pieces |= (RoadBits)((*pieces & 0xC) >> 2);

   225

			*pieces |= (RoadBits)((*pieces & 0x3) << 2);

   226

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

   227

		}

   228

		return CMD_ERROR;

   229

	}

   230

	road_bits = *pieces | existing;

   231

   232

	/* no special foundation */

   233

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

   234

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

   235

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

   236

		return 0; // no extra cost

   237

	}

   238

   239

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

   240

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

   241

		return existing != 0 ? 0 : _price.terraform;

   242

	}

   243

   244

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

   245

	if (existing == 0 && (tileh == SLOPE_W || tileh == SLOPE_S || tileh == SLOPE_E || tileh == SLOPE_N)) {

   246

		/* force full pieces. */

   247

		*pieces |= (RoadBits)((*pieces & 0xC) >> 2);

   248

		*pieces |= (RoadBits)((*pieces & 0x3) << 2);

   249

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

   250

	}

   251

	return CMD_ERROR;

   252

}

   253

   254

/** Build a piece of road.

   255

 * @param tile tile where to build road

   256

 * @param flags operation to perform

   257

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

   258

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

   259

 */

   260

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

   261

{

   262

	int32 cost = 0;

   263

	int32 ret;

   264

	RoadBits existing = ROAD_NONE;

   265

	Slope tileh;

   266

   267

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   268

   269

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

   270

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

   271

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

   272

   273

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

   274

   275

	tileh = GetTileSlope(tile, NULL);

   276

   277

	switch (GetTileType(tile)) {

   278

		case MP_STREET:

   279

			switch (GetRoadTileType(tile)) {

   280

				case ROAD_TILE_NORMAL:

   281

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

   282

   283

					existing = GetRoadBits(tile);

   284

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

   285

						return_cmd_error(STR_1007_ALREADY_BUILT);

   286

					}

   287

					if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   288

					break;

   289

   290

				case ROAD_TILE_CROSSING:

   291

					if (pieces != GetCrossingRoadBits(tile)) { // XXX is this correct?

   292

						return_cmd_error(STR_1007_ALREADY_BUILT);

   293

					}

   294

					goto do_clear;

   295

   296

				default:

   297

				case ROAD_TILE_DEPOT:

   298

					goto do_clear;

   299

			}

   300

			break;

   301

   302

		case MP_RAILWAY: {

   303

			Axis roaddir;

   304

   305

			if (IsSteepSlope(tileh)) {

   306

				return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   307

			}

   308

   309

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

   310

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

   311

			if (!HASBIT(M(SLOPE_SEN) | M(SLOPE_ENW) | M(SLOPE_NWS) | M(SLOPE_NS) | M(SLOPE_WSE) | M(SLOPE_EW) | M(SLOPE_FLAT), tileh)) {

   312

				return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   313

			}

   314

#undef M

   315

   316

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

   317

			switch (GetTrackBits(tile)) {

   318

				case TRACK_BIT_X:

   319

					if (pieces & ROAD_X) goto do_clear;

   320

					roaddir = AXIS_Y;

   321

					break;

   322

   323

				case TRACK_BIT_Y:

   324

					if (pieces & ROAD_Y) goto do_clear;

   325

					roaddir = AXIS_X;

   326

					break;

   327

   328

				default: goto do_clear;

   329

			}

   330

   331

			if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   332

   333

			if (flags & DC_EXEC) {

   334

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

   335

				MakeRoadCrossing(tile, _current_player, GetTileOwner(tile), roaddir, GetRailType(tile), p2);

   336

				MarkTileDirtyByTile(tile);

   337

			}

   338

			return _price.build_road * 2;

   339

		}

   340

   341

		default:

   342

do_clear:;

   343

			ret = DoCommand(tile, 0, 0, flags, CMD_LANDSCAPE_CLEAR);

   344

			if (CmdFailed(ret)) return ret;

   345

			cost += ret;

   346

	}

   347

   348

	ret = CheckRoadSlope(tileh, &pieces, existing);

   349

	/* Return an error if we need to build a foundation (ret != 0) but the

   350

	 * current patch-setting is turned off (or stupid AI@work) */

   351

	if (CmdFailed(ret) || (ret != 0 && (!_patches.build_on_slopes || _is_old_ai_player)))

   352

		return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   353

   354

	cost += ret;

   355

   356

	if (IsTileType(tile, MP_STREET)) {

   357

		/* Don't put the pieces that already exist */

   358

		pieces &= ComplementRoadBits(existing);

   359

	}

   360

   361

	cost += CountRoadBits(pieces) * _price.build_road;

   362

   363

	if (flags & DC_EXEC) {

   364

		if (IsTileType(tile, MP_STREET)) {

   365

			SetRoadBits(tile, existing | pieces);

   366

		} else {

   367

			MakeRoadNormal(tile, _current_player, pieces, p2);

   368

		}

   369

   370

		MarkTileDirtyByTile(tile);

   371

	}

   372

	return cost;

   373

}

   374

   375

/**

   376

 * Switches the rail type on a level crossing.

   377

 * @param tile        The tile on which the railtype is to be convert.

   378

 * @param totype      The railtype we want to convert to

   379

 * @param exec        Switches between test and execute mode

   380

 * @return            The cost and state of the operation

   381

 * @retval CMD_ERROR  An error occured during the operation.

   382

 */

   383

int32 DoConvertStreetRail(TileIndex tile, RailType totype, bool exec)

   384

{

   385

	/* not a railroad crossing? */

   386

	if (!IsLevelCrossing(tile)) return CMD_ERROR;

   387

   388

	/* not owned by me? */

   389

	if (!CheckTileOwnership(tile) || !EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   390

   391

	if (GetRailType(tile) == totype) return CMD_ERROR;

   392

   393

	/* 'hidden' elrails can't be downgraded to normal rail when elrails are disabled */

   394

	if (_patches.disable_elrails && totype == RAILTYPE_RAIL && GetRailType(tile) == RAILTYPE_ELECTRIC) return CMD_ERROR;

   395

   396

	if (exec) {

   397

		SetRailType(tile, totype);

   398

		MarkTileDirtyByTile(tile);

   399

		YapfNotifyTrackLayoutChange(tile, FindFirstTrack(GetCrossingRailBits(tile)));

   400

	}

   401

   402

	return _price.build_rail / 2;

   403

}

   404

   405

   406

/** Build a long piece of road.

   407

 * @param end_tile end tile of drag

   408

 * @param flags operation to perform

   409

 * @param p1 start tile of drag

   410

 * @param p2 various bitstuffed elements

   411

 * - p2 = (bit 0) - start tile starts in the 2nd half of tile (p2 & 1)

   412

 * - p2 = (bit 1) - end tile starts in the 2nd half of tile (p2 & 2)

   413

 * - p2 = (bit 2) - direction: 0 = along x-axis, 1 = along y-axis (p2 & 4)

   414

 */

   415

int32 CmdBuildLongRoad(TileIndex end_tile, uint32 flags, uint32 p1, uint32 p2)

   416

{

   417

	TileIndex start_tile, tile;

   418

	int32 cost, ret;

   419

   420

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   421

   422

	if (p1 >= MapSize()) return CMD_ERROR;

   423

   424

	start_tile = p1;

   425

   426

	/* Only drag in X or Y direction dictated by the direction variable */

   427

	if (!HASBIT(p2, 2) && TileY(start_tile) != TileY(end_tile)) return CMD_ERROR; // x-axis

   428

	if (HASBIT(p2, 2)  && TileX(start_tile) != TileX(end_tile)) return CMD_ERROR; // y-axis

   429

   430

	/* Swap start and ending tile, also the half-tile drag var (bit 0 and 1) */

   431

	if (start_tile > end_tile || (start_tile == end_tile && HASBIT(p2, 0))) {

   432

		TileIndex t = start_tile;

   433

		start_tile = end_tile;

   434

		end_tile = t;

   435

		p2 ^= IS_INT_INSIDE(p2 & 3, 1, 3) ? 3 : 0;

   436

	}

   437

   438

	cost = 0;

   439

	tile = start_tile;

   440

	/* Start tile is the small number. */

   441

	for (;;) {

   442

		RoadBits bits = HASBIT(p2, 2) ? ROAD_Y : ROAD_X;

   443

   444

		if (tile == end_tile && !HASBIT(p2, 1)) bits &= ROAD_NW | ROAD_NE;

   445

		if (tile == start_tile && HASBIT(p2, 0)) bits &= ROAD_SE | ROAD_SW;

   446

   447

		ret = DoCommand(tile, bits, 0, flags, CMD_BUILD_ROAD);

   448

		if (CmdFailed(ret)) {

   449

			if (_error_message != STR_1007_ALREADY_BUILT) return CMD_ERROR;

   450

			_error_message = INVALID_STRING_ID;

   451

		} else {

   452

			cost += ret;

   453

		}

   454

   455

		if (tile == end_tile) break;

   456

   457

		tile += HASBIT(p2, 2) ? TileDiffXY(0, 1) : TileDiffXY(1, 0);

   458

	}

   459

   460

	return (cost == 0) ? CMD_ERROR : cost;

   461

}

   462

   463

/** Remove a long piece of road.

   464

 * @param end_tile end tile of drag

   465

 * @param flags operation to perform

   466

 * @param p1 start tile of drag

   467

 * @param p2 various bitstuffed elements

   468

 * - p2 = (bit 0) - start tile starts in the 2nd half of tile (p2 & 1)

   469

 * - p2 = (bit 1) - end tile starts in the 2nd half of tile (p2 & 2)

   470

 * - p2 = (bit 2) - direction: 0 = along x-axis, 1 = along y-axis (p2 & 4)

   471

 */

   472

int32 CmdRemoveLongRoad(TileIndex end_tile, uint32 flags, uint32 p1, uint32 p2)

   473

{

   474

	TileIndex start_tile, tile;

   475

	int32 cost, ret;

   476

   477

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   478

   479

	if (p1 >= MapSize()) return CMD_ERROR;

   480

   481

	start_tile = p1;

   482

   483

	/* Only drag in X or Y direction dictated by the direction variable */

   484

	if (!HASBIT(p2, 2) && TileY(start_tile) != TileY(end_tile)) return CMD_ERROR; // x-axis

   485

	if (HASBIT(p2, 2)  && TileX(start_tile) != TileX(end_tile)) return CMD_ERROR; // y-axis