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

    15

#include "tile.h"

    16

#include "tunnel_map.h"

    17

#include "vehicle.h"

    18

#include "articulated_vehicles.h"

    19

#include "command.h"

    20

#include "pathfind.h"

    21

#include "npf.h"

    22

#include "station.h"

    23

#include "table/train_cmd.h"

    24

#include "news.h"

    25

#include "engine.h"

    26

#include "player.h"

    27

#include "sound.h"

    28

#include "depot.h"

    29

#include "waypoint.h"

    30

#include "vehicle_gui.h"

    31

#include "train.h"

    32

#include "bridge.h"

    33

#include "newgrf_callbacks.h"

    34

#include "newgrf_engine.h"

    35

#include "newgrf_sound.h"

    36

#include "newgrf_text.h"

    37

#include "direction.h"

    38

#include "yapf/yapf.h"

    39

#include "date.h"

    40

#include "cargotype.h"

    41

#include "group.h"

    42

    43

static bool TrainCheckIfLineEnds(Vehicle *v);

    44

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

    45

    46

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

    47

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

    48

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

    49

    50

    51

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

    52

 * @param cargo Cargo type to get multiplier for

    53

 * @return Cargo weight multiplier

    54

 */

    55

byte FreightWagonMult(CargoID cargo)

    56

{

    57

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

    58

	return _patches.freight_trains;

    59

}

    60

    61

    62

/**

    63

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

    64

 * @param v First vehicle of the consist.

    65

 */

    66

void TrainPowerChanged(Vehicle* v)

    67

{

    68

	uint32 total_power = 0;

    69

	uint32 max_te = 0;

    70

    71

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

    72

		/* Power is not added for articulated parts */

    73

		if (IsArticulatedPart(u)) continue;

    74

    75

		RailType railtype = GetRailType(u->tile);

    76

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

    77

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

    78

    79

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

    80

    81

		if (engine_has_power) {

    82

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

    83

			if (power != 0) {

    84

				total_power += power;

    85

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

    86

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

    87

			}

    88

		}

    89

    90

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

    91

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

    92

		}

    93

	}

    94

    95

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

    96

		v->u.rail.cached_power = total_power;

    97

		v->u.rail.cached_max_te = max_te;

    98

		InvalidateWindow(WC_VEHICLE_DETAILS, v->index);

    99

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

   100

	}

   101

}

   102

   103

   104

/**

   105

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

   106

 * the consist changes.

   107

 * @param v First vehicle of the consist.

   108

 */

   109

static void TrainCargoChanged(Vehicle* v)

   110

{

   111

	uint32 weight = 0;

   112

   113

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

   114

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

   115

   116

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

   117

		if (!IsArticulatedPart(u)) {

   118

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

   119

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

   120

   121

			/* powered wagons have extra weight added */

   122

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

   123

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

   124

		}

   125

   126

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

   127

		weight += vweight;

   128

   129

		/* store vehicle weight in cache */

   130

		u->u.rail.cached_veh_weight = vweight;

   131

	}

   132

   133

	/* store consist weight in cache */

   134

	v->u.rail.cached_weight = weight;

   135

   136

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

   137

	TrainPowerChanged(v);

   138

}

   139

   140

   141

/**

   142

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

   143

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

   144

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

   145

 * @param v First vehicle of the chain.

   146

 */

   147

void TrainConsistChanged(Vehicle* v)

   148

{

   149

	uint16 max_speed = 0xFFFF;

   150

   151

	assert(v->type == VEH_TRAIN);

   152

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

   153

   154

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

   155

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

   156

	v->u.rail.cached_total_length = 0;

   157

	v->u.rail.compatible_railtypes = 0;

   158

   159

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

   160

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

   161

   162

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

   163

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

   164

   165

		/* update the 'first engine' */

   166

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

   167

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

   168

   169

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

   170

   171

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

   172

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

   173

   174

		if (rvi_u->visual_effect != 0) {

   175

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

   176

		} else {

   177

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

   178

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

   179

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

   180

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

   181

				/* Steam is offset by -4 units */

   182

				u->u.rail.cached_vis_effect = 4;

   183

			} else {

   184

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

   185

				u->u.rail.cached_vis_effect = 8;

   186

			}

   187

		}

   188

   189

		if (!IsArticulatedPart(u)) {

   190

			/* Check powered wagon / visual effect callback */

   191

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

   192

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

   193

   194

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

   195

			}

   196

   197

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

   198

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

   199

				/* wagon is powered */

   200

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

   201

			} else {

   202

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

   203

			}

   204

   205

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

   206

			   have railtype normal */

   207

			if (rvi_u->power > 0) {

   208

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

   209

			}

   210

   211

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

   212

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

   213

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

   214

				u->u.rail.railtype = RAILTYPE_RAIL;

   215

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

   216

			}

   217

   218

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

   219

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

   220

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

   221

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

   222

			}

   223

		}

   224

   225

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

   226

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

   227

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

   228

		}

   229

   230

		/* check the vehicle length (callback) */

   231

		uint16 veh_len = CALLBACK_FAILED;

   232

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

   233

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

   234

		}

   235

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

   236

		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

   237

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

   238

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

   239

	}

   240

   241

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

   242

	v->u.rail.cached_max_speed = max_speed;

   243

   244

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

   245

	TrainCargoChanged(v);

   246

}

   247

   248

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

   249

 * be interpreted? */

   250

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

   251

	{7, 1},

   252

	{0, 2},

   253

	{1, 3},

   254

	{2, 4},

   255

	{3, 5},

   256

	{4, 6},

   257

	{5, 7},

   258

	{6, 0},

   259

};

   260

   261

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

   262

	{6, 2},

   263

	{7, 3},

   264

	{0, 4},

   265

	{1, 5},

   266

	{2, 6},

   267

	{3, 7},

   268

	{4, 0},

   269

	{5, 1},

   270

};

   271

   272

