1

/* $Id$ */

     2

     3

/** @file train_cmd.cpp Handling of trains. */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "bridge_map.h"

     8

#include "debug.h"

     9

#include "tile_cmd.h"

    10

#include "landscape.h"

    11

#include "gui.h"

    12

#include "station_map.h"

    13

#include "tunnel_map.h"

    14

#include "articulated_vehicles.h"

    15

#include "command_func.h"

    16

#include "pathfind.h"

    17

#include "npf.h"

    18

#include "station_base.h"

    19

#include "news_func.h"

    20

#include "engine_func.h"

    21

#include "engine_base.h"

    22

#include "player_func.h"

    23

#include "player_base.h"

    24

#include "depot_base.h"

    25

#include "depot_func.h"

    26

#include "waypoint.h"

    27

#include "vehicle_gui.h"

    28

#include "train.h"

    29

#include "bridge.h"

    30

#include "newgrf_callbacks.h"

    31

#include "newgrf_engine.h"

    32

#include "newgrf_sound.h"

    33

#include "newgrf_text.h"

    34

#include "direction_func.h"

    35

#include "yapf/yapf.h"

    36

#include "cargotype.h"

    37

#include "group.h"

    38

#include "table/sprites.h"

    39

#include "tunnelbridge_map.h"

    40

#include "strings_func.h"

    41

#include "functions.h"

    42

#include "window_func.h"

    43

#include "date_func.h"

    44

#include "vehicle_func.h"

    45

#include "sound_func.h"

    46

#include "signal_func.h"

    47

#include "variables.h"

    48

#include "autoreplace_gui.h"

    49

#include "gfx_func.h"

    50

#include "settings_type.h"

    51

#include "order_func.h"

    52

#include "newgrf_station.h"

    53

#include "effectvehicle_func.h"

    54

    55

#include "table/strings.h"

    56

#include "table/train_cmd.h"

    57

    58

static bool TrainCheckIfLineEnds(Vehicle *v);

    59

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

    60

static TileIndex TrainApproachingCrossingTile(const Vehicle *v);

    61

    62

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

    63

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

    64

    65

    66

/**

    67

 * Determine the side in which the train will leave the tile

    68

 *

    69

 * @param direction vehicle direction

    70

 * @param track vehicle track bits

    71

 * @return side of tile the train will leave

    72

 */

    73

static inline DiagDirection TrainExitDir(Direction direction, TrackBits track)

    74

{

    75

	static const TrackBits state_dir_table[DIAGDIR_END] = { TRACK_BIT_RIGHT, TRACK_BIT_LOWER, TRACK_BIT_LEFT, TRACK_BIT_UPPER };

    76

    77

	DiagDirection diagdir = DirToDiagDir(direction);

    78

    79

	/* Determine the diagonal direction in which we will exit this tile */

    80

	if (!HasBit(direction, 0) && track != state_dir_table[diagdir]) {

    81

		diagdir = ChangeDiagDir(diagdir, DIAGDIRDIFF_90LEFT);

    82

	}

    83

    84

	return diagdir;

    85

}

    86

    87

    88

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

    89

 * @param cargo Cargo type to get multiplier for

    90

 * @return Cargo weight multiplier

    91

 */

    92

byte FreightWagonMult(CargoID cargo)

    93

{

    94

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

    95

	return _settings_game.vehicle.freight_trains;

    96

}

    97

    98

    99

/**

   100

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

   101

 * @param v First vehicle of the consist.

   102

 */

   103

void TrainPowerChanged(Vehicle *v)

   104

{

   105

	uint32 total_power = 0;

   106

	uint32 max_te = 0;

   107

   108

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

   109

		/* Power is not added for articulated parts */

   110

		if (IsArticulatedPart(u)) continue;

   111

   112

		RailType railtype = GetRailType(u->tile);

   113

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

   114

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

   115

   116

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

   117

   118

		if (engine_has_power) {

   119

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

   120

			if (power != 0) {

   121

				/* Halve power for multiheaded parts */

   122

				if (IsMultiheaded(u)) power /= 2;

   123

   124

				total_power += power;

   125

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

   126

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

   127

			}

   128

		}

   129

   130

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

   131

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

   132

		}

   133

	}

   134

   135

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

   136

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

   137

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

   138

   139

		v->u.rail.cached_power = total_power;

   140

		v->u.rail.cached_max_te = max_te;

   141

		InvalidateWindow(WC_VEHICLE_DETAILS, v->index);

   142

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

   143

	}

   144

}

   145

   146

   147

