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 "ai/ai.h"

    51

#include "settings_type.h"

    52

#include "order_func.h"

    53

#include "newgrf_station.h"

    54

#include "effectvehicle_func.h"

    55

    56

#include "table/strings.h"

    57

#include "table/train_cmd.h"

    58

    59

static bool TrainCheckIfLineEnds(Vehicle *v);

    60

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

    61

static TileIndex TrainApproachingCrossingTile(const Vehicle *v);

    62

    63

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

    64

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

    65

    66

    67

/**

    68

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

    69

 *

    70

 * @param direction vehicle direction

    71

 * @param track vehicle track bits

    72

 * @return side of tile the train will leave

    73

 */

    74

static inline DiagDirection TrainExitDir(Direction direction, TrackBits track)

    75

{

    76

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

    77

    78

	DiagDirection diagdir = DirToDiagDir(direction);

    79

    80

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

    81

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

    82

		diagdir = ChangeDiagDir(diagdir, DIAGDIRDIFF_90LEFT);

    83

	}

    84

    85

	return diagdir;

    86

}

    87

    88

    89

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

    90

 * @param cargo Cargo type to get multiplier for

    91

 * @return Cargo weight multiplier

    92

 */

    93

byte FreightWagonMult(CargoID cargo)

    94

{

    95

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

    96

	return _settings_game.vehicle.freight_trains;

    97

}

    98

    99

   100

/**

   101

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

   102

 * @param v First vehicle of the consist.

   103

 */

   104

void TrainPowerChanged(Vehicle *v)

   105

{

   106

	uint32 total_power = 0;

   107

	uint32 max_te = 0;

   108

   109

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

   110

		/* Power is not added for articulated parts */

   111

		if (IsArticulatedPart(u)) continue;

   112

   113

		RailType railtype = GetRailType(u->tile);

   114

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

   115

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

   116

   117

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

   118

   119

		if (engine_has_power) {

   120

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

   121

			if (power != 0) {

   122

				/* Halve power for multiheaded parts */

   123

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

   124

   125

				total_power += power;

   126

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

   127

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

   128

			}

   129

		}

   130

   131

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

   132

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

   133

		}

   134

	}

   135

   136

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

   137

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

   138

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

   139

   140

		v->u.rail.cached_power = total_power;

   141

		v->u.rail.cached_max_te = max_te;

   142

		InvalidateWindow(WC_VEHICLE_DETAILS, v->index);

   143

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

   144

	}

   145

}

   146

   147

   148

/**

   149

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

   150

 * the consist changes.

   151

 * @param v First vehicle of the consist.

   152

 */

   153

static void TrainCargoChanged(Vehicle *v)

   154

{

   155

	uint32 weight = 0;

   156

   157

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

   158

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

   159

   160

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

   161

		if (!IsArticulatedPart(u)) {

   162

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

   163

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

   164

   165

			/* powered wagons have extra weight added */

   166

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

   167

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

   168

		}

   169

   170

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

   171

		weight += vweight;

   172

   173

		/* store vehicle weight in cache */

   174

		u->u.rail.cached_veh_weight = vweight;

   175

	}

   176

   177

	/* store consist weight in cache */

   178

	v->u.rail.cached_weight = weight;

   179

   180

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

   181

	TrainPowerChanged(v);

   182

}

   183

   184

   185

/**

   186

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

   187

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

   188

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

   189

 * @param v First vehicle of the chain.

   190

 */

   191

void TrainConsistChanged(Vehicle *v)

   192

{

   193

	uint16 max_speed = UINT16_MAX;

   194

   195

	assert(v->type == VEH_TRAIN);

   196

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

   197

   198

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

   199

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

   200

	v->u.rail.cached_total_length = 0;

   201

	v->u.rail.compatible_railtypes = RAILTYPES_NONE;

   202

   203

	bool train_can_tilt = true;

   204

   205

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

   206

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

   207

   208

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

   209

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

   210

   211

		/* update the 'first engine' */

   212

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

   213

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

   214

   217

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

   218

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

   219

	}

   220

   221

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

   222

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

   223

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

   224

	}

   225

   226

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

   227

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

   228

   229

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

   230

   231

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

   232

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

   233

   234

		/* Reset color map */

   235

		u->colormap = PAL_NONE;

   236

   237

		if (rvi_u->visual_effect != 0) {

   238

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

   239

		} else {

   240

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

   241

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

   242

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

   243

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

   244

				/* Steam is offset by -4 units */

   245

				u->u.rail.cached_vis_effect = 4;

   246

			} else {

   247

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

   248

				u->u.rail.cached_vis_effect = 8;

   249

			}

   250

		}

   251

   252

		if (!IsArticulatedPart(u)) {

   253

			/* Check powered wagon / visual effect callback */

   254

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

   255

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

   256

   257

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

   258

			}

   259

   260

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

   261

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

   262

				/* wagon is powered */

   263

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

   264

			} else {

   265

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

   266

			}

   267

   268

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

   269

			   have railtype normal */

   270

			if (rvi_u->power > 0) {

   271

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

   272

			}

   273

   274

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

   275

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

   276

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

   277

				u->u.rail.railtype = RAILTYPE_RAIL;

   278

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

   279

			}

   280

   281

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

   282

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

   283

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

   284

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

   285

			}

   286

		}

   287

   288

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

   289

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

   290

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

   291

		}

   292

   293

		/* check the vehicle length (callback) */

   294

		uint16 veh_len = CALLBACK_FAILED;

   295

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

   296

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

   297

		}

   298

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

   299

		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

   300

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

   301

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

   302

	}

   303

   304

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

   305

	v->u.rail.cached_max_speed = max_speed;

   306

	v->u.rail.cached_tilt = train_can_tilt;

   307

   308

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

   309

	TrainCargoChanged(v);

   310

   311

	if (IsFrontEngine(v)) {

   312

		UpdateTrainAcceleration(v);

   313

		InvalidateWindow(WC_VEHICLE_DETAILS, v->index);

   314

	}

   315

}

   316

   317

