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"

    41

    42

static bool TrainCheckIfLineEnds(Vehicle *v);

    43

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

    44

    45

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

    46

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

    47

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

    48

    49

    50

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

    51

 * @param cargo Cargo type to get multiplier for

    52

 * @return Cargo weight multiplier

    53

 */

    54

byte FreightWagonMult(CargoID cargo)

    55

{

    56

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

    57

	return _patches.freight_trains;

    58

}

    59

    60

    61

/**

    62

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

    63

 * @param v First vehicle of the consist.

    64

 */

    65

void TrainPowerChanged(Vehicle* v)

    66

{

    67

	uint32 total_power = 0;

    68

	uint32 max_te = 0;

    69

    70

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

    71

		/* Power is not added for articulated parts */

    72

		if (IsArticulatedPart(u)) continue;

    73

    74

		RailType railtype = GetRailType(u->tile);

    75

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

    76

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

    77

    78

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

    79

    80

		if (engine_has_power) {

    81

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

    82

			if (power != 0) {

    83

				total_power += power;

    84

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

    85

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

    86

			}

    87

		}

    88

    89

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

    90

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

    91

		}

    92

	}

    93

    94

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

    95

		v->u.rail.cached_power = total_power;

    96

		v->u.rail.cached_max_te = max_te;

    97

		InvalidateWindow(WC_VEHICLE_DETAILS, v->index);

    98

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

    99

	}

   100

}

   101

   102

   103

/**

   104

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

   105

 * the consist changes.

   106

 * @param v First vehicle of the consist.

   107

 */

   108

static void TrainCargoChanged(Vehicle* v)

   109

{

   110

	uint32 weight = 0;

   111

   112

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

   113

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

   114

   115

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

   116

		if (!IsArticulatedPart(u)) {

   117

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

   119

   120

			/* powered wagons have extra weight added */

   121

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

   122

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

   123

		}

   124

   125

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

   126

		weight += vweight;

   127

   128

		/* store vehicle weight in cache */

   129

		u->u.rail.cached_veh_weight = vweight;

   130

	}

   131

   132

	/* store consist weight in cache */

   133

	v->u.rail.cached_weight = weight;

   134

   135

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

   136

	TrainPowerChanged(v);

   137

}

   138

   139

   140

/**

   141

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

   142

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

   143

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

   144

 * @param v First vehicle of the chain.

   145

 */

   146

void TrainConsistChanged(Vehicle* v)

   147

{

   148

	uint16 max_speed = 0xFFFF;

   149

   150

	assert(v->type == VEH_TRAIN);

   151

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

   152

   153

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

   154

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

   155

	v->u.rail.cached_total_length = 0;

   156

	v->u.rail.compatible_railtypes = 0;

   157

   158

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

   159

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

   160

   161

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

   162

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

   163

   164

		/* update the 'first engine' */

   165

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

   166

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

   167

   168

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

   169

   173

		if (rvi_u->visual_effect != 0) {

   174

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

   175

		} else {

   176

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

   177

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

   178

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

   179

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

   180

				/* Steam is offset by -4 units */

   181

				u->u.rail.cached_vis_effect = 4;

   182

			} else {

   183

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

   184

				u->u.rail.cached_vis_effect = 8;

   185

			}

   186

		}

   187

   188

		if (!IsArticulatedPart(u)) {

   189

			/* Check powered wagon / visual effect callback */

   190

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

   191

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

   192

   193

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

   194

			}

   195

   196

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

   198

				/* wagon is powered */

   199

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

   200

			} else {

   201

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

   202

			}

   203

   204

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

   205

			   have railtype normal */

   206

			if (rvi_u->power > 0) {

   207

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

   208

			}

   209

   210

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

   211

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

   212

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

   213

				u->u.rail.railtype = RAILTYPE_RAIL;

   214

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

   215

			}

   216

   217

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

   218

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

   219

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

   220

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

   221

			}

   222

		}

   223

   229

		/* check the vehicle length (callback) */

   230

		uint16 veh_len = CALLBACK_FAILED;

   231

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

   232

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

   233

		}

   234

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

   235

		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

   236

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

   237

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

   238

	}

   239

   240

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

   241

	v->u.rail.cached_max_speed = max_speed;

   242

   243

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

   244

	TrainCargoChanged(v);

   245

}

   246

   247

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

   248

 * be interpreted? */

   249

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

   250

	{7, 1},

   251

	{0, 2},

   252

	{1, 3},

   253

	{2, 4},

   254

	{3, 5},

   255

	{4, 6},

   256

	{5, 7},

   257

	{6, 0},

   258

};

   259

   260

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

   261

	{6, 2},

   262

	{7, 3},

   263

	{0, 4},

   264

	{1, 5},

   265

	{2, 6},

   266

	{3, 7},

   267

	{4, 0},

   268

	{5, 1},

   269

};

   270

   271

