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

    57

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

    58

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

    59

    60

    61

/**

    62

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

    63

 *

    64

 * @param direction vehicle direction

    65

 * @param track vehicle track bits

    66

 * @return side of tile the train will leave

    67

 */

    68

static inline DiagDirection TrainExitDir(Direction direction, TrackBits track)

    69

{

    70

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

    71

    72

	DiagDirection diagdir = DirToDiagDir(direction);

    73

    74

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

    75

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

    76

		diagdir = ChangeDiagDir(diagdir, DIAGDIRDIFF_90LEFT);

    77

	}

    78

    79

	return diagdir;

    80

}

    81

    82

    83

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

    84

 * @param cargo Cargo type to get multiplier for

    85

 * @return Cargo weight multiplier

    86

 */

    87

byte FreightWagonMult(CargoID cargo)

    88

{

    89

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

    90

	return _patches.freight_trains;

    91

}

    92

    93

    94

/**

    95

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

    96

 * @param v First vehicle of the consist.

    97

 */

    98

void TrainPowerChanged(Vehicle* v)

    99

{

   100

	uint32 total_power = 0;

   101

	uint32 max_te = 0;

   102

   103

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

   104

		/* Power is not added for articulated parts */

   105

		if (IsArticulatedPart(u)) continue;

   106

   107

		RailType railtype = GetRailType(u->tile);

   108

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

   109

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

   110

   111

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

   112

   113

		if (engine_has_power) {

   114

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

   115

			if (power != 0) {

   116

				total_power += power;

   117

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

   118

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

   119

			}

   120

		}

   121

   122

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

   123

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

   124

		}

   125

	}

   126

   127

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

   128

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

   129

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

   130

   131

		v->u.rail.cached_power = total_power;

   132

		v->u.rail.cached_max_te = max_te;

   133

		InvalidateWindow(WC_VEHICLE_DETAILS, v->index);

   134

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

   135

	}

   136

}

   137

   138

   139

/**

   140

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

   141

 * the consist changes.

   142

 * @param v First vehicle of the consist.

   143

 */

   144

static void TrainCargoChanged(Vehicle* v)

   145

{

   146

	uint32 weight = 0;

   147

   148

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

   149

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

   150

   151

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

   152

		if (!IsArticulatedPart(u)) {

   153

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

   154

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

   155

   156

			/* powered wagons have extra weight added */

   157

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

   158

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

   159

		}

   160

   161

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

   162

		weight += vweight;

   163

   164

		/* store vehicle weight in cache */

   165

		u->u.rail.cached_veh_weight = vweight;

   166

	}

   167

   168

	/* store consist weight in cache */

   169

	v->u.rail.cached_weight = weight;

   170

   171

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

   172

	TrainPowerChanged(v);

   173

}

   174

   175

   176

/**

   177

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

   178

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

   179

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

   180

 * @param v First vehicle of the chain.

   181

 */

   182

void TrainConsistChanged(Vehicle* v)

   183

{

   184

	uint16 max_speed = 0xFFFF;

   185

   186

	assert(v->type == VEH_TRAIN);

   187

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

   188

   189

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

   190

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

   191

	v->u.rail.cached_total_length = 0;

   192

	v->u.rail.compatible_railtypes = RAILTYPES_NONE;

   193

   194

	bool train_can_tilt = true;

   195

   196

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

   197

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

   198

   199

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

   200

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

   201

   202

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

   203

   204

		/* update the 'first engine' */

   205

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

   206

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

   207

   208

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

   209

   210

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

   211

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

   212

   213

		/* Reset color map */

   214

		u->colormap = PAL_NONE;

   215

   216

		if (rvi_u->visual_effect != 0) {

   217

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

   218

		} else {

   219

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

   220

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

   221

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

   222

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

   223

				/* Steam is offset by -4 units */

   224

				u->u.rail.cached_vis_effect = 4;

   225

			} else {

   226

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

   227

				u->u.rail.cached_vis_effect = 8;

   228

			}

   229

		}

   230

   231

		if (!IsArticulatedPart(u)) {

   232

			/* Check powered wagon / visual effect callback */

   233

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

   234

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

   235

   236

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

   237

			}

   238

   239

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

   240

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

   241

				/* wagon is powered */

   242

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

   243

			} else {

   244

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

   245

			}

   246

   247

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

   248

			   have railtype normal */

   249

			if (rvi_u->power > 0) {

   250

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

   251

			}

   252

   253

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

   254

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

   255

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

   256

				u->u.rail.railtype = RAILTYPE_RAIL;

   257

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

   258

			}

   259

   260

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

   261

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

   262

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

   263

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

   264

			}

   265

		}

   266

   267

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

   268

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

   269

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

   270

		}

   271

   272

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

   273

   274

		/* check the vehicle length (callback) */

   275

		uint16 veh_len = CALLBACK_FAILED;

   276

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

   277

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

   278

		}

   279

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

   280

		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

   281

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

   282

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

   283

	}

   284

   285

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

   286

	v->u.rail.cached_max_speed = max_speed;

   287

	v->u.rail.cached_tilt = train_can_tilt;

   288

   289

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

   290

	TrainCargoChanged(v);

   291

}

   292

   293

