1

/* $Id$ */

     2

     3

#include "stdafx.h"

     4

#include "openttd.h"

     5

#include "bridge_map.h"

     6

#include "debug.h"

     7

#include "functions.h"

     8

#include "gui.h"

     9

#include "station_map.h"

    10

#include "table/strings.h"

    11

#include "map.h"

    12

#include "tile.h"

    13

#include "tunnel_map.h"

    14

#include "vehicle.h"

    15

#include "command.h"

    16

#include "pathfind.h"

    17

#include "npf.h"

    18

#include "station.h"

    19

#include "table/train_cmd.h"

    20

#include "news.h"

    21

#include "engine.h"

    22

#include "player.h"

    23

#include "sound.h"

    24

#include "depot.h"

    25

#include "waypoint.h"

    26

#include "vehicle_gui.h"

    27

#include "train.h"

    28

#include "bridge.h"

    29

#include "newgrf_callbacks.h"

    30

#include "newgrf_engine.h"

    31

#include "newgrf_sound.h"

    32

#include "newgrf_text.h"

    33

#include "direction.h"

    34

#include "yapf/yapf.h"

    35

#include "date.h"

    36

    37

static bool TrainCheckIfLineEnds(Vehicle *v);

    38

static void TrainController(Vehicle *v, bool update_image);

    39

    40

static const byte _vehicle_initial_x_fract[4] = {10, 8, 4,  8};

    41

static const byte _vehicle_initial_y_fract[4] = { 8, 4, 8, 10};

    42

static const byte _state_dir_table[4] = { 0x20, 8, 0x10, 4 };

    43

    44

    45

/** Return the cargo weight multiplier to use for a rail vehicle

    46

 * @param cargo Cargo type to get multiplier for

    47

 * @return Cargo weight multiplier

    48

 */

    49

byte FreightWagonMult(CargoID cargo)

    50

{

    51

	// XXX NewCargos introduces a specific "is freight" flag for this test.

    52

	if (cargo == CT_PASSENGERS || cargo == CT_MAIL) return 1;

    53

	return _patches.freight_trains;

    54

}

    55

    56

    57

/**

    58

 * Recalculates the cached total power of a train. Should be called when the consist is changed

    59

 * @param v First vehicle of the consist.

    60

 */

    61

void TrainPowerChanged(Vehicle* v)

    62

{

    63

	Vehicle* u;

    64

	uint32 power = 0;

    65

	uint32 max_te = 0;

    66

    67

	for (u = v; u != NULL; u = u->next) {

    68

		const RailVehicleInfo *rvi_u;

    69

		bool engine_has_power = true;

    70

		bool wagon_has_power = true;

    71

    72

		/* Power is not added for articulated parts */

    73

		if (IsArticulatedPart(u)) continue;

    74

    75

		if (IsLevelCrossingTile(u->tile)) {

    76

			if (!HasPowerOnRail(u->u.rail.railtype, GetRailTypeCrossing(u->tile))) engine_has_power = false;

    77

			if (!HasPowerOnRail(v->u.rail.railtype, GetRailTypeCrossing(u->tile))) wagon_has_power = false;

    78

		} else {

    79

			if (!HasPowerOnRail(u->u.rail.railtype, GetRailType(u->tile))) engine_has_power = false;

    80

			if (!HasPowerOnRail(v->u.rail.railtype, GetRailType(u->tile))) wagon_has_power = false;

    81

		}

    82

    83

		rvi_u = RailVehInfo(u->engine_type);

    84

    85

		if (engine_has_power && rvi_u->power != 0) {

    86

			power += rvi_u->power;

    87

			/* Tractive effort in (tonnes * 1000 * 10 =) N */

    88

			max_te += (u->u.rail.cached_veh_weight * 10000 * rvi_u->tractive_effort) / 256;

    89

		}

    90

    91

		if (HASBIT(u->u.rail.flags, VRF_POWEREDWAGON) && (wagon_has_power)) {

    92

			power += RailVehInfo(u->u.rail.first_engine)->pow_wag_power;

    93

		}

    94

	}

    95

    96

	if (v->u.rail.cached_power != power || v->u.rail.cached_max_te != max_te) {

    97

		v->u.rail.cached_power = power;

    98

		v->u.rail.cached_max_te = max_te;

    99

		InvalidateWindow(WC_VEHICLE_DETAILS, v->index);

   100

		InvalidateWindowWidget(WC_VEHICLE_VIEW, v->index, STATUS_BAR);

   101

	}

   102

}

   103

   104

   105

