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

    14

#include "tunnel_map.h"

    15

#include "timetable.h"

    16

#include "articulated_vehicles.h"

    17

#include "command_func.h"

    18

#include "pathfind.h"

    19

#include "npf.h"

    20

#include "station.h"

    21

#include "table/train_cmd.h"

    22

#include "news.h"

    23

#include "engine.h"

    24

#include "player.h"

    25

#include "depot.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

    47

    48

static bool TrainCheckIfLineEnds(Vehicle *v);

    49

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

    50

    51

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

    52

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

    53

static const TrackBits _state_dir_table[4] = { TRACK_BIT_RIGHT, TRACK_BIT_LOWER, TRACK_BIT_LEFT, TRACK_BIT_UPPER };

    54

    55

    56

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

    57

 * @param cargo Cargo type to get multiplier for

    58

 * @return Cargo weight multiplier

    59

 */

    60

byte FreightWagonMult(CargoID cargo)

    61

{

    62

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

    63

	return _patches.freight_trains;

    64

}

    65

    66

    67

/**

    68

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

    69

 * @param v First vehicle of the consist.

    70

 */

    71

void TrainPowerChanged(Vehicle* v)

    72

{

    73

	uint32 total_power = 0;

    74

	uint32 max_te = 0;

    75

    76

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

    77

		/* Power is not added for articulated parts */

    78

		if (IsArticulatedPart(u)) continue;

    79

    80

		RailType railtype = GetRailType(u->tile);

    81

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

    82

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

    83

    84

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

    85

    86

		if (engine_has_power) {

    87

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

    88

			if (power != 0) {

    89

				total_power += power;

    90

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

    91

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

    92

			}

    93

		}

    94

    95

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

    96

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

    97

		}

    98

	}

    99

   100

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

   101

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

   102

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

   103

   104

		v->u.rail.cached_power = total_power;

   105

		v->u.rail.cached_max_te = max_te;

   106

		InvalidateWindow(WC_VEHICLE_DETAILS, v->index);

   107

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

   108

	}

   109

}

   110

   111

   112

/**

   113

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

   114

 * the consist changes.

   115

 * @param v First vehicle of the consist.

   116

 */

   117

static void TrainCargoChanged(Vehicle* v)

   118

{

   119

	uint32 weight = 0;

   120

   121

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

   122

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

   123

   124

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

   125

		if (!IsArticulatedPart(u)) {

   126

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

   127

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

   128

   129

			/* powered wagons have extra weight added */

   130

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

   131

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

   132

		}

   133

   134

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

   135

		weight += vweight;

   136

   137

		/* store vehicle weight in cache */

   138

		u->u.rail.cached_veh_weight = vweight;

   139

	}

   140

   141

	/* store consist weight in cache */

   142

	v->u.rail.cached_weight = weight;

   143

   144

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

   145

	TrainPowerChanged(v);

   146

}

   147

   148

   149

/**

   150

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

   151

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

   152

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

   153

 * @param v First vehicle of the chain.

   154

 */

   155

void TrainConsistChanged(Vehicle* v)

   156

{

   157

	uint16 max_speed = 0xFFFF;

   158

   159

	assert(v->type == VEH_TRAIN);

   160

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

   161

   162

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

   163

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

   164

	v->u.rail.cached_total_length = 0;

   165

	v->u.rail.compatible_railtypes = 0;

   166

   167

	bool train_can_tilt = true;

   168

   169

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

   170

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

   171

   172

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

   173

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

   174

   175

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

   176

   177

		/* update the 'first engine' */

   178

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

   179

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

   180

   181

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

   182

   183

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

   184

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

   185

   186

		/* Reset color map */

   187

		u->colormap = PAL_NONE;

   188

   189

		if (rvi_u->visual_effect != 0) {

   190

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

   191

		} else {

   192

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

   193

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

   194

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

   195

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

   196

				/* Steam is offset by -4 units */

   197

				u->u.rail.cached_vis_effect = 4;

   198

			} else {

   199

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

   200

				u->u.rail.cached_vis_effect = 8;

   201

			}

   202

		}

   203

   204

		if (!IsArticulatedPart(u)) {

   205

			/* Check powered wagon / visual effect callback */

   206

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

   207

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

   208

   209

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

   210

			}

   211

   212

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

   213

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

   214

				/* wagon is powered */

   215

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

   216

			} else {

   217

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

   218

			}

   219

   220

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

   221

			   have railtype normal */

   222

			if (rvi_u->power > 0) {

   223

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

   224

			}

   225

   226

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

   227

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

   228

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

   229

				u->u.rail.railtype = RAILTYPE_RAIL;

   230

				u->u.rail.compatible_railtypes |= (1 << RAILTYPE_RAIL);

   231

			}

   232

   233

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

   234

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

   235

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

   236

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

   237

			}

   238

		}

   239

   240

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

   241

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

   242

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

   243

		}

   244

   245

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

   246

   247

		/* check the vehicle length (callback) */

   248

		uint16 veh_len = CALLBACK_FAILED;

   249

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

   250

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

   251

		}

   252

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

   253

		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

   254

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

   255

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

   256

	}

   257

   258

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

   259

	v->u.rail.cached_max_speed = max_speed;

   260

	v->u.rail.cached_tilt = train_can_tilt;

   261

   262

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

   263

	TrainCargoChanged(v);

   264

}

   265

   266

enum AccelType {

   267

