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

#include "table/sprites.h"

    45

    46

static bool TrainCheckIfLineEnds(Vehicle *v);

    47

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

    48

    49

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

    50

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

    51

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

    52

    53

    54

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

    55

 * @param cargo Cargo type to get multiplier for

    56

 * @return Cargo weight multiplier

    57

 */

    58

byte FreightWagonMult(CargoID cargo)

    59

{

    60

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

    61

	return _patches.freight_trains;

    62

}

    63

    64

    65

/**

    66

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

    67

 * @param v First vehicle of the consist.

    68

 */

    69

void TrainPowerChanged(Vehicle* v)

    70

{

    71

	uint32 total_power = 0;

    72

	uint32 max_te = 0;

    73

    74

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

    75

		/* Power is not added for articulated parts */

    76

		if (IsArticulatedPart(u)) continue;

    77

    78

		RailType railtype = GetRailType(u->tile);

    79

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

    80

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

    81

    82

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

    83

    84

		if (engine_has_power) {

    85

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

    86

			if (power != 0) {

    87

				total_power += power;

    88

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

    89

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

    90

			}

    91

		}

    92

    93

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

    94

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

    95

		}

    96

	}

    97

    98

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

    99

		/* If it has no power (no catenary), stop the train */

   100

		if (total_power == 0) v->vehstatus |= VS_STOPPED;

   101

   102

		v->u.rail.cached_power = total_power;

   103

		v->u.rail.cached_max_te = max_te;

   104

		InvalidateWindow(WC_VEHICLE_DETAILS, v->index);

   105

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

   106

	}

   107

}

   108

   109

   110

/**

   111

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

   112

 * the consist changes.

   113

 * @param v First vehicle of the consist.

   114

 */

   115

static void TrainCargoChanged(Vehicle* v)

   116

{

   117

	uint32 weight = 0;

   118

   119

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

   120

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

   121

   122

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

   123

		if (!IsArticulatedPart(u)) {

   124

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

   125

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

   126

   127

			/* powered wagons have extra weight added */

   128

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

   129

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

   130

		}

   131

   132

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

   133

		weight += vweight;

   134

   135

		/* store vehicle weight in cache */

   136

		u->u.rail.cached_veh_weight = vweight;

   137

	}

   138

   139

	/* store consist weight in cache */

   140

	v->u.rail.cached_weight = weight;

   141

   142

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

   143

	TrainPowerChanged(v);

   144

}

   145

   146

   147

/**

   148

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

   149

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

   150

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

   151

 * @param v First vehicle of the chain.

   152

 */

   153

void TrainConsistChanged(Vehicle* v)

   154

{

   155

	uint16 max_speed = 0xFFFF;

   156

   157

	assert(v->type == VEH_TRAIN);

   158

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

   159

   160

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

   161

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

   162

	v->u.rail.cached_total_length = 0;

   163

	v->u.rail.compatible_railtypes = 0;

   164

   165

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

   166

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

   167

   168

		/* Check the v->first cache. */

   169

		assert(u->First() == v);

   170

   171

		/* update the 'first engine' */

   172

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

   173

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

   174

   175

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

   176

   177

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

   178

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

   179

   180

		/* Reset color map */

   181

		u->colormap = PAL_NONE;

   182

   183

		if (rvi_u->visual_effect != 0) {

   184

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

   185

		} else {

   186

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

   187

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

   188

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

   189

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

   190

				/* Steam is offset by -4 units */

   191

				u->u.rail.cached_vis_effect = 4;

   192

			} else {

   193

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

   194

				u->u.rail.cached_vis_effect = 8;

   195

			}

   196

		}

   197

   198

		if (!IsArticulatedPart(u)) {

   199

			/* Check powered wagon / visual effect callback */

   200

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

   201

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

   202

   203

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

   204

			}

   205

   206

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

   207

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

   208

				/* wagon is powered */

   209

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

   210

			} else {

   211

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

   212

			}

   213

   214

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

   215

			   have railtype normal */

   216

			if (rvi_u->power > 0) {

   217

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

   218

			}

   219

   220

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

   221

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

   222

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

   223

				u->u.rail.railtype = RAILTYPE_RAIL;

   224

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

   225

			}

   226

   227

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

   228

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

   229

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

   230

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

   231

			}

   232

		}

   233

   234

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

   235

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

   236

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

   237

		}

   238

   239

		/* check the vehicle length (callback) */

   240

		uint16 veh_len = CALLBACK_FAILED;

   241

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

   242

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

   243

		}

   244

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

   245

		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

   246

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

   247

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

   248

	}

   249

   250

	/* store consist weight/max speed in cache */

   251

	v->u.rail.cached_max_speed = max_speed;

   252

   253

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

   254

	TrainCargoChanged(v);

   255

}

   256

   257

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

   258

 * be interpreted? */

   259

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

   260

	{7, 1},

   261

	{0, 2},

   262

	{1, 3},

   263

	{2, 4},

   264

	{3, 5},

   265

	{4, 6},

   266

	{5, 7},

   267

	{6, 0},

   268

};

   269

   270

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

   271

	{6, 2},

   272

	{7, 3},

   273

	{0, 4},

   274

	{1, 5},

   275

	{2, 6},

   276

	{3, 7},

   277

	{4, 0},

   278

	{5, 1},

   279

};

   280

   281