/**

   106

 * Recalculates the cached weight of a train and its vehicles. Should be called each time the cargo on

   107

 * the consist changes.

   108

 * @param v First vehicle of the consist.

   109

 */

   110

static void TrainCargoChanged(Vehicle* v)

   111

{

   112

	Vehicle *u;

   113

	uint32 weight = 0;

   114

   115

	for (u = v; u != NULL; u = u->next) {

   116

		const RailVehicleInfo *rvi = RailVehInfo(u->engine_type);

   117

		uint32 vweight = (_cargoc.weights[u->cargo_type] * u->cargo_count * FreightWagonMult(u->cargo_type)) / 16;

   118

   119

		// Vehicle weight is not added for articulated parts.

   120

		if (!IsArticulatedPart(u)) {

   121

			// vehicle weight is the sum of the weight of the vehicle and the weight of its cargo

   122

			vweight += rvi->weight;

   123

   124

			// powered wagons have extra weight added

   125

			if (HASBIT(u->u.rail.flags, VRF_POWEREDWAGON))

   126

				vweight += RailVehInfo(u->u.rail.first_engine)->pow_wag_weight;

   127

		}

   128

   129

		// consist weight is the sum of the weight of all vehicles in the consist

   130

		weight += vweight;

   131

   132

		// store vehicle weight in cache

   133

		u->u.rail.cached_veh_weight = vweight;

   134

	};

   135

   136

	// store consist weight in cache

   137

	v->u.rail.cached_weight = weight;

   138

   139

	/* Now update train power (tractive effort is dependent on weight) */

   140

	TrainPowerChanged(v);

   141

}

   142

   143

   144

/**

   145

 * Recalculates the cached stuff of a train. Should be called each time a vehicle is added

   146

 * to/removed from the chain, and when the game is loaded.

   147

 * Note: this needs to be called too for 'wagon chains' (in the depot, without an engine)

   148

 * @param v First vehicle of the chain.

   149

 */

   150

void TrainConsistChanged(Vehicle* v)

   151

