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

    20

#include "news_func.h"

    21

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

    50

#include "settings_type.h"

    51

#include "order_func.h"

    52

    53

#include "table/strings.h"

    54

#include "table/train_cmd.h"

    55

    56

static bool TrainCheckIfLineEnds(Vehicle *v);

    57

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

    58

static TileIndex TrainApproachingCrossingTile(const Vehicle *v);

    59

    60

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

    61

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

    62

    63

    64

/**

    65

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

    66

 *

    67

 * @param direction vehicle direction

    68

 * @param track vehicle track bits

    69

 * @return side of tile the train will leave

    70

 */

    71

static inline DiagDirection TrainExitDir(Direction direction, TrackBits track)

    72

{

    73

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

    74

    75

	DiagDirection diagdir = DirToDiagDir(direction);

    76

    77

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

    78

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

    79

		diagdir = ChangeDiagDir(diagdir, DIAGDIRDIFF_90LEFT);

    80

	}

    81

    82

	return diagdir;

    83

}

    84

    85

    86

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

    87

 * @param cargo Cargo type to get multiplier for

    88

 * @return Cargo weight multiplier

    89

 */

    90

byte FreightWagonMult(CargoID cargo)

    91

{

    92

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

    93

	return _patches.freight_trains;

    94

}

    95

    96

    97

/**

    98

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

    99

 * @param v First vehicle of the consist.

   100

 */

   101

void TrainPowerChanged(Vehicle* v)

   102

{

   103

	uint32 total_power = 0;

   104

	uint32 max_te = 0;

   105

   106

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

   107

		/* Power is not added for articulated parts */

   108

		if (IsArticulatedPart(u)) continue;

   109

   110

		RailType railtype = GetRailType(u->tile);

   111

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

   112

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

   113

   114

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

   115

   116

		if (engine_has_power) {

   117

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

   118

			if (power != 0) {

   119

				total_power += power;

   120

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

   121

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

   122

			}

   123

		}

   124

   125

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

   126

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

   127

		}

   128

	}

   129

   130

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

   131

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

   132

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

   133

   134

		v->u.rail.cached_power = total_power;

   135

		v->u.rail.cached_max_te = max_te;

   136

		InvalidateWindow(WC_VEHICLE_DETAILS, v->index);

   137

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

   138

	}

   139

}

   140

   141

   142

/**

   143

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

   144

 * the consist changes.

   145

 * @param v First vehicle of the consist.

   146

 */

   147

static void TrainCargoChanged(Vehicle* v)

   148

{

   149

	uint32 weight = 0;

   150

   151

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

   152

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

   153

   154

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

   155

		if (!IsArticulatedPart(u)) {

   156

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

   157

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

   158

   159

			/* powered wagons have extra weight added */

   160

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

   161

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

   162

		}

   163

   164

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

   165

		weight += vweight;

   166

   167

		/* store vehicle weight in cache */

   168

		u->u.rail.cached_veh_weight = vweight;

   169

	}

   170

   171

	/* store consist weight in cache */

   172

	v->u.rail.cached_weight = weight;

   173

   174

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

   175

	TrainPowerChanged(v);

   176

}

   177

   178

   179

/**

   180

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

   181

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

   182

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

   183

 * @param v First vehicle of the chain.

   184

 */

   185

void TrainConsistChanged(Vehicle* v)

   186

{

   187

	uint16 max_speed = 0xFFFF;

   188

   189

	assert(v->type == VEH_TRAIN);

   190

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

   191

   192

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

   193

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

   194

	v->u.rail.cached_total_length = 0;

   195

	v->u.rail.compatible_railtypes = RAILTYPES_NONE;

   196

   197

	bool train_can_tilt = true;

   198

   199

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

   200

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

   201

   202

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

   203

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

   204

   205

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

   206

   207

		/* update the 'first engine' */

   208

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

   209

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

   210

   211

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

   212

   213

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

   214

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

   215

   216

		/* Reset color map */

   217

		u->colormap = PAL_NONE;

   218

   219

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

   220

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

   221

   222

		if (rvi_u->visual_effect != 0) {

   223

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

   224

		} else {

   225

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

   226

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

   227

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

   228

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

   229

				/* Steam is offset by -4 units */

   230

				u->u.rail.cached_vis_effect = 4;

   231

			} else {

   232

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

   233

				u->u.rail.cached_vis_effect = 8;

   234

			}

   235

		}

   236

   237

		if (!IsArticulatedPart(u)) {

   238

			/* Check powered wagon / visual effect callback */

   239

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

   240

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

   241

   242

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

   243

			}

   244

   245

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

   246

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

   247

				/* wagon is powered */

   248

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

   249

			} else {

   250

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

   251

			}

   252

   253

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

   254

			   have railtype normal */

   255

			if (rvi_u->power > 0) {

   256

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

   257

			}

   258

   259

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

   260

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

   261

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

   262

				u->u.rail.railtype = RAILTYPE_RAIL;

   263

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

   264

			}

   265

   266

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

   267

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

   268

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

   269

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

   270

			}

   271

		}

   272

   273

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

   274

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

   275

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

   276

		}

   277

   278

		/* check the vehicle length (callback) */

   279

		uint16 veh_len = CALLBACK_FAILED;

   280

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

   281

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

   282

		}

   283

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

   284

		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

   285

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

   286

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

   287

	}

   288

   289

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

   290

	v->u.rail.cached_max_speed = max_speed;

   291

	v->u.rail.cached_tilt = train_can_tilt;

   292

   293

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

   294

	TrainCargoChanged(v);

   295

   296

	if (IsFrontEngine(v)) {

   297

		UpdateTrainAcceleration(v);

   298

		InvalidateWindow(WC_VEHICLE_DETAILS, v->index);

   299

	}

   300

}

   301

   302

