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

    19

#include "pathfind.h"

    20

#include "npf.h"

    21

#include "station.h"

    22

#include "table/train_cmd.h"

    23

#include "news.h"

    24

#include "engine.h"

    25

#include "player.h"

    26

#include "sound.h"

    27

#include "depot.h"

    28

#include "waypoint.h"

    29

#include "vehicle_gui.h"

    30

#include "train.h"

    31

#include "bridge.h"

    32

#include "newgrf_callbacks.h"

    33

#include "newgrf_engine.h"

    34

#include "newgrf_sound.h"

    35

#include "newgrf_text.h"

    36

#include "direction.h"

    37

#include "yapf/yapf.h"

    38

#include "date.h"

    39

#include "cargotype.h"

    40

    41

static bool TrainCheckIfLineEnds(Vehicle *v);

    42

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

    43

    44

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

    45

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

    46

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

    47

    48

    49

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

    50

 * @param cargo Cargo type to get multiplier for

    51

 * @return Cargo weight multiplier

    52

 */

    53

byte FreightWagonMult(CargoID cargo)

    54

{

    55

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

    56

	return _patches.freight_trains;

    57

}

    58

    59

    60

/**

    61

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

    62

 * @param v First vehicle of the consist.

    63

 */

    64

void TrainPowerChanged(Vehicle* v)

    65

{

    66

	uint32 total_power = 0;

    67

	uint32 max_te = 0;

    68

    69

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

    70

		/* Power is not added for articulated parts */

    71

		if (IsArticulatedPart(u)) continue;

    72

    73

		RailType railtype = GetRailType(u->tile);

    74

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

    75

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

    76

    77

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

    78

    79

		if (engine_has_power) {

    80

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

    81

			if (power != 0) {

    82

				total_power += power;

    83

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

    84

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

    85

			}

    86

		}

    87

    88

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

    89

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

    90

		}

    91

	}

    92

    93

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

    94

		v->u.rail.cached_power = total_power;

    95

		v->u.rail.cached_max_te = max_te;

    96

		InvalidateWindow(WC_VEHICLE_DETAILS, v->index);

    97

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

    98

	}

    99

}

   100

   101

   102

/**

   103

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

   104

 * the consist changes.

   105

 * @param v First vehicle of the consist.

   106

 */

   107

static void TrainCargoChanged(Vehicle* v)

   108

{

   109

	uint32 weight = 0;

   110

   111

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

   112

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

   113

   114

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

   115

		if (!IsArticulatedPart(u)) {

   116

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

   117

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

   118

   119

			/* powered wagons have extra weight added */

   120

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

   121

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

   122

		}

   123

   124

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

   125

		weight += vweight;

   126

   127

		/* store vehicle weight in cache */

   128

		u->u.rail.cached_veh_weight = vweight;

   129

	}

   130

   131

	/* store consist weight in cache */

   132

	v->u.rail.cached_weight = weight;

   133

   134

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

   135

	TrainPowerChanged(v);

   136

}

   137

   138

   139

/**

   140

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

   141

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

   142

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

   143

 * @param v First vehicle of the chain.

   144

 */

   145

void TrainConsistChanged(Vehicle* v)

   146

{

   147

	uint16 max_speed = 0xFFFF;

   148

   149

	assert(v->type == VEH_TRAIN);

   150

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

   151

   152

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

   153

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

   154

	v->u.rail.cached_total_length = 0;

   155

	v->u.rail.compatible_railtypes = 0;

   156

   157

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

   158

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

   159

   160

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

   161

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

   162

   163

		/* update the 'first engine' */

   164

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

   165

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

   166

   167

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

   168

   169

		if (rvi_u->visual_effect != 0) {

   170

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

   171

		} else {

   172

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

   173

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

   174

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

   175

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

   176

				/* Steam is offset by -4 units */

   177

				u->u.rail.cached_vis_effect = 4;

   178

			} else {

   179

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

   180

				u->u.rail.cached_vis_effect = 8;

   181

			}

   182

		}

   183

   184

		if (!IsArticulatedPart(u)) {

   185

			/* Check powered wagon / visual effect callback */

   186

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

   187

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

   188

   189

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

   190

			}

   191

   192

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

   193

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

   194

				/* wagon is powered */

   195

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

   196

			} else {

   197

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

   198

			}

   199

   200

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

   201

			   have railtype normal */

   202

			if (rvi_u->power > 0) {

   203

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

   204

			}

   205

   206

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

   207

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

   208

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

   209

				u->u.rail.railtype = RAILTYPE_RAIL;

   210

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

   211

			}

   212

   213

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

   214

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

   215

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

   216

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

   217

			}

   218

		}

   219

   220

		/* check the vehicle length (callback) */

   221

		uint16 veh_len = CALLBACK_FAILED;

   222

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

   223

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

   224

		}

   225

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

   226

		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

   227

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

   228

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

   229

	}

   230

   231

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

   232

	v->u.rail.cached_max_speed = max_speed;

   233

   234

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

   235

	TrainCargoChanged(v);

   236

}

   237

   238

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

   239

 * be interpreted? */

   240

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

   241

	{7, 1},

   242

	{0, 2},

   243

	{1, 3},

   244

	{2, 4},

   245

	{3, 5},

   246

	{4, 6},

   247

	{5, 7},

   248

	{6, 0},

   249

};

   250

   251

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

   252

	{6, 2},

   253

	{7, 3},

   254

	{0, 4},

   255

	{1, 5},

   256

	{2, 6},

   257

	{3, 7},

   258

	{4, 0},

   259

	{5, 1},

   260

};

   261

   262