{

   152

	const RailVehicleInfo *rvi_v;

   153

	Vehicle *u;

   154

	uint16 max_speed = 0xFFFF;

   155

	EngineID first_engine;

   156

   157

	assert(v->type == VEH_Train);

   158

   159

	assert(IsFrontEngine(v) || IsFreeWagon(v));

   160

   161

	rvi_v = RailVehInfo(v->engine_type);

   162

	first_engine = IsFrontEngine(v) ? v->engine_type : INVALID_ENGINE;

   163

	v->u.rail.cached_total_length = 0;

   164

	v->u.rail.compatible_railtypes = 0;

   165

   166

	for (u = v; u != NULL; u = u->next) {

   167

		const RailVehicleInfo *rvi_u = RailVehInfo(u->engine_type);

   168

		uint16 veh_len;

   169

   170

		// Update the v->first cache. This is faster than having to brute force it later.

   171

		if (u->first == NULL) u->first = v;

   172

   173

		// update the 'first engine'

   174

		u->u.rail.first_engine = (v == u) ? (EngineID)INVALID_ENGINE : first_engine;

   175

		u->u.rail.railtype = GetEngine(u->engine_type)->railtype;

   176

   177

		if (IsTrainEngine(u)) first_engine = u->engine_type;

   178

   179

		if (rvi_u->visual_effect != 0) {

   180

			u->u.rail.cached_vis_effect = rvi_u->visual_effect;

   181

		} else {

   182

			if (IsTrainWagon(u) || IsArticulatedPart(u)) {

   183

				// Wagons and articulated parts have no effect by default

   184

				u->u.rail.cached_vis_effect = 0x40;

   185

			} else if (rvi_u->engclass == 0) {

   186

				// Steam is offset by -4 units

   187

				u->u.rail.cached_vis_effect = 4;

   188

			} else {

   189

				// Diesel fumes and sparks come from the centre

   190

				u->u.rail.cached_vis_effect = 8;

   191

			}

   192

		}

   193

   194

		if (!IsArticulatedPart(u)) {

   195

			// check if its a powered wagon

   196

			CLRBIT(u->u.rail.flags, VRF_POWEREDWAGON);

   197

   198

			/* Check powered wagon / visual effect callback */

   199

			if (HASBIT(EngInfo(u->engine_type)->callbackmask, CBM_WAGON_POWER)) {

   200

				uint16 callback = GetVehicleCallback(CBID_TRAIN_WAGON_POWER, 0, 0, u->engine_type, u);

   201

   202

				if (callback != CALLBACK_FAILED) u->u.rail.cached_vis_effect = callback;

   203

			}

   204

   205

			if ((rvi_v->pow_wag_power != 0) && (rvi_u->flags & RVI_WAGON) && UsesWagonOverride(u)) {

   206

				if (u->u.rail.cached_vis_effect < 0x40) {

   207

					/* wagon is powered */

   208

					SETBIT(u->u.rail.flags, VRF_POWEREDWAGON); // cache 'powered' status

   209

				}

   210

			}

   211

   212

			/* Do not count powered wagons for the compatible railtypes, as wagons always

   213

			   have railtype normal */

   214

			if (rvi_u->power > 0) {

   215

				v->u.rail.compatible_railtypes |= GetRailTypeInfo(u->u.rail.railtype)->powered_railtypes;

   216

			}

   217

   218

			/* Some electric engines can be allowed to run on normal rail. It happens to all

   219

			 * existing electric engines when elrails are disabled and then re-enabled */

   220

			if (HASBIT(u->u.rail.flags, VRF_EL_ENGINE_ALLOWED_NORMAL_RAIL)) {

   221

				u->u.rail.railtype = RAILTYPE_RAIL;

   222

				u->u.rail.compatible_railtypes |= (1 << RAILTYPE_RAIL);

   223

			}

   224

   225

			// max speed is the minimum of the speed limits of all vehicles in the consist

   226

			if (!(rvi_u->flags & RVI_WAGON) || _patches.wagon_speed_limits)

   227

				if (rvi_u->max_speed != 0 && !UsesWagonOverride(u))

   228

					max_speed = min(rvi_u->max_speed, max_speed);

   229

		}

   230

   231

		// check the vehicle length (callback)

   232

		veh_len = CALLBACK_FAILED;

   233

		if (HASBIT(EngInfo(u->engine_type)->callbackmask, CBM_VEHICLE_LENGTH)) {

   234

			veh_len = GetVehicleCallback(CBID_TRAIN_VEHICLE_LENGTH, 0, 0, u->engine_type, u);

   235

		}

   236

		if (veh_len == CALLBACK_FAILED) veh_len = rvi_u->shorten_factor;

   237

		veh_len = clamp(veh_len, 0, u->next == NULL ? 7 : 5); // the clamp on vehicles not the last in chain is stricter, as too short wagons can break the 'follow next vehicle' code

   238

		u->u.rail.cached_veh_length = 8 - veh_len;

   239

		v->u.rail.cached_total_length += u->u.rail.cached_veh_length;

   240

   241

	};

   242

   243

	// store consist weight/max speed in cache

   244

	v->u.rail.cached_max_speed = max_speed;

   245

   246

	// recalculate cached weights and power too (we do this *after* the rest, so it is known which wagons are powered and need extra weight added)

   247

	TrainCargoChanged(v);

   248

}

   249

   250

/* These two arrays are used for realistic acceleration. XXX: How should they

   251

 * be interpreted? */

   252

static const byte _curve_neighbours45[8][2] = {

   253

	{7, 1},

   254

	{0, 2},

   255

	{1, 3},

   256

	{2, 4},

   257

	{3, 5},

   258

	{4, 6},

   259

	{5, 7},

   260

	{6, 0},

   261

};

   262

   263

static const byte _curve_neighbours90[8][2] = {

   264

	{6, 2},

   265

	{7, 3},

   266

	{0, 4},

   267

	{1, 5},

   268

	{2, 6},

   269

	{3, 7},

   270

	{4, 0},

   271

	{5, 1},

   272

};

   273

   274

enum AccelType {

   275

	AM_ACCEL,