enum AccelType {

   273

	AM_ACCEL,

   274

	AM_BRAKE

   275

};

   276

   277

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

   278

{

   279

	const Order* o = &v->current_order;

   280

	StationID sid = GetStationIndex(tile);

   281

   282

	assert(v->type == VEH_TRAIN);

   283

	/* When does a train drive through a station

   284

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

   285

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

   286

		return false;

   287

	}

   288

   289

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

   290

   291

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

   292

		return false;

   293

	}

   294

   295

	return true;

   296

}

   297

   298

/** new acceleration*/

   299

static int GetTrainAcceleration(Vehicle *v, bool mode)

   300

{

   301

	int max_speed = 2000;

   302

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

   303

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

   304

   305

	/*first find the curve speed limit */

   306

	int numcurve = 0;

   307

	int sum = 0;

   308

	int pos = 0;

   309

	int lastpos = -1;

   310

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

   311

		Direction dir = u->direction;

   312

		Direction ndir = u->next->direction;

   313

		int i;

   314

   315

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

   316

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

   317

				curvecount[i]++;

   318

				if (lastpos != -1) {

   319

					numcurve++;

   320

					sum += pos - lastpos;

   321

					if (pos - lastpos == 1) {

   322

						max_speed = 88;

   323

					}

   324

				}

   325

				lastpos = pos;

   326

			}

   327

		}

   328

   329

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

   330

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

   331

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

   332

			max_speed = 61;

   333

		}

   334

	}

   335

   336

	if (numcurve > 0) sum /= numcurve;

   337

   338

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

   339

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

   340

   341

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

   342

			max_speed = 0xFFFF;

   343

		} else if (total > 1) {

   344

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

   345

		}

   346

	}

   347

   348

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

   349

   350

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

   351

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

   352

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

   353

			int delta_v;

   354

   355

			max_speed = 120;

   356

   357

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

   358

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

   359

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

   360

   361

			max_speed = max(max_speed, 25 * station_length);

   362

		}

   363

	}

   364

   365

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

   366

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

   367

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

   368

   369

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

   370

	int incl = 0;

   371

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

   372

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

   373

		num++;

   374

		drag_coeff += 3;

   375

   376

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

   377

   378

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

   379

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

   380

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

   381

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

   382

		}

   383

	}

   384

   385

	v->max_speed = max_speed;

   386

   387

	const int area = 120;

   388

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

   389

	int resistance;

   390

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

   391

		resistance = 13 * mass / 10;

   392

		resistance += 60 * num;

   393

		resistance += friction * mass * speed / 1000;

   394

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

   395

	} else {

   396

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

   397

	}

   398

	resistance += incl;

   399

	resistance *= 4; //[N]

   400

   401

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

   402

	 * actually double the train's power */

   403

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

   404

	int force;

   405

	if (speed > 2) {

   406

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

   407

			case RAILTYPE_RAIL:

   408

			case RAILTYPE_ELECTRIC:

   409

			case RAILTYPE_MONO:

   410

				force = power / speed; //[N]

   411

				force *= 22;

   412

				force /= 10;

   413

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

   414

				break;

   415

   416

			default: NOT_REACHED();

   417

			case RAILTYPE_MAGLEV:

   418

				force = power / 25;

   419

				break;

   420

		}

   421

	} else {

   422

		/* "kickoff" acceleration */

   423

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

   424

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

   425

	}

   426

   427

	if (force <= 0) force = 10000;

   428

   429

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

   430

   431

	if (mode == AM_ACCEL) {

   432

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

   433

	} else {

   434

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

   435

	}

   436

}

   437

   438

static void UpdateTrainAcceleration(Vehicle* v)

   439

{

   440

	assert(IsFrontEngine(v));

   441

   442

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

   443

   444

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

   445

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

   446

	assert(weight != 0);

   447

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

   448

}

   449

   450

int GetTrainImage(const Vehicle* v, Direction direction)

   451

{

   452

	int img = v->spritenum;

   453

	int base;

   454

   455

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

   456

   457

	if (is_custom_sprite(img)) {

   458

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

   459

		if (base != 0) return base;

   460

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

   461

	}

   462

   463

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

   464

   465

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

   466

	return base;

   467

}

   468

   469

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

   470

{

   471

	const RailVehicleInfo *rvi = RailVehInfo(engine);

   472

   473

	int img = rvi->image_index;

   474

	SpriteID image = 0;

   475

   476

	if (is_custom_sprite(img)) {

   477

		image = GetCustomVehicleIcon(engine, DIR_W);

   478

		if (image == 0) {

   479

			img = orig_rail_vehicle_info[engine].image_index;

   480

		} else {

   481

			y += _traininfo_vehicle_pitch;

   482

		}