/**

   148

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

   149

 * the consist changes.

   150

 * @param v First vehicle of the consist.

   151

 */

   152

static void TrainCargoChanged(Vehicle *v)

   153

{

   154

	uint32 weight = 0;

   155

   156

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

   157

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

   158

   159

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

   160

		if (!IsArticulatedPart(u)) {

   161

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

   162

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

   163

   164

			/* powered wagons have extra weight added */

   165

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

   166

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

   167

		}

   168

   169

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

   170

		weight += vweight;

   171

   172

		/* store vehicle weight in cache */

   173

		u->u.rail.cached_veh_weight = vweight;

   174

	}

   175

   176

	/* store consist weight in cache */

   177

	v->u.rail.cached_weight = weight;

   178

   179

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

   180

	TrainPowerChanged(v);

   181

}

   182

   183

   184

/**

   185

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

   186

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

   187

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

   188

 * @param v First vehicle of the chain.

   189

 */

   190

void TrainConsistChanged(Vehicle *v)

   191

{

   192

	uint16 max_speed = UINT16_MAX;

   193

   194

	assert(v->type == VEH_TRAIN);

   195

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

   196

   197

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

   198

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

   199

	v->u.rail.cached_total_length = 0;

   200

	v->u.rail.compatible_railtypes = RAILTYPES_NONE;

   201

   202

	bool train_can_tilt = true;

   203

   204

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

   205

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

   206

   207

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

   208

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

   209

   210

		/* update the 'first engine' */

   211

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

   212

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

   213

   214

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

   215

   216

		/* Set user defined data to its default value */

   217

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

   218

	}

   219

   220

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

   221

		/* Update user defined data (must be done before other properties) */

   222

		u->u.rail.user_def_data = GetVehicleProperty(u, 0x25, u->u.rail.user_def_data);

   223

	}

   224

   225

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

   226

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

   227

   228

		if (!HasBit(EngInfo(u->engine_type)->misc_flags, EF_RAIL_TILTS)) train_can_tilt = false;

   229

   230

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

   231

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

   232

   233

		/* Reset color map */

   234

		u->colormap = PAL_NONE;

   235

   236

		if (rvi_u->visual_effect != 0) {

   237

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

   238

		} else {

   239

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

   240

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

   241

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

   242

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

   243

				/* Steam is offset by -4 units */

   244

				u->u.rail.cached_vis_effect = 4;

   245

			} else {

   246

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

   247

				u->u.rail.cached_vis_effect = 8;

   248

			}

   249

		}

   250

   251

		if (!IsArticulatedPart(u)) {

   252

			/* Check powered wagon / visual effect callback */

   253

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

   254

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

   255

   256

				if (callback != CALLBACK_FAILED) u->u.rail.cached_vis_effect = GB(callback, 0, 8);

   257

			}

   258

   259

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

   260

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

   261

				/* wagon is powered */

   262

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

   263

			} else {

   264

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

   265

			}

   266

   267

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

   268

			   have railtype normal */

   269

			if (rvi_u->power > 0) {

   270

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

   271

			}

   272

   273

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

   274

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

   275

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

   276

				u->u.rail.railtype = RAILTYPE_RAIL;

   277

				u->u.rail.compatible_railtypes |= RAILTYPES_RAIL;

   278

			}

   279

   280

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

   281

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

   282

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

   283

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

   284

			}

   285

		}

   286

   287

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

   288

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

   289

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

   290

		}

   291

   292

		/* check the vehicle length (callback) */

   293

		uint16 veh_len = CALLBACK_FAILED;

   294

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

   295

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

   296

		}

   297

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

   298

		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

   299

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

   300

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

   301

	}

   302

   303

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

   304

	v->u.rail.cached_max_speed = max_speed;

   305

	v->u.rail.cached_tilt = train_can_tilt;

   306

   307

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

   308

	TrainCargoChanged(v);

   309

   310

	if (IsFrontEngine(v)) {

   311

		UpdateTrainAcceleration(v);

   312

		InvalidateWindow(WC_VEHICLE_DETAILS, v->index);

   313

	}

   314

}

   315

   316

enum AccelType {

   317

	AM_ACCEL,

   318

	AM_BRAKE

   319

};

   320

   321

/** new acceleration*/

   322