	AM_ACCEL,

   268

	AM_BRAKE

   269

};

   270

   271

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

   272

{

   273

	const Order* o = &v->current_order;

   274

	StationID sid = GetStationIndex(tile);

   275

   276

	assert(v->type == VEH_TRAIN);

   277

	/* When does a train drive through a station

   278

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

   279

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

   280

		return false;

   281

	}

   282

   283

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

   284

   285

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

   286

		return false;

   287

	}

   288

   289

	return true;

   290

}

   291

   292

/** new acceleration*/

   293

static int GetTrainAcceleration(Vehicle *v, bool mode)

   294

{

   295

	static const int absolute_max_speed = 2000;

   296

	int max_speed = absolute_max_speed;

   297

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

   298

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

   299

   300

	/*first find the curve speed limit */

   301

	int numcurve = 0;

   302

	int sum = 0;

   303

	int pos = 0;

   304

	int lastpos = -1;

   305

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

   306

		Direction this_dir = u->direction;

   307

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

   308

   309

		DirDiff dirdiff = DirDifference(this_dir, next_dir);

   310

		if (dirdiff == DIRDIFF_SAME) continue;

   311

   312

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

   313

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

   314

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

   315

			if (lastpos != -1) {

   316

				numcurve++;

   317

				sum += pos - lastpos;

   318

				if (pos - lastpos == 1) {

   319

					max_speed = 88;

   320

				}

   321

			}

   322

			lastpos = pos;

   323

		}

   324

   325

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

   326

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

   327

			max_speed = 61;

   328

		}

   329

	}

   330

   331

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

   332

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

   333

   334

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

   335

			max_speed = absolute_max_speed;

   336

		} else if (total > 1) {

   337

			if (numcurve > 0) sum /= numcurve;

   338

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

   339

		}

   340

	}

   341

   342

	if (max_speed != absolute_max_speed) {

   343

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

   344

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

   345

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

   346

   347

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

   348

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

   349

			max_speed += max_speed / 5;

   350

		}

   351

	}

   352

   353

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

   354

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

   355

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

   356

   357

			int st_max_speed = 120;

   358

   359

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

   360

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

   361

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

   362

			}

   363

   364

			st_max_speed = max(st_max_speed, 25 * station_length);

   365

			max_speed = min(max_speed, st_max_speed);

   366

		}

   367

	}

   368

   369

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

   370

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

   371

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

   372

   373

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

   374

	int incl = 0;

   375

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

   376

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

   377

		num++;

   378

		drag_coeff += 3;

   379

   380

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

   381

   382

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

   383

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

   384

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

   385

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

   386

		}

   387

	}

   388

   389

	v->max_speed = max_speed;

   390

   391

	const int area = 120;

   392

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

   393

	int resistance;

   394

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

   395

		resistance = 13 * mass / 10;

   396

		resistance += 60 * num;

   397

		resistance += friction * mass * speed / 1000;

   398

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

   399

	} else {

   400

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

   401

	}

   402

	resistance += incl;

   403

	resistance *= 4; //[N]

   404

   405

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

   406

	 * actually double the train's power */

   407

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

   408

	int force;

   409

	if (speed > 2) {

   410

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

   411

			case RAILTYPE_RAIL:

   412

			case RAILTYPE_ELECTRIC:

   413

			case RAILTYPE_MONO:

   414

				force = power / speed; //[N]

   415

				force *= 22;

   416

				force /= 10;

   417

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

   418

				break;

   419

   420

			default: NOT_REACHED();

   421

			case RAILTYPE_MAGLEV:

   422

				force = power / 25;

   423

				break;

   424

		}

   425

	} else {

   426

		/* "kickoff" acceleration */

   427

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

   428

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

   429

	}

   430

   431

	if (force <= 0) force = 10000;

   432

   433

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

   434

   435

	if (mode == AM_ACCEL) {

   436

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

   437

	} else {

   438

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

   439

	}

   440

}

   441

   442

static void UpdateTrainAcceleration(Vehicle* v)

   443

{

   444

	assert(IsFrontEngine(v));

   445

   446

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

   447

   448

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

   449

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

   450

	assert(weight != 0);

   451

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

   452

}

   453

   454

int Train::GetImage(Direction direction) const

   455

{

   456

	int img = this->spritenum;

   457

	int base;

   458

   459

	if (HasBit(this->u.rail.flags, VRF_REVERSE_DIRECTION)) direction = ReverseDir(direction);

   460

   461

	if (is_custom_sprite(img)) {

   462

		base = GetCustomVehicleSprite(this, (Direction)(direction + 4 * IS_CUSTOM_SECONDHEAD_SPRITE(img)));

   463

		if (base != 0) return base;

   464

		img = orig_rail_vehicle_info[this->engine_type].image_index;

   465

	}

   466

   467

	base = _engine_sprite_base[img] + ((direction + _engine_sprite_add[img]) & _engine_sprite_and[img]);

   468

   469

	if (this->cargo.Count() >= this->cargo_cap / 2U) base += _wagon_full_adder[img];

   470

	return base;

   471

}

   472

   473

void DrawTrainEngine(int x, int y, EngineID engine, SpriteID pal)

   474

{

   475

	const RailVehicleInfo *rvi = RailVehInfo(engine);

   476

   477

	int img = rvi->image_index;

   478

	SpriteID image = 0;

   479

   480

	if (is_custom_sprite(img)) {