enum AccelType {

   303

	AM_ACCEL,

   304

	AM_BRAKE

   305

};

   306

   307

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

   308

{

   309

	const Order* o = &v->current_order;

   310

	StationID sid = GetStationIndex(tile);

   311

   312

	assert(v->type == VEH_TRAIN);

   313

	/* When does a train drive through a station

   314

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

   315

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

   316

		return false;

   317

	}

   318

   319

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

   320

   321

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

   322

		return false;

   323

	}

   324

   325

	return true;

   326

}

   327

   328

/** new acceleration*/

   329

static int GetTrainAcceleration(Vehicle *v, bool mode)

   330

{

   331

	static const int absolute_max_speed = 2000;

   332

	int max_speed = absolute_max_speed;

   333

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

   334

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

   335

   336

	/*first find the curve speed limit */

   337

	int numcurve = 0;

   338

	int sum = 0;

   339

	int pos = 0;

   340

	int lastpos = -1;

   341

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

   342

		Direction this_dir = u->direction;

   343

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

   344

   345

		DirDiff dirdiff = DirDifference(this_dir, next_dir);

   346

		if (dirdiff == DIRDIFF_SAME) continue;

   347

   348

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

   349

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

   350

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

   351

			if (lastpos != -1) {

   352

				numcurve++;

   353

				sum += pos - lastpos;

   354

				if (pos - lastpos == 1) {

   355

					max_speed = 88;

   356

				}

   357

			}

   358

			lastpos = pos;

   359

		}

   360

   361

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

   362

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

   363

			max_speed = 61;

   364

		}

   365

	}

   366

   367

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

   368

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

   369

   370

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

   371

			max_speed = absolute_max_speed;

   372

		} else if (total > 1) {

   373

			if (numcurve > 0) sum /= numcurve;

   374

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

   375

		}

   376

	}

   377

   378

	if (max_speed != absolute_max_speed) {

   379

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

   380

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

   381

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

   382

   383

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

   384

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

   385

			max_speed += max_speed / 5;

   386

		}

   387

	}

   388

   389

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

   390

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

   391

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

   392

   393

			int st_max_speed = 120;

   394

   395

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

   396

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

   397

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

   398

			}

   399

   400

			st_max_speed = max(st_max_speed, 25 * station_length);

   401

			max_speed = min(max_speed, st_max_speed);

   402

		}

   403

	}

   404

   405

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

   406

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

   407

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

   408

   409

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

   410

	int incl = 0;

   411

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

   412

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

   413

		num++;

   414

		drag_coeff += 3;

   415

   416

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

   417

   418

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

   419

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

   420

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

   421

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

   422

		}

   423

	}

   424

   425

	v->max_speed = max_speed;

   426

   427

	const int area = 120;

   428

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

   429

	int resistance;

   430

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

   431

		resistance = 13 * mass / 10;

   432

		resistance += 60 * num;

   433

		resistance += friction * mass * speed / 1000;

   434

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

   435

	} else {

   436

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

   437

	}

   438

	resistance += incl;

   439

	resistance *= 4; //[N]

   440

   441

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

   442

	 * actually double the train's power */

   443

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

   444

	int force;

   445

	if (speed > 2) {

   446

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

   447

			case RAILTYPE_RAIL:

   448

			case RAILTYPE_ELECTRIC:

   449

			case RAILTYPE_MONO:

   450

				force = power / speed; //[N]

   451

				force *= 22;

   452

				force /= 10;

   453

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

   454

				break;

   455

   456

			default: NOT_REACHED();

   457

			case RAILTYPE_MAGLEV:

   458

				force = power / 25;

   459

				break;

   460

		}

   461

	} else {

   462

		/* "kickoff" acceleration */

   463

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

   464

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

   465

	}

   466

   467

	if (force <= 0) force = 10000;

   468

   469

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

   470

   471

	if (mode == AM_ACCEL) {

   472

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

   473

	} else {

   474

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

   475

	}

   476

}

   477

   478

void UpdateTrainAcceleration(Vehicle* v)

   479

{