static int GetTrainAcceleration(Vehicle *v, bool mode)

   323

{

   324

	static const int absolute_max_speed = UINT16_MAX;

   325

	int max_speed = absolute_max_speed;

   326

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

   327

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

   328

   329

	/*first find the curve speed limit */

   330

	int numcurve = 0;

   331

	int sum = 0;

   332

	int pos = 0;

   333

	int lastpos = -1;

   334

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

   335

		Direction this_dir = u->direction;

   336

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

   337

   338

		DirDiff dirdiff = DirDifference(this_dir, next_dir);

   339

		if (dirdiff == DIRDIFF_SAME) continue;

   340

   341

		if (dirdiff == DIRDIFF_45LEFT) curvecount[0]++;

   342

		if (dirdiff == DIRDIFF_45RIGHT) curvecount[1]++;

   343

		if (dirdiff == DIRDIFF_45LEFT || dirdiff == DIRDIFF_45RIGHT) {

   344

			if (lastpos != -1) {

   345

				numcurve++;

   346

				sum += pos - lastpos;

   347

				if (pos - lastpos == 1) {

   348

					max_speed = 88;

   349

				}

   350

			}

   351

			lastpos = pos;

   352

		}

   353

   354

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

   355

		if (dirdiff == DIRDIFF_90LEFT || dirdiff == DIRDIFF_90RIGHT) {

   356

			max_speed = 61;

   357

		}

   358

	}

   359

   360

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

   361

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

   362

   363

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

   364

			max_speed = absolute_max_speed;

   365

		} else if (total > 1) {

   366

			if (numcurve > 0) sum /= numcurve;

   367

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

   368

		}

   369

	}

   370

   371

	if (max_speed != absolute_max_speed) {

   372

		/* Apply the engine's rail type curve speed advantage, if it slowed by curves */

   373

		const RailtypeInfo *rti = GetRailTypeInfo(v->u.rail.railtype);

   374

		max_speed += (max_speed / 2) * rti->curve_speed;

   375

   376

		if (v->u.rail.cached_tilt) {

   377

			/* Apply max_speed bonus of 20% for a tilting train */

   378

			max_speed += max_speed / 5;

   379

		}

   380

	}

   381

   382

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

   383

		if (v->current_order.ShouldStopAtStation(v, GetStationIndex(v->tile))) {

   384

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

   385

   386

			int st_max_speed = 120;

   387

   388

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

   389

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

   390

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

   391

			}

   392

   393

			st_max_speed = max(st_max_speed, 25 * station_length);

   394

			max_speed = min(max_speed, st_max_speed);

   395

		}

   396

	}

   397

   398

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

   399

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

   400

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

   401

   402

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

   403

	int incl = 0;

   404

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

   405

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

   406

		num++;

   407

		drag_coeff += 3;

   408

   409

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

   410

   411

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

   412

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

   413

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

   414

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

   415

		}

   416

	}

   417

   418

	v->max_speed = max_speed;

   419

   420

	const int area = 120;

   421

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

   422

	int resistance;

   423

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

   424

		resistance = 13 * mass / 10;

   425

		resistance += 60 * num;

   426

		resistance += friction * mass * speed / 1000;

   427

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

   428

	} else {

   429

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

   430

	}

   431

	resistance += incl;

   432

	resistance *= 4; //[N]

   433

   434

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

   435

	 * actually double the train's power */

   436

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

   437

	int force;

   438

	if (speed > 2) {

   439

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

   440

			case RAILTYPE_RAIL:

   441

			case RAILTYPE_ELECTRIC:

   442

			case RAILTYPE_MONO:

   443

				force = power / speed; //[N]

   444

				force *= 22;

   445

				force /= 10;

   446

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

   447

				break;

   448

   449

			default: NOT_REACHED();

   450

			case RAILTYPE_MAGLEV:

   451

				force = power / 25;

   452

				break;

   453

		}

   454

	} else {

   455

		/* "kickoff" acceleration */

   456

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

   457

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

   458

	}

   459

   460

	if (force <= 0) force = 10000;

   461

   462

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

   463

   464

	if (mode == AM_ACCEL) {

   465

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

   466

	} else {

   467

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

   468

	}

   469

}

   470

   471

void UpdateTrainAcceleration(Vehicle *v)

   472

{

   473

	assert(IsFrontEngine(v));

   474

   475

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

   476

   477

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

   478

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

   479

	assert(weight != 0);

   480

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