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

    10

#include "landscape.h"

    11

#include "gui.h"

    12

#include "station_map.h"

    13

#include "tunnel_map.h"

    14

#include "timetable.h"

    15

#include "articulated_vehicles.h"

    16

#include "command_func.h"

    17

#include "pathfind.h"

    18

#include "npf.h"

    19

#include "station.h"

    20

#include "news.h"

    21

#include "engine.h"

    22

#include "player_func.h"

    23

#include "player_base.h"

    24

#include "depot.h"

    25

#include "waypoint.h"

    26

#include "vehicle_gui.h"

    27

#include "train.h"

    28

#include "bridge.h"

    29

#include "newgrf_callbacks.h"

    30

#include "newgrf_engine.h"

    31

#include "newgrf_sound.h"

    32

#include "newgrf_text.h"

    33

#include "direction_func.h"

    34

#include "yapf/yapf.h"

    35

#include "cargotype.h"

    36

#include "group.h"

    37

#include "table/sprites.h"

    38

#include "tunnelbridge_map.h"

    39

#include "strings_func.h"

    40

#include "functions.h"

    41

#include "window_func.h"

    42

#include "date_func.h"

    43

#include "vehicle_func.h"

    44

#include "sound_func.h"

    45

#include "signal_func.h"

    46

#include "variables.h"

    47

#include "autoreplace_gui.h"

    48

#include "gfx_func.h"

    49

#include "settings_type.h"

    50

    51

#include "table/strings.h"

    52

#include "table/train_cmd.h"

    53

    54

static bool TrainCheckIfLineEnds(Vehicle *v);

    55

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

    56

static TileIndex TrainApproachingCrossingTile(const Vehicle *v);

    57

    58

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

    59

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

    60

    61

    62

/**

    63

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

    64

 *

    65

 * @param direction vehicle direction

    66

 * @param track vehicle track bits

    67

 * @return side of tile the train will leave

    68

 */

    69

static inline DiagDirection TrainExitDir(Direction direction, TrackBits track)

    70

{

    71

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

    72

    73

	DiagDirection diagdir = DirToDiagDir(direction);

    74

    75

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

    76

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

    77

		diagdir = ChangeDiagDir(diagdir, DIAGDIRDIFF_90LEFT);

    78

	}

    79

    80

	return diagdir;

    81

}

    82

    83

    84

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

    85

 * @param cargo Cargo type to get multiplier for

    86

 * @return Cargo weight multiplier

    87

 */

    88

byte FreightWagonMult(CargoID cargo)

    89

{

    90

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

    91

	return _patches.freight_trains;

    92

}

    93

    94

    95

/**

    96

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

    97

 * @param v First vehicle of the consist.

    98

 */

    99

void TrainPowerChanged(Vehicle* v)

   100

{

   101

	uint32 total_power = 0;

   102

	uint32 max_te = 0;

   103

   104

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

   105

		/* Power is not added for articulated parts */

   106

		if (IsArticulatedPart(u)) continue;

   107

   108

		RailType railtype = GetRailType(u->tile);

   109

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

   110

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

   111

   112

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

   113

   114

		if (engine_has_power) {

   115

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

   116

			if (power != 0) {

   117

				total_power += power;

   118

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

   119

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

   120

			}

   121

		}

   122

   123

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

   124

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

   125

		}

   126

	}

   127

   128

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

   129

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

   130

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

   131

   132

		v->u.rail.cached_power = total_power;

   133

		v->u.rail.cached_max_te = max_te;

   134

		InvalidateWindow(WC_VEHICLE_DETAILS, v->index);

   135

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

   136

	}

   137

}

   138

   139

   140

/**

   141

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

   142

 * the consist changes.

   143

 * @param v First vehicle of the consist.

   144

 */

   145

static void TrainCargoChanged(Vehicle* v)

   146

{

   147

	uint32 weight = 0;

   148

   149

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

   150

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

   151

   152

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

   153

		if (!IsArticulatedPart(u)) {

   154

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

   155

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

   156

   157

			/* powered wagons have extra weight added */

   158

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

   159

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

   160

		}

   161

   162

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

   163

		weight += vweight;

   164

   165

		/* store vehicle weight in cache */

   166

		u->u.rail.cached_veh_weight = vweight;

   167

	}

   168

   169

	/* store consist weight in cache */

   170

	v->u.rail.cached_weight = weight;

   171

   172

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

   173

	TrainPowerChanged(v);

   174

}

   175

   176

   177

/**

   178

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

   179

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

   180

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

   181

 * @param v First vehicle of the chain.

   182

 */

   183

void TrainConsistChanged(Vehicle* v)

   184

