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

#include "cargotype.h"

    37

    38

static bool TrainCheckIfLineEnds(Vehicle *v);

    39

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

    40

    41

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

    42

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

    43

static const TrackBits _state_dir_table[4] = { TRACK_BIT_RIGHT, TRACK_BIT_LOWER, TRACK_BIT_LEFT, TRACK_BIT_UPPER };

    44

    45

    46

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

    47

 * @param cargo Cargo type to get multiplier for

    48

 * @return Cargo weight multiplier

    49

 */

    50

byte FreightWagonMult(CargoID cargo)

    51

{

    52

	if (!GetCargo(cargo)->is_freight) 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

	uint32 power = 0;

    64

	uint32 max_te = 0;

    65

    66

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

    67

		/* Power is not added for articulated parts */

    68

		if (IsArticulatedPart(u)) continue;

    69

    70

		RailType railtype = GetRailType(u->tile);

    71

		bool engine_has_power = HasPowerOnRail(u->u.rail.railtype, railtype);

    72

		bool wagon_has_power  = HasPowerOnRail(v->u.rail.railtype, railtype);

    73

    74

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

    75

    76

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

    77

			power += rvi_u->power;

    78

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

    79

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

    80

		}

    81

    82

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

    83

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

    84

		}

    85

	}

    86

    87

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

    88

		v->u.rail.cached_power = power;

    89

		v->u.rail.cached_max_te = max_te;

    90

		InvalidateWindow(WC_VEHICLE_DETAILS, v->index);

    91

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

    92

	}

    93

}

    94

    95

    96

/**

    97

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

    98

 * the consist changes.

    99

 * @param v First vehicle of the consist.

   100

 */

   101

static void TrainCargoChanged(Vehicle* v)

   102

{

   103

	uint32 weight = 0;

   104

   105

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

   106

		uint32 vweight = GetCargo(u->cargo_type)->weight * u->cargo_count * FreightWagonMult(u->cargo_type) / 16;

   107

   108

		// Vehicle weight is not added for articulated parts.

   109

		if (!IsArticulatedPart(u)) {

   110

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

   111

			vweight += RailVehInfo(u->engine_type)->weight;

   112

   113

			// powered wagons have extra weight added

   114

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

   115

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

   116

		}

   117

   118

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

   119

		weight += vweight;

   120

   121

		// store vehicle weight in cache

   122

		u->u.rail.cached_veh_weight = vweight;

   123

	}

   124

   125

	// store consist weight in cache

   126

	v->u.rail.cached_weight = weight;

   127

   128

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

   129

	TrainPowerChanged(v);

   130

}

   131

   132

   133

/**

   134

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

   135

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

   136

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

   137

 * @param v First vehicle of the chain.

   138

 */

   139

void TrainConsistChanged(Vehicle* v)

   140

{

   141

	uint16 max_speed = 0xFFFF;

   142

   143

	assert(v->type == VEH_TRAIN);

   144

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

   145

   146

	const RailVehicleInfo *rvi_v = RailVehInfo(v->engine_type);

   147

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

   148

	v->u.rail.cached_total_length = 0;

   149

	v->u.rail.compatible_railtypes = 0;

   150

   151

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

   152

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

   153

   154

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

   155

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

   156

   157

		// update the 'first engine'

   158

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

   159

		u->u.rail.railtype = rvi_u->railtype;

   160

   161

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

   162

   163

		if (rvi_u->visual_effect != 0) {

   164

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

   165

		} else {

   166

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

   167

				// Wagons and articulated parts have no effect by default

   168

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

   169

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

   170

				// Steam is offset by -4 units

   171

				u->u.rail.cached_vis_effect = 4;

   172

			} else {

   173

				// Diesel fumes and sparks come from the centre

   174

				u->u.rail.cached_vis_effect = 8;

   175

			}

   176

		}

   177

   178

		if (!IsArticulatedPart(u)) {

   179

			/* Check powered wagon / visual effect callback */

   180

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

   181

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

   182

   183

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

   184

			}

   185

   186

			if (rvi_v->pow_wag_power != 0 && rvi_u->railveh_type == RAILVEH_WAGON &&

   187

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

   188

				/* wagon is powered */

   189

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

   190

			} else {

   191

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

   192

			}

   193

   194

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

   195

			   have railtype normal */

   196

			if (rvi_u->power > 0) {

   197

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

   198

			}

   199

   200

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

   201

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

   202

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

   203

				u->u.rail.railtype = RAILTYPE_RAIL;

   204

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

   205

			}

   206

   207

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

   208

			if ((rvi_u->railveh_type != RAILVEH_WAGON || _patches.wagon_speed_limits) &&

   209

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

   210

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

   211

		}

   212

   213

		// check the vehicle length (callback)

   214

		uint16 veh_len = CALLBACK_FAILED;

   215

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

   216

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

   217

		}

   218

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

   219

		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

   220

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

   221

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

   222

	}

   223

   224

	// store consist weight/max speed in cache

   225

	v->u.rail.cached_max_speed = max_speed;

   226

   227

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

   228

	TrainCargoChanged(v);

   229

}

   230

   231

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

   232

 * be interpreted? */

   233

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

   234

	{7, 1},

   235

	{0, 2},

   236

	{1, 3},

   237

	{2, 4},

   238

	{3, 5},

   239

	{4, 6},

   240

	{5, 7},

   241

	{6, 0},

   242

};

   243

   244

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

   245

	{6, 2},

   246

	{7, 3},

   247

	{0, 4},

   248

	{1, 5},

   249

	{2, 6},

   250

	{3, 7},

   251

	{4, 0},

   252

	{5, 1},

   253

};

   254

   255

enum AccelType {