enum AccelType {

   282

	AM_ACCEL,

   283

	AM_BRAKE

   284

};

   285

   286

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

   287

{

   288

	const Order* o = &v->current_order;

   289

	StationID sid = GetStationIndex(tile);

   290

   291

	assert(v->type == VEH_TRAIN);

   292

	/* When does a train drive through a station

   293

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

   294

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

   295

		return false;

   296

	}

   297

   298

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

   299

   300

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

   301

		return false;

   302

	}

   303

   304

	return true;

   305

}

   306

   307

/** new acceleration*/

   308

static int GetTrainAcceleration(Vehicle *v, bool mode)

   309

{

   310

	int max_speed = 2000;

   311

	int speed = v->cur_speed * 10 / 16; // km-ish/h -> mp/h

   312

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

   313

   314

	/*first find the curve speed limit */

   315

	int numcurve = 0;

   316

	int sum = 0;

   317

	int pos = 0;

   318

	int lastpos = -1;

   319

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

   320

		Direction dir = u->direction;

   321

		Direction ndir = u->Next()->direction;

   322

		int i;

   323

   324

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

   325

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

   326

				curvecount[i]++;

   327

				if (lastpos != -1) {

   328

					numcurve++;

   329

					sum += pos - lastpos;

   330

					if (pos - lastpos == 1) {

   331

						max_speed = 88;

   332

					}

   333

				}

   334

				lastpos = pos;

   335

			}

   336

		}

   337

   338

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

   339

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

   340

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

   341

			max_speed = 61;

   342

		}

   343

	}

   344

   345

	if (numcurve > 0) sum /= numcurve;

   346

   347

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

   348

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

   349

   350

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

   351

			max_speed = 0xFFFF;

   352

		} else if (total > 1) {

   353

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

   354

		}

   355

	}

   356

   357

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

   358

   359

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

   360

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

   361

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

   362

			int delta_v;

   363

   364

			max_speed = 120;

   365

   366

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

   367

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

   368

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

   369

   370

			max_speed = max(max_speed, 25 * station_length);

   371

		}

   372

	}

   373

   374

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

   375

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

   376

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

   377

   378

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

   379

	int incl = 0;

   380

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

   381

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

   382

		num++;

   383

		drag_coeff += 3;

   384

   385

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

   386

   387

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

   388

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

   389

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

   390

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

   391

		}

   392

	}

   393

   394

	v->max_speed = max_speed;

   395

   396

	const int area = 120;

   397

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

   398

	int resistance;

   399

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

   400

		resistance = 13 * mass / 10;

   401

		resistance += 60 * num;

   402

		resistance += friction * mass * speed / 1000;

   403

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

   404

	} else {

   405

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

   406

	}

   407

	resistance += incl;

   408

	resistance *= 4; //[N]

   409

   410

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

   411

	 * actually double the train's power */

   412

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

   413

	int force;

   414

	if (speed > 2) {

   415

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

   416

			case RAILTYPE_RAIL:

   417

			case RAILTYPE_ELECTRIC:

   418

			case RAILTYPE_MONO:

   419

				force = power / speed; //[N]

   420

				force *= 22;

   421

				force /= 10;

   422

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

   423

				break;

   424

   425

			default: NOT_REACHED();

   426

			case RAILTYPE_MAGLEV:

   427

				force = power / 25;

   428

				break;

   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

	assert(IsFrontEngine(v));

   450

   451

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

   452

   453

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

   454

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

   455

	assert(weight != 0);

   456

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

   457

}

   458

   459

int Train::GetImage(Direction direction) const

   460

{

   461

	int img = this->spritenum;

   462

	int base;

   463

   464

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

   465

   466

	if (is_custom_sprite(img)) {

   467

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

   468

		if (base != 0) return base;

   469

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

   470

	}

   471

   472

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

   473

   474

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

   475

	return base;

   476

}

   477

   478

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

   479

{

   480

	const RailVehicleInfo *rvi = RailVehInfo(engine);

   481