enum AccelType {

   294

	AM_ACCEL,

   295

	AM_BRAKE

   296

};

   297

   298

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

   299

{

   300

	const Order* o = &v->current_order;

   301

	StationID sid = GetStationIndex(tile);

   302

   303

	assert(v->type == VEH_TRAIN);

   304

	/* When does a train drive through a station

   305

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

   306

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

   307

		return false;

   308

	}

   309

   310

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

   311

   312

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

   313

		return false;

   314

	}

   315

   316

	return true;

   317

}

   318

   319

/** new acceleration*/

   320

static int GetTrainAcceleration(Vehicle *v, bool mode)

   321

{

   322

	static const int absolute_max_speed = 2000;

   323

	int max_speed = absolute_max_speed;

   324

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

   325

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

   326

   327

	/*first find the curve speed limit */

   328

	int numcurve = 0;

   329

	int sum = 0;

   330

	int pos = 0;

   331

	int lastpos = -1;

   332

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

   333

		Direction this_dir = u->direction;

   334

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

   335

   336

		DirDiff dirdiff = DirDifference(this_dir, next_dir);

   337

		if (dirdiff == DIRDIFF_SAME) continue;

   338

   339

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

   340

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

   341

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

   342

			if (lastpos != -1) {

   343

				numcurve++;

   344

				sum += pos - lastpos;

   345

				if (pos - lastpos == 1) {

   346

					max_speed = 88;

   347

				}

   348

			}

   349

			lastpos = pos;

   350

		}

   351

   352

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

   353

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

   354

			max_speed = 61;

   355

		}

   356

	}

   357

   358

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

   359

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

   360

   361

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

   362

			max_speed = absolute_max_speed;

   363

		} else if (total > 1) {

   364

			if (numcurve > 0) sum /= numcurve;

   365

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

   366

		}

   367

	}

   368

   369

	if (max_speed != absolute_max_speed) {

   370

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

   371

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

   372

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

   373

   374

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

   375

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

   376

			max_speed += max_speed / 5;

   377

		}

   378

	}

   379

   380

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

   381

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

   382

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

   383

   384

			int st_max_speed = 120;

   385

   386

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

   387

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

   388

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

   389

			}

   390

   391

			st_max_speed = max(st_max_speed, 25 * station_length);

   392

			max_speed = min(max_speed, st_max_speed);

   393

		}

   394

	}

   395

   396

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

   397

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

   398

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

   399

   400

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

   401

	int incl = 0;

   402

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

   403

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

   404

		num++;

   405

		drag_coeff += 3;

   406

   407

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

   408

   409

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

   410

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

   411

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

   412

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

   413

		}

   414

	}

   415

   416

	v->max_speed = max_speed;

   417

   418

	const int area = 120;

   419

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

   420

	int resistance;

   421

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

   422

		resistance = 13 * mass / 10;

   423

		resistance += 60 * num;

   424

		resistance += friction * mass * speed / 1000;

   425

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

   426

	} else {

   427

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

   428

	}

   429

	resistance += incl;

   430

	resistance *= 4; //[N]

   431

   432

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

   433

	 * actually double the train's power */

   434

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

   435

	int force;

   436

	if (speed > 2) {

   437

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

   438

			case RAILTYPE_RAIL:

   439

			case RAILTYPE_ELECTRIC:

   440

			case RAILTYPE_MONO:

   441

				force = power / speed; //[N]

   442

				force *= 22;

   443

				force /= 10;

   444

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

   445

				break;

   446

   447

			default: NOT_REACHED();

   448

			case RAILTYPE_MAGLEV:

   449

				force = power / 25;

   450

				break;

   451

		}

   452

	} else {

   453

		/* "kickoff" acceleration */

   454

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

   455

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

   456

	}

   457

   458

	if (force <= 0) force = 10000;

   459

   460

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

   461

   462

	if (mode == AM_ACCEL) {

   463

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

   464

	} else {

   465

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

   466

	}

   467

}

   468

   469

static void UpdateTrainAcceleration(Vehicle* v)

   470

{

   471

	assert(IsFrontEngine(v));

   472

   473

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

   474

   475

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

   476

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

   477

	assert(weight != 0);

   478

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

   479

}