enum AccelType {

   318

	AM_ACCEL,

   319

	AM_BRAKE

   320

};

   321

   322

/** new acceleration*/

   323

static int GetTrainAcceleration(Vehicle *v, bool mode)

   324

{

   325

	static const int absolute_max_speed = UINT16_MAX;

   326

	int max_speed = absolute_max_speed;

   327

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

   328

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

   329

   330

	/*first find the curve speed limit */

   331

	int numcurve = 0;

   332

	int sum = 0;

   333

	int pos = 0;

   334

	int lastpos = -1;

   335

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

   336

		Direction this_dir = u->direction;

   337

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

   338

   339

		DirDiff dirdiff = DirDifference(this_dir, next_dir);

   340

		if (dirdiff == DIRDIFF_SAME) continue;

   341

   342

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

   343

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

   344

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

   345

			if (lastpos != -1) {

   346

				numcurve++;

   347

				sum += pos - lastpos;

   348

				if (pos - lastpos == 1) {

   349

					max_speed = 88;

   350

				}

   351

			}

   352

			lastpos = pos;

   353

		}

   354

   355

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

   356

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

   357

			max_speed = 61;

   358

		}

   359

	}

   360

   361

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

   362

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

   363

   364

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

   365

			max_speed = absolute_max_speed;

   366

		} else if (total > 1) {

   367

			if (numcurve > 0) sum /= numcurve;

   368

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

   369

		}

   370

	}

   371

   372

	if (max_speed != absolute_max_speed) {

   373

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

   374

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

   375

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

   376

   377

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

   378

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

   379

			max_speed += max_speed / 5;

   380

		}

   381

	}

   382

   383

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

   384

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

   385

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

   386

   387

			int st_max_speed = 120;

   388

   389

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

   390

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

   391

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

   392

			}

   393

   394

			st_max_speed = max(st_max_speed, 25 * station_length);

   395

			max_speed = min(max_speed, st_max_speed);

   396

		}

   397

	}

   398

   399

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

   400

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

   401

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

   402

   403

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

   404

	int incl = 0;

   405

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

   406

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

   407

		num++;

   408

		drag_coeff += 3;

   409

   410

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

   411

   412

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

   413

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

   414

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

   415

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

   416

		}

   417

	}

   418

   419

	v->max_speed = max_speed;

   420

   421

	const int area = 120;

   422

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

   423

	int resistance;

   424

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

   425

		resistance = 13 * mass / 10;

   426

		resistance += 60 * num;

   427

		resistance += friction * mass * speed / 1000;

   428

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

   429

	} else {

   430

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

   431

	}

   432

	resistance += incl;

   433

	resistance *= 4; //[N]

   434

   435

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

   436

	 * actually double the train's power */

   437

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

   438

	int force;

   439

	if (speed > 2) {

   440

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

   441

			case RAILTYPE_RAIL:

   442

			case RAILTYPE_ELECTRIC:

   443

			case RAILTYPE_MONO:

   444

				force = power / speed; //[N]

   445

				force *= 22;

   446

				force /= 10;

   447

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

   448

				break;

   449

   450

			default: NOT_REACHED();

   451

			case RAILTYPE_MAGLEV:

   452

				force = power / 25;

   453

				break;

   454

		}

   455

	} else {

   456

		/* "kickoff" acceleration */

   457

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

   458

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

   459

	}

   460

   461

	if (force <= 0) force = 10000;

   462

   463

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

   464

   465

	if (mode == AM_ACCEL) {

   466

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

   467

	} else {

   468

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

   469

	}

   470

}

   471

   472

void UpdateTrainAcceleration(Vehicle *v)

   473

{

   474

	assert(IsFrontEngine(v));

   475

   476

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

   477

   478

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

   479

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

   480