   256

	AM_ACCEL,

   257

	AM_BRAKE

   258

};

   259

   260

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

   261

{

   262

	const Order* o = &v->current_order;

   263

	StationID sid = GetStationIndex(tile);

   264

   265

	assert(v->type == VEH_TRAIN);

   266

	//When does a train drive through a station

   267

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

   268

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

   269

		return false;

   270

	}

   271

   272

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

   273

   274

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

   275

		return false;

   276

	}

   277

   278

	return true;

   279

}

   280

   281

//new acceleration

   282

static int GetTrainAcceleration(Vehicle *v, bool mode)

   283

{

   284

	int max_speed = 2000;

   285

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

   286

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

   287

   288

	//first find the curve speed limit

   289

	int numcurve = 0;

   290

	int sum = 0;

   291

	int pos = 0;

   292

	int lastpos = -1;

   293

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

   294

		Direction dir = u->direction;

   295

		Direction ndir = u->next->direction;

   296

		int i;

   297

   298

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

   299

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

   300

				curvecount[i]++;

   301

				if (lastpos != -1) {

   302

					numcurve++;

   303

					sum += pos - lastpos;

   304

					if (pos - lastpos == 1) {

   305

						max_speed = 88;

   306

					}

   307

				}

   308

				lastpos = pos;

   309

			}

   310

		}

   311

   312

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

   313

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

   314

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

   315

			max_speed = 61;

   316

		}

   317

	}

   318

   319

	if (numcurve > 0) sum /= numcurve;

   320

   321

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

   322

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

   323

   324

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

   325

			max_speed = 0xFFFF;

   326

		} else if (total > 1) {

   327

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

   328

		}

   329

	}

   330

   331

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

   332

   333

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

   334

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

   335

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

   336

			int delta_v;

   337

   338

			max_speed = 120;

   339

   340

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

   341

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

   342

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

   343

   344

			max_speed = max(max_speed, 25 * station_length);

   345

		}

   346

	}

   347

   348

	int mass = v->u.rail.cached_weight;

   349

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

   350

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

   351

   352

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

   353

	int incl = 0;

   354

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

   355

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

   356

		num++;

   357

		drag_coeff += 3;

   358

   359

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

   360

   361

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

   362

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

   363

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

   364

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

   365

		}

   366

	}

   367

   368

	v->max_speed = max_speed;

   369

   370

	const int area = 120;

   371

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

   372

	int resistance;

   373

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

   374

		resistance = 13 * mass / 10;

   375

		resistance += 60 * num;

   376

		resistance += friction * mass * speed / 1000;

   377

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

   378

	} else {

   379

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

   380

	}

   381

	resistance += incl;

   382

	resistance *= 4; //[N]

   383

   384

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

   385

	 * actually double the train's power */

   386

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

   387

	int force;

   388

	if (speed > 2) {

   389

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

   390

			case RAILTYPE_RAIL:

   391

			case RAILTYPE_ELECTRIC:

   392

			case RAILTYPE_MONO:

   393

				force = power / speed; //[N]

   394

				force *= 22;

   395

				force /= 10;

   396

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

   397

				break;

   398

   399

			default: NOT_REACHED();

   400

			case RAILTYPE_MAGLEV:

   401

				force = power / 25;

   402

				break;

   403

		}

   404

	} else {

   405

		//"kickoff" acceleration

   406

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

   407

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

   408

	}

   409

   410

	if (force <= 0) force = 10000;

   411

   412

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

   413

   414

	if (mode == AM_ACCEL) {

   415

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

   416

	} else {

   417

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

   418

	}

   419

}

   420

   421

static void UpdateTrainAcceleration(Vehicle* v)

   422

{

   423

	assert(IsFrontEngine(v));

   424

   425

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

   426

   427

	uint power = v->u.rail.cached_power;

   428

	uint weight = v->u.rail.cached_weight;

   429

	assert(weight != 0);

   430

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

   431

}

   432

   433

int GetTrainImage(const Vehicle* v, Direction direction)

   434

{

   435

	int img = v->spritenum;

   436

	int base;

   437

   438

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

   439

   440

	if (is_custom_sprite(img)) {

   441

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

   442

		if (base != 0) return base;

   443

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

   444

	}

   445

   446

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

   447

   448

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

   449

	return base;

   450

}

   451

   452

void DrawTrainEngine(int x, int y, EngineID engine, SpriteID pal)

   453

{

   454

	const RailVehicleInfo *rvi = RailVehInfo(engine);

   455

   456

	int img = rvi->image_index;

   457

	SpriteID image = 0;

   458

   459

	if (is_custom_sprite(img)) {

   460

		image = GetCustomVehicleIcon(engine, DIR_W);

   461

		if (image == 0) {

   462

			img = orig_rail_vehicle_info[engine].image_index;

   463

		} else {

   464

			y += _traininfo_vehicle_pitch;

   465

		}

   466

	}

   467

	if (image == 0) {

   468

		image = (6 & _engine_sprite_and[img]) + _engine_sprite_base[img];

   469

	}

   470

   471

	if (rvi->railveh_type == RAILVEH_MULTIHEAD) {

   472

		DrawSprite(image, pal, x - 14, y);

   473

		x += 15;

   474

		image = 0;

   475

		if (is_custom_sprite(img)) {

   476

			image = GetCustomVehicleIcon(engine, DIR_E);

   477

			if (image == 0) img = orig_rail_vehicle_info[engine].image_index;

   478

		}

   479

		if (image == 0) {

   480

			image =

   481

				((6 + _engine_sprite_add[img + 1]) & _engine_sprite_and[img + 1]) +

   482

				_engine_sprite_base[img + 1];

   483

		}

   484

	}