1

/* $Id$ */

     2

     3

/** @file train_cmd.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "bridge_map.h"

     8

#include "debug.h"

     9

#include "functions.h"

    10

#include "landscape.h"

    11

#include "gui.h"

    12

#include "station_map.h"

    13

#include "table/strings.h"

    14

#include "strings.h"

    15

#include "map.h"

    16

#include "tile.h"

    17

#include "tunnel_map.h"

    18

#include "vehicle.h"

    19

#include "timetable.h"

    20

#include "articulated_vehicles.h"

    21

#include "command.h"

    22

#include "pathfind.h"

    23

#include "npf.h"

    24

#include "station.h"

    25

#include "table/train_cmd.h"

    26

#include "news.h"

    27

#include "engine.h"

    28

#include "player.h"

    29

#include "sound.h"

    30

#include "depot.h"

    31

#include "waypoint.h"

    32

#include "vehicle_gui.h"

    33

#include "train.h"

    34

#include "bridge.h"

    35

#include "newgrf_callbacks.h"

    36

#include "newgrf_engine.h"

    37

#include "newgrf_sound.h"

    38

#include "newgrf_text.h"

    39

#include "direction.h"

    40

#include "yapf/yapf.h"

    41

#include "date.h"

    42

#include "cargotype.h"

    43

#include "group.h"

    44

    45

static bool TrainCheckIfLineEnds(Vehicle *v);

    46

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

    47

    48

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

    49

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

    50

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

    51

    52

    53

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

    54

 * @param cargo Cargo type to get multiplier for

    55

 * @return Cargo weight multiplier

    56

 */

    57

byte FreightWagonMult(CargoID cargo)

    58

{

    59

	if (!GetCargo(cargo)->is_freight) return 1;

    60

	return _patches.freight_trains;

    61

}

    62

    63

    64

/**

    65

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

    66

 * @param v First vehicle of the consist.

    67

 */

    68

void TrainPowerChanged(Vehicle* v)

    69

{

    70

	uint32 total_power = 0;

    71

	uint32 max_te = 0;

    72

    73

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

    74

		/* Power is not added for articulated parts */

    75

		if (IsArticulatedPart(u)) continue;

    76

    77

		RailType railtype = GetRailType(u->tile);

    78

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

    79

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

    80

    81

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

    82

    83

		if (engine_has_power) {

    84

			uint16 power = GetVehicleProperty(u, 0x0B, rvi_u->power);

    85

			if (power != 0) {

    86

				total_power += power;

    87

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

    88

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

    89

			}

    90

		}

    91

    92

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

    93

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

    94

		}

    95

	}

    96

    97

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

    98

		v->u.rail.cached_power = total_power;

    99

		v->u.rail.cached_max_te = max_te;

   100

		InvalidateWindow(WC_VEHICLE_DETAILS, v->index);

   101

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

   102

	}

   103

}

   104

   105

   106

/**

   107

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

   108

 * the consist changes.

   109

 * @param v First vehicle of the consist.

   110

 */

   111

static void TrainCargoChanged(Vehicle* v)

   112

{

   113

	uint32 weight = 0;

   114

   115

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

   116

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

   117

   118

		/* Vehicle weight is not added for articulated parts. */

   119

		if (!IsArticulatedPart(u)) {

   120

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

   121

			vweight += GetVehicleProperty(u, 0x16, RailVehInfo(u->engine_type)->weight);

   122

   123

			/* powered wagons have extra weight added */

   124

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

   125

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

   126

		}

   127

   128

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

   129

		weight += vweight;

   130

   131

		/* store vehicle weight in cache */

   132

		u->u.rail.cached_veh_weight = vweight;

   133

	}

   134

   135

	/* store consist weight in cache */

   136

	v->u.rail.cached_weight = weight;

   137

   138

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

   139

	TrainPowerChanged(v);

   140

}

   141

   142

   143

/**

   144

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

   145

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

   146

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

   147

 * @param v First vehicle of the chain.

   148

 */

   149

void TrainConsistChanged(Vehicle* v)

   150