   276

	AM_BRAKE

   277

};

   278

   279

static bool TrainShouldStop(const Vehicle* v, TileIndex tile)

   280

{

   281

	const Order* o = &v->current_order;

   282

	StationID sid = GetStationIndex(tile);

   283

   284

	assert(v->type == VEH_Train);

   285

	//When does a train drive through a station

   286

	//first we deal with the "new nonstop handling"

   287

	if (_patches.new_nonstop && o->flags & OF_NON_STOP && sid == o->dest) {

   288

		return false;

   289

	}

   290

   291

	if (v->last_station_visited == sid) return false;

   292

   293

	if (sid != o->dest && (o->flags & OF_NON_STOP || _patches.new_nonstop)) {

   294

		return false;

   295

	}

   296

   297

	return true;

   298

}

   299

   300

//new acceleration

   301

static int GetTrainAcceleration(Vehicle *v, bool mode)

   302

{

   303

	const Vehicle *u;

   304

	int num = 0; //number of vehicles, change this into the number of axles later

   305

	int power = 0;

   306

	int mass = 0;

   307

	int max_speed = 2000;

   308

	int area = 120;

   309

	int friction = 35; //[1e-3]

   310

	int drag_coeff = 20; //[1e-4]

   311

	int incl = 0;

   312

	int resistance;

   313

	int speed = v->cur_speed; //[mph]

   314

	int force = 0x3FFFFFFF;

   315

	int pos = 0;

   316

	int lastpos = -1;

   317

	int curvecount[2] = {0, 0};

   318

	int sum = 0;

   319

	int numcurve = 0;

   320

	int max_te = v->u.rail.cached_max_te; // [N]

   321

   322

	speed *= 10;

   323

	speed /= 16;

   324

   325

	//first find the curve speed limit

   326

	for (u = v; u->next != NULL; u = u->next, pos++) {

   327

		Direction dir = u->direction;

   328

		Direction ndir = u->next->direction;

   329

		int i;

   330

   331

		for (i = 0; i < 2; i++) {

   332

			if ( _curve_neighbours45[dir][i] == ndir) {

   333

				curvecount[i]++;

   334

				if (lastpos != -1) {

   335

					numcurve++;

   336

					sum += pos - lastpos;

   337

					if (pos - lastpos == 1) {

   338

						max_speed = 88;

   339

					}

   340

				}

   341

				lastpos = pos;

   342

			}

   343

		}

   344

   345

		//if we have a 90 degree turn, fix the speed limit to 60

   346

		if (_curve_neighbours90[dir][0] == ndir ||

   347

				_curve_neighbours90[dir][1] == ndir) {

   348

			max_speed = 61;

   349

		}

   350

	}

   351

   352

	if (numcurve > 0) sum /= numcurve;

   353

   354

	if ((curvecount[0] != 0 || curvecount[1] != 0) && max_speed > 88) {

   355

		int total = curvecount[0] + curvecount[1];

   356

   357

		if (curvecount[0] == 1 && curvecount[1] == 1) {

   358

			max_speed = 0xFFFF;

   359

		} else if (total > 1) {

   360

			max_speed = 232 - (13 - clamp(sum, 1, 12)) * (13 - clamp(sum, 1, 12));

   361

		}

   362

	}

   363

   364

	max_speed += (max_speed / 2) * v->u.rail.railtype;

   365

   366

	if (IsTileType(v->tile, MP_STATION) && IsFrontEngine(v)) {

   367

		if (TrainShouldStop(v, v->tile)) {

   368

			int station_length = GetPlatformLength(v->tile, DirToDiagDir(v->direction));

   369

			int delta_v;

   370

   371

			max_speed = 120;

   372

   373

			delta_v = v->cur_speed / (station_length + 1);

   374

			if (v->max_speed > (v->cur_speed - delta_v))

   375

				max_speed = v->cur_speed - (delta_v / 10);

   376

   377

			max_speed = max(max_speed, 25 * station_length);

   378

		}

   379

	}

   380

   381

	mass = v->u.rail.cached_weight;

   382

	power = v->u.rail.cached_power * 746;

   383

	max_speed = min(max_speed, v->u.rail.cached_max_speed);

   384

   385

	for (u = v; u != NULL; u = u->next) {

   386

		num++;

   387

		drag_coeff += 3;

   388

   389

		if (u->u.rail.track == 0x80) max_speed = min(max_speed, 61);

   390

   391

		if (HASBIT(u->u.rail.flags, VRF_GOINGUP)) {

   392

			incl += u->u.rail.cached_veh_weight * 60; //3% slope, quite a bit actually

   393

		} else if (HASBIT(u->u.rail.flags, VRF_GOINGDOWN)) {

   394

			incl -= u->u.rail.cached_veh_weight * 60;

   395

		}

   396

	}

   397

   398

	v->max_speed = max_speed;

   399

   400

	if (v->u.rail.railtype != RAILTYPE_MAGLEV) {

   401

		resistance = 13 * mass / 10;

   402

		resistance += 60 * num;

   403

		resistance += friction * mass * speed / 1000;

   404

		resistance += (area * drag_coeff * speed * speed) / 10000;

   405

	} else {

   406

		resistance = (area * (drag_coeff / 2) * speed * speed) / 10000;

   407

	}

   408

	resistance += incl;

   409

	resistance *= 4; //[N]

   410

   411

	/* Due to the mph to m/s conversion below, at speeds below 3 mph the force is

   412

	 * actually double the train's power */

   413

	if (speed > 2) {

   414

		switch (v->u.rail.railtype) {

   415

			case RAILTYPE_RAIL:

   416

			case RAILTYPE_ELECTRIC:

   417

			case RAILTYPE_MONO:

   418

				force = power / speed; //[N]

   419

				force *= 22;

   420

				force /= 10;

   421

				if (mode == AM_ACCEL && force > max_te) force = max_te;

   422

				break;

   423

   424

			case RAILTYPE_MAGLEV:

   425

				force = power / 25;

   426

				break;

   427

   428

			default: NOT_REACHED();

   429

		}

   430

	} else {

   431

		//"kickoff" acceleration

   432

		force = (mode == AM_ACCEL && v->u.rail.railtype != RAILTYPE_MAGLEV) ? min(max_te, power) : power;

   433

		force = max(force, (mass * 8) + resistance);

   434

	}

   435

   436

	if (force <= 0) force = 10000;

   437

   438

	if (v->u.rail.railtype != RAILTYPE_MAGLEV) force = min(force, mass * 10 * 200);

   439

   440

	if (mode == AM_ACCEL) {

   441

		return (force - resistance) / (mass * 4);

   442

	} else {

   443

		return min((-force - resistance) / (mass * 4), -10000 / (mass * 4));

   444

	}

   445

}

   446

   447