enum AccelType {

   272

	AM_ACCEL,

   273

	AM_BRAKE

   274

};

   275

   276

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

   277

{

   278

	const Order* o = &v->current_order;

   279

	StationID sid = GetStationIndex(tile);

   280

   281

	assert(v->type == VEH_TRAIN);

   282

	/* When does a train drive through a station

   283

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

   284

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

   285

		return false;

   286

	}

   287

   288

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

   289

   290

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

   291

		return false;

   292

	}

   293

   294

	return true;

   295

}

   296

   297

/** new acceleration*/

   298

static int GetTrainAcceleration(Vehicle *v, bool mode)

   299

{

   300

	int max_speed = 2000;

   301

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

   302

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

   303

   304

	/*first find the curve speed limit */

   305

	int numcurve = 0;

   306

	int sum = 0;

   307

	int pos = 0;

   308

	int lastpos = -1;

   309

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

   310

		Direction dir = u->direction;

   311

		Direction ndir = u->next->direction;

   312

		int i;

   313

   314

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

   315

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

   316

				curvecount[i]++;

   317

				if (lastpos != -1) {

   318

					numcurve++;

   319

					sum += pos - lastpos;

   320

					if (pos - lastpos == 1) {

   321

						max_speed = 88;

   322

					}

   323

				}

   324

				lastpos = pos;

   325

			}

   326

		}

   327

   328

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

   329

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

   330

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

   331

			max_speed = 61;

   332

		}

   333

	}

   334

   335

	if (numcurve > 0) sum /= numcurve;

   336

   337

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

   338

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

   339

   340

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

   341

			max_speed = 0xFFFF;

   342

		} else if (total > 1) {

   343

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

   344

		}

   345

	}

   346

   347

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

   348

   349

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

   350

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

   351

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

   352

			int delta_v;

   353

   354

			max_speed = 120;

   355

   356

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

   357

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

   358

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

   359

   360

			max_speed = max(max_speed, 25 * station_length);

   361

		}

   362

	}

   363

   364

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

   365

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

   366

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

   367

   368

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

   369

	int incl = 0;

   370

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

   371

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

   372

		num++;

   373

		drag_coeff += 3;

   374

   375

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

   376

   377

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

   378

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

   379

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

   380

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

   381

		}

   382

	}

   383

   384

	v->max_speed = max_speed;

   385

   386

	const int area = 120;

   387

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

   388

	int resistance;

   389

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

   390

		resistance = 13 * mass / 10;

   391

		resistance += 60 * num;

   392

		resistance += friction * mass * speed / 1000;

   393

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

   394

	} else {

   395

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

   396

	}

   397

	resistance += incl;

   398

	resistance *= 4; //[N]

   399

   400

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

   401

	 * actually double the train's power */

   402

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

   403

	int force;

   404

	if (speed > 2) {

   405

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

   406

			case RAILTYPE_RAIL:

   407

			case RAILTYPE_ELECTRIC:

   408

			case RAILTYPE_MONO:

   409

				force = power / speed; //[N]

   410

				force *= 22;

   411

				force /= 10;

   412

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

   413

				break;

   414

   415

			default: NOT_REACHED();

   416

			case RAILTYPE_MAGLEV:

   417

				force = power / 25;

   418

				break;

   419

		}

   420

	} else {

   421

		/* "kickoff" acceleration */

   422

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

   423

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

   424

	}

   425

   426

	if (force <= 0) force = 10000;

   427

   428

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

   429

   430

	if (mode == AM_ACCEL) {

   431

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

   432

	} else {

   433

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

   434

	}

   435

}

   436

   437

static void UpdateTrainAcceleration(Vehicle* v)

   438

{

   439

	assert(IsFrontEngine(v));

   440

   441

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

   442

   443

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

   444

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

   445

	assert(weight != 0);

   446

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

   447

}

   448

   449

int GetTrainImage(const Vehicle* v, Direction direction)

   450

{

   451

	int img = v->spritenum;

   452

	int base;

   453

   454

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

   455

   456

	if (is_custom_sprite(img)) {

   457

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

   458

		if (base != 0) return base;

   459

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

   460

	}

   461

   462

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

   463

   464

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

   465

	return base;

   466

}

   467

   468

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

   469

{

   470

	const RailVehicleInfo *rvi = RailVehInfo(engine);

   471

   472

	int img = rvi->image_index;

   473

	SpriteID image = 0;

   474

   475

	if (is_custom_sprite(img)) {

   476

		image = GetCustomVehicleIcon(engine, DIR_W);

   477

		if (image == 0) {

   478

			img = orig_rail_vehicle_info[engine].image_index;

   479

		} else {

   480

			y += _traininfo_vehicle_pitch;

   481

		}

   482

	}