{

   151

	uint16 max_speed = 0xFFFF;

   152

   153

	assert(v->type == VEH_TRAIN);

   154

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

   155

   156

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

   157

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

   158

	v->u.rail.cached_total_length = 0;

   159

	v->u.rail.compatible_railtypes = 0;

   160

   161

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

   162

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

   163

   164

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

   165

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

   166

   167

		/* update the 'first engine' */

   168

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

   169

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

   170

   171

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

   172

   173

		/* Cache wagon override sprite group. NULL is returned if there is none */

   174

		u->u.rail.cached_override = GetWagonOverrideSpriteSet(u->engine_type, u->cargo_type, u->u.rail.first_engine);

   175

   176

		if (rvi_u->visual_effect != 0) {

   177

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

   178

		} else {

   179

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

   180

				/* Wagons and articulated parts have no effect by default */

   181

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

   182

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

   183

				/* Steam is offset by -4 units */

   184

				u->u.rail.cached_vis_effect = 4;

   185

			} else {

   186

				/* Diesel fumes and sparks come from the centre */

   187

				u->u.rail.cached_vis_effect = 8;

   188

			}

   189

		}

   190

   191

		if (!IsArticulatedPart(u)) {

   192

			/* Check powered wagon / visual effect callback */

   193

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

   194

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

   195

   196

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

   197

			}

   198

   199

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

   200

				UsesWagonOverride(u) && !HASBIT(u->u.rail.cached_vis_effect, 7)) {

   201

				/* wagon is powered */

   202

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

   203

			} else {

   204

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

   205

			}

   206

   207

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

   208

			   have railtype normal */

   209

			if (rvi_u->power > 0) {

   210

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

   211

			}

   212

   213

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

   214

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

   215

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

   216

				u->u.rail.railtype = RAILTYPE_RAIL;

   217

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

   218

			}

   219

   220

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

   221

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

   222

				uint16 speed = GetVehicleProperty(u, 0x09, rvi_u->max_speed);

   223

				if (speed != 0) max_speed = min(speed, max_speed);

   224

			}

   225

		}

   226

   227

		if (u->cargo_type == rvi_u->cargo_type && u->cargo_subtype == 0) {

   228

			/* Set cargo capacity if we've not been refitted */

   229

			u->cargo_cap = GetVehicleProperty(u, 0x14, rvi_u->capacity);

   230

		}

   231

   232

		/* check the vehicle length (callback) */

   233

		uint16 veh_len = CALLBACK_FAILED;

   234

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

   235

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

   236

		}

   237

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

   238

		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

   239

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

   240

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

   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

	int max_speed = 2000;

   304

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

   305

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

   306

   307

	/*first find the curve speed limit */

   308

	int numcurve = 0;

   309

	int sum = 0;

   310

	int pos = 0;

   311

	int lastpos = -1;

   312

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

   313

		Direction dir = u->direction;

   314

		Direction ndir = u->next->direction;

   315

		int i;

   316

   317

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

   318

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

   319

				curvecount[i]++;

   320

				if (lastpos != -1) {

   321

					numcurve++;

   322

					sum += pos - lastpos;

   323

					if (pos - lastpos == 1) {

   324

						max_speed = 88;

   325

					}

   326

				}

   327

				lastpos = pos;

   328

			}

   329

		}

   330

   331

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

   332

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

   333

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

   334

			max_speed = 61;

   335

		}

   336

	}

   337

   338

	if (numcurve > 0) sum /= numcurve;

   339

   340

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

   341

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

   342

   343

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

   344

			max_speed = 0xFFFF;

   345

		} else if (total > 1) {

   346

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

   347

		}

   348

	}

   349

   350

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

   351

   352

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

   353

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

   354

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

   355

			int delta_v;

   356

   357

			max_speed = 120;

   358

   359

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

   360

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

   361

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

   362

   363

			max_speed = max(max_speed, 25 * station_length);

   364

		}

   365

	}

   366

   367

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

   368

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

   369

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

   370

   371

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

   372

	int incl = 0;

   373

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

   374

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

   375

		num++;

   376

		drag_coeff += 3;

   377

   378

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

   379

   380

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

   381

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

   382

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

   383

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

   384

		}

   385

	}

   386

   387

	v->max_speed = max_speed;

   388

   389

	const int area = 120;

   390

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

   391

	int resistance;

   392

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

   393

		resistance = 13 * mass / 10;

   394

		resistance += 60 * num;

   395

		resistance += friction * mass * speed / 1000;

   396

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

   397

	} else {

   398

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

   399

	}

   400

	resistance += incl;

   401

	resistance *= 4; //[N]

   402

   403

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

   404

	 * actually double the train's power */

   405

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

   406

	int force;

   407

	if (speed > 2) {

   408

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

   409

			case RAILTYPE_RAIL:

   410

			case RAILTYPE_ELECTRIC:

   411

			case RAILTYPE_MONO:

   412

				force = power / speed; //[N]

   413

				force *= 22;

   414

				force /= 10;

   415

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

   416

				break;

   417

   418

			default: NOT_REACHED();

   419

			case RAILTYPE_MAGLEV:

   420

				force = power / 25;

   421

				break;

   422

		}

   423

	} else {

   424

		/* "kickoff" acceleration */

   425

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

   426

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

   427

	}

   428

   429

	if (force <= 0) force = 10000;

   430

   431

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

   432

   433

	if (mode == AM_ACCEL) {

   434

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

   435

	} else {

   436

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

   437

	}

   438

}

   439

   440

static void UpdateTrainAcceleration(Vehicle* v)

   441

{

   442

	assert(IsFrontEngine(v));

   443

   444

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

   445

   446

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

   447

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

   448

	assert(weight != 0);

   449

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

   450

}

   451

   452

int Train::GetImage(Direction direction) const

   453

{

   454

	int img = this->spritenum;

   455

	int base;

   456

   457

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

   458

   459

	if (is_custom_sprite(img)) {

   460

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

   461

		if (base != 0) return base;

   462

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

   463

	}

   464

   465

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

   466

   467

	if (this->cargo.Count() >= this->cargo_cap / 2U) base += _wagon_full_adder[img];

   468

	return base;

   469

}

   470

   471

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

   472

{

   473

	const RailVehicleInfo *rvi = RailVehInfo(engine);

   474

   475

	int img = rvi->image_index;

   476

	SpriteID image = 0;

   477

   478

	if (is_custom_sprite(img)) {

   479

		image = GetCustomVehicleIcon(engine, DIR_W);

   480

		if (image == 0) {

   481

			img = orig_rail_vehicle_info[engine].image_index;

   482