static void UpdateTrainAcceleration(Vehicle* v)

   448

{

   449

	uint power = 0;

   450

	uint weight = 0;

   451

   452

	assert(IsFrontEngine(v));

   453

   454

	weight = v->u.rail.cached_weight;

   455

	power = v->u.rail.cached_power;

   456

	v->max_speed = v->u.rail.cached_max_speed;

   457

   458

	assert(weight != 0);

   459

   460

	v->acceleration = clamp(power / weight * 4, 1, 255);

   461

}

   462

   463

int GetTrainImage(const Vehicle* v, Direction direction)

   464

{

   465

	int img = v->spritenum;

   466

	int base;

   467

   468

	if (HASBIT(v->u.rail.flags, VRF_REVERSE_DIRECTION)) direction = ReverseDir(direction);

   469

   470

	if (is_custom_sprite(img)) {

   471

		base = GetCustomVehicleSprite(v, (Direction)(direction + 4 * IS_CUSTOM_SECONDHEAD_SPRITE(img)));

   472

		if (base != 0) return base;

   473

		img = orig_rail_vehicle_info[v->engine_type].image_index;

   474

	}

   475

   476

	base = _engine_sprite_base[img] + ((direction + _engine_sprite_add[img]) & _engine_sprite_and[img]);

   477

   478

	if (v->cargo_count >= v->cargo_cap / 2) base += _wagon_full_adder[img];

   479

	return base;

   480

}

   481

   482

void DrawTrainEngine(int x, int y, EngineID engine, uint32 image_ormod)

   483

{

   484

	const RailVehicleInfo *rvi = RailVehInfo(engine);

   485