{

   185

	uint16 max_speed = 0xFFFF;

   186

   187

	assert(v->type == VEH_TRAIN);

   188

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

   189

   190

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

   191

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

   192

	v->u.rail.cached_total_length = 0;

   193

	v->u.rail.compatible_railtypes = RAILTYPES_NONE;

   194

   195

	bool train_can_tilt = true;

   196

   197

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

   198

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

   199

   200

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

   201

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

   202

   203

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

   204

   205

		/* update the 'first engine' */

   206

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

   207

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

   208

   209

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

   210

   211

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

   212

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

   213

   214

		/* Reset color map */

   215

		u->colormap = PAL_NONE;

   216

   217

		if (rvi_u->visual_effect != 0) {

   218

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

   219

		} else {

   220

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

   221

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

   222

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

   223

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

   224

				/* Steam is offset by -4 units */

   225

				u->u.rail.cached_vis_effect = 4;

   226

			} else {

   227

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

   228

				u->u.rail.cached_vis_effect = 8;

   229

			}

   230

		}

   231

   232

		if (!IsArticulatedPart(u)) {

   233

			/* Check powered wagon / visual effect callback */

   234

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

   235

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

   236

   237

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

   238

			}

   239

   240

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

   241

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

   242

				/* wagon is powered */

   243

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

   244

			} else {

   245

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

   246

			}

   247

   248

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

   249

			   have railtype normal */

   250

			if (rvi_u->power > 0) {

   251

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

   252

			}

   253

   254

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

   255

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

   256

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

   257

				u->u.rail.railtype = RAILTYPE_RAIL;

   258

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

   259

			}

   260

   261

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

   262

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

   263

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

   264

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

   265

			}

   266

		}

   267

   268

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

   269

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

   270

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

   271

		}

   272

   273

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

   274

   275

		/* check the vehicle length (callback) */

   276

		uint16 veh_len = CALLBACK_FAILED;

   277

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

   278

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

   279

		}

   280

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

   281

		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

   282

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

   283

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

   284

	}

   285

   286

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

   287

	v->u.rail.cached_max_speed = max_speed;

   288

	v->u.rail.cached_tilt = train_can_tilt;

   289

   290

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

   291

	TrainCargoChanged(v);

   292

}

   293

   294

enum AccelType {

   295

	AM_ACCEL,

   296

	AM_BRAKE

   297

};

   298

   299

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

   300

{

   301

	const Order* o = &v->current_order;

   302

	StationID sid = GetStationIndex(tile);

   303

   304

	assert(v->type == VEH_TRAIN);

   305

	/* When does a train drive through a station

   306

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

   307

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

   308

		return false;

   309

	}

   310

   311

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

   312

   313

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

   314

		return false;

   315

	}

   316

   317

	return true;

   318

}

   319

   320

/** new acceleration*/

   321

static int GetTrainAcceleration(Vehicle *v, bool mode)

   322

{

   323

	static const int absolute_max_speed = 2000;

   324

	int max_speed = absolute_max_speed;

   325

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

   326

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

   327

   328

	/*first find the curve speed limit */

   329

	int numcurve = 0;

   330

	int sum = 0;

   331

	int pos = 0;

   332

	int lastpos = -1;

   333

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

   334

		Direction this_dir = u->direction;

   335

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

   336

   337

		DirDiff dirdiff = DirDifference(this_dir, next_dir);

   338

		if (dirdiff == DIRDIFF_SAME) continue;

   339

   340

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

   341

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

   342

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

   343

			if (lastpos != -1) {

   344

				numcurve++;

   345

				sum += pos - lastpos;

   346

				if (pos - lastpos == 1) {

   347

					max_speed = 88;

   348

				}

   349

			}

   350

			lastpos = pos;

   351

		}

   352

   353

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

   354

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

   355

			max_speed = 61;

   356

		}

   357

	}

   358

   359

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

   360

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

   361

   362

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

   363

			max_speed = absolute_max_speed;

   364

		} else if (total > 1) {

   365

			if (numcurve > 0) sum /= numcurve;

   366

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

   367

		}

   368

	}

   369

   370

	if (max_speed != absolute_max_speed) {

   371

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

   372

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

   373

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

   374

   375

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

   376

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

   377

			max_speed += max_speed / 5;

   378

		}

   379

	}

   380

   381

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

   382

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

   383

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

   384

   385

			int st_max_speed = 120;

   386

   387

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

   388

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

   389

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

   390

			}

   391

   392

			st_max_speed = max(st_max_speed, 25 * station_length);

   393

			max_speed = min(max_speed, st_max_speed);

   394

		}

   395

	}

   396

   397

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

   398

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

   399

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

   400

   401

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

   402

	int incl = 0;

   403

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

   404

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

   405

		num++;

   406

		drag_coeff += 3;

   407

   408

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

   409

   410

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

   411

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

   412

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

   413

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

   414

		}

   415

	}

   416

   417

	v->max_speed = max_speed;

   418

   419

	const int area = 120;

   420

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

   421

	int resistance;

   422

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

   423

		resistance = 13 * mass / 10;

   424

		resistance += 60 * num;

   425

		resistance += friction * mass * speed / 1000;

   426

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

   427

	} else {

   428

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

   429

	}

   430

	resistance += incl;

   431

	resistance *= 4; //[N]

   432

   433

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

   434

	 * actually double the train's power */

   435

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

   436

	int force;

   437

	if (speed > 2) {

   438

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

   439

			case RAILTYPE_RAIL:

   440

			case RAILTYPE_ELECTRIC:

   441

			case RAILTYPE_MONO:

   442

				force = power / speed; //[N]

   443

				force *= 22;

   444

				force /= 10;

   445

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

   446

				break;

   447

   448

			default: NOT_REACHED();

   449

			case RAILTYPE_MAGLEV:

   450

				force = power / 25;

   451

				break;

   452

		}

   453

	} else {

   454

		/* "kickoff" acceleration */

   455

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

   456

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

   457

	}

   458

   459

	if (force <= 0) force = 10000;

   460

   461

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

   462

   463

	if (mode == AM_ACCEL) {

   464

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

   465

	} else {

   466

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

   467

	}

   468

}

   469

   470

static void UpdateTrainAcceleration(Vehicle* v)

   471

{

   472

	assert(IsFrontEngine(v));

   473

   474

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

   475

   476

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

   477

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

   478

	assert(weight != 0);

   479

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