enum AccelType {

   263

	AM_ACCEL,

   264

	AM_BRAKE

   265

};

   266

   267

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

   268

{

   269

	const Order* o = &v->current_order;

   270

	StationID sid = GetStationIndex(tile);

   271

   272

	assert(v->type == VEH_TRAIN);

   273

	/* When does a train drive through a station

   274

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

   275

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

   276

		return false;

   277

	}

   278

   279

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

   280

   281

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

   282

		return false;

   283

	}

   284

   285

	return true;

   286

}

   287

   288

/** new acceleration*/

   289

static int GetTrainAcceleration(Vehicle *v, bool mode)

   290

{

   291

	int max_speed = 2000;

   292

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

   293

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

   294

   295

	/*first find the curve speed limit */

   296

	int numcurve = 0;

   297

	int sum = 0;

   298

	int pos = 0;

   299

	int lastpos = -1;

   300

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

   301

		Direction dir = u->direction;

   302

		Direction ndir = u->next->direction;

   303

		int i;

   304

   305

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

   306

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

   307

				curvecount[i]++;

   308

				if (lastpos != -1) {

   309

					numcurve++;

   310

					sum += pos - lastpos;

   311

					if (pos - lastpos == 1) {

   312

						max_speed = 88;

   313

					}

   314

				}

   315

				lastpos = pos;

   316

			}

   317

		}

   318

   319

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

   320

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

   321

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

   322

			max_speed = 61;

   323

		}

   324

	}

   325

   326

	if (numcurve > 0) sum /= numcurve;

   327

   328

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

   329

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

   330

   331

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

   332

			max_speed = 0xFFFF;

   333

		} else if (total > 1) {

   334

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

   335

		}

   336

	}

   337

   338

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

   339

   340

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

   341

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

   342

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

   343

			int delta_v;

   344

   345

			max_speed = 120;

   346

   347

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

   348

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

   349

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

   350

   351

			max_speed = max(max_speed, 25 * station_length);

   352

		}

   353

	}

   354

   355

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

   356

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

   357

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

   358

   359

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

   360

	int incl = 0;

   361

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

   362

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

   363

		num++;

   364

		drag_coeff += 3;

   365

   366

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

   367

   368

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

   369

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

   370

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

   371

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

   372

		}

   373

	}

   374

   375

	v->max_speed = max_speed;

   376

   377

	const int area = 120;

   378

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

   379

	int resistance;

   380

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

   381

		resistance = 13 * mass / 10;

   382

		resistance += 60 * num;

   383

		resistance += friction * mass * speed / 1000;

   384

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

   385

	} else {

   386

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

   387

	}

   388

	resistance += incl;

   389

	resistance *= 4; //[N]

   390

   391

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

   392

	 * actually double the train's power */

   393

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

   394

	int force;

   395

	if (speed > 2) {

   396

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

   397

			case RAILTYPE_RAIL:

   398

			case RAILTYPE_ELECTRIC:

   399

			case RAILTYPE_MONO:

   400

				force = power / speed; //[N]

   401

				force *= 22;

   402

				force /= 10;

   403

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

   404

				break;

   405

   406

			default: NOT_REACHED();

   407

			case RAILTYPE_MAGLEV:

   408

				force = power / 25;

   409

				break;

   410

		}

   411

	} else {

   412

		/* "kickoff" acceleration */

   413

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

   414

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

   415

	}

   416

   417

	if (force <= 0) force = 10000;

   418

   419

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

   420

   421

	if (mode == AM_ACCEL) {

   422

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

   423

	} else {

   424

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

   425

	}

   426

}

   427

   428

static void UpdateTrainAcceleration(Vehicle* v)

   429

{

   430

	assert(IsFrontEngine(v));

   431

   432

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

   433

   434

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

   435

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

   436

	assert(weight != 0);

   437

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

   438

}

   439

   440

int GetTrainImage(const Vehicle* v, Direction direction)

   441

{

   442

	int img = v->spritenum;

   443

	int base;

   444

   445

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

   446

   447

	if (is_custom_sprite(img)) {

   448

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

   449

		if (base != 0) return base;

   450

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

   451

	}

   452

   453

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

   454

   455

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

   456

	return base;

   457

}

   458

   459

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

   460

{

   461

	const RailVehicleInfo *rvi = RailVehInfo(engine);

   462

   463

	int img = rvi->image_index;

   464

	SpriteID image = 0;

   465

   466

	if (is_custom_sprite(img)) {

   467

		image = GetCustomVehicleIcon(engine, DIR_W);

   468

		if (image == 0) {

   469

			img = orig_rail_vehicle_info[engine].image_index;

   470

		} else {

   471

			y += _traininfo_vehicle_pitch;

   472

		}

   473

	}

   474

	if (image == 0) {

   475

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

   476

	}

   477

   478

	if (rvi->railveh_type == RAILVEH_MULTIHEAD) {

   479

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

   480

		x += 15;

   481

		image = 0;

   482

		if (is_custom_sprite(img)) {