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

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

   168

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

   169

   170

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

   171

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

   172

   173

		/* update the 'first engine' */

   174

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

   175

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

   176

   177

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

   178

   179

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

   180

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

   181

   182

		/* Reset color map */

   183

		u->colormap = PAL_NONE;

   184

   185

		if (rvi_u->visual_effect != 0) {

   186

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

   187

		} else {

   188

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

   189

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

   190

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

   191

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

   192

				/* Steam is offset by -4 units */

   193

				u->u.rail.cached_vis_effect = 4;

   194

			} else {

   195

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

   196

				u->u.rail.cached_vis_effect = 8;

   197

			}

   198

		}

   199

   200

		if (!IsArticulatedPart(u)) {

   201

			/* Check powered wagon / visual effect callback */

   202

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

   203

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

   204

   205

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

   206

			}

   207

   208

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

   209

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

   210

				/* wagon is powered */

   211

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

   212

			} else {

   213

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

   214

			}

   215

   216

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

   217

			   have railtype normal */

   218

			if (rvi_u->power > 0) {

   219

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

   220

			}

   221

   222

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

   223

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

   224

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

   225

				u->u.rail.railtype = RAILTYPE_RAIL;

   226

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

   227

			}

   228

   229

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

   230

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

   231

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

   232

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

   233

			}

   234

		}

   235

   236

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

   237

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

   238

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

   239

		}

   240

   241

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

   242

   243

		/* check the vehicle length (callback) */

   244

		uint16 veh_len = CALLBACK_FAILED;

   245

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

   246

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

   247

		}

   248

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

   249

		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

   250

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

   251

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

   252

	}

   253

   254

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

   255

	v->u.rail.cached_max_speed = max_speed;

   256

   257

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

   258

	TrainCargoChanged(v);

   259

}

   260

   261

/* These two arrays are used for realistic acceleration. XXX: How should they

   262

 * be interpreted? */

   263

static const byte _curve_neighbours45[8][2] = {

   264

	{7, 1},

   265

	{0, 2},

   266

	{1, 3},

   267

	{2, 4},

   268

	{3, 5},

   269

	{4, 6},

   270

	{5, 7},

   271

	{6, 0},

   272

};

   273

   274

static const byte _curve_neighbours90[8][2] = {

   275

	{6, 2},

   276

	{7, 3},

   277

	{0, 4},

   278

	{1, 5},

   279

	{2, 6},

   280

	{3, 7},

   281

	{4, 0},

   282

	{5, 1},

   283

};

   284

   285

enum AccelType {

   286

	AM_ACCEL,

   287

	AM_BRAKE

   288

};

   289

   290

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

   291

{

   292

	const Order* o = &v->current_order;

   293

	StationID sid = GetStationIndex(tile);

   294

   295

	assert(v->type == VEH_TRAIN);

   296

	/* When does a train drive through a station

   297

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

   298

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

   299

		return false;

   300

	}

   301

   302

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

   303

   304

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

   305

		return false;

   306

	}

   307

   308

	return true;

   309

}

   310

   311

/** new acceleration*/

   312

static int GetTrainAcceleration(Vehicle *v, bool mode)

   313

{

   314

	int max_speed = 2000;

   315

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

   316

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

   317

   318

	/*first find the curve speed limit */

   319

	int numcurve = 0;

   320

	int sum = 0;

   321

	int pos = 0;

   322

	int lastpos = -1;

   323

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

   324

		Direction dir = u->direction;

   325

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

   326

		int i;

   327

   328

		for (i = 0; i < 2; i++) {

   329

			if ( _curve_neighbours45[dir][i] == ndir) {

   330

				curvecount[i]++;

   331

				if (lastpos != -1) {

   332

					numcurve++;

   333

					sum += pos - lastpos;

   334

					if (pos - lastpos == 1) {

   335

						max_speed = 88;

   336

					}

   337

				}

   338

				lastpos = pos;

   339

			}

   340

		}

   341

   342

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

   343

		if (_curve_neighbours90[dir][0] == ndir ||

   344

				_curve_neighbours90[dir][1] == ndir) {

   345

			max_speed = 61;

   346

		}

   347

	}

   348

   349

	if (numcurve > 0) sum /= numcurve;

   350

   351

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

   352

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

   353

   354

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

   355

			max_speed = 0xFFFF;

   356

		} else if (total > 1) {

   357

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

   358

		}

   359

	}

   360

   361

	max_speed += (max_speed / 2) * v->u.rail.railtype;

   362

   363

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

   364

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

   365

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

   366

			int delta_v;

   367

   368

			max_speed = 120;

   369

   370

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

   371

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

   372

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

   373

   374

			max_speed = max(max_speed, 25 * station_length);

   375

		}

   376

	}

   377

   378

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

   379

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

   380

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

   381

   382

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

   383

	int incl = 0;

   384

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

   385

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

   386

		num++;

   387

		drag_coeff += 3;

   388

   389

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

   390

   391

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

   392

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

   393

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

   394

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

   395

		}

   396

	}

   397

   398

	v->max_speed = max_speed;

   399

   400

	const int area = 120;

   401

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

   402

	int resistance;

   403

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

   404

		resistance = 13 * mass / 10;

   405

		resistance += 60 * num;

   406

		resistance += friction * mass * speed / 1000;

   407

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

   408

	} else {

   409

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

   410

	}

   411

	resistance += incl;

   412

	resistance *= 4; //[N]

   413

   414

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

   415

	 * actually double the train's power */

   416

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

   417

	int force;

   418

	if (speed > 2) {

   419

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

   420

			case RAILTYPE_RAIL:

   421

			case RAILTYPE_ELECTRIC:

   422

			case RAILTYPE_MONO:

   423

				force = power / speed; //[N]

   424

				force *= 22;

   425

				force /= 10;

   426

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

   427

				break;

   428

   429

			default: NOT_REACHED();

   430

			case RAILTYPE_MAGLEV:

   431

				force = power / 25;

   432

				break;

   433

		}

   434

	} else {

   435

		/* "kickoff" acceleration */

   436

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

   437

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

   438

	}

   439

   440

	if (force <= 0) force = 10000;

   441

   442

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

   443

   444

	if (mode == AM_ACCEL) {

   445

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

   446

	} else {

   447

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

   448

	}

   449

}

   450

   451

static void UpdateTrainAcceleration(Vehicle* v)

   452

{

   453

	assert(IsFrontEngine(v));

   454

   455

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

   456

   457

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

   458

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

   459

	assert(weight != 0);

   460

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

   461

}

   462

   463

int Train::GetImage(Direction direction) const

   464

{

   465

	int img = this->spritenum;

   466

	int base;

   467

   468

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

   469

   470

	if (is_custom_sprite(img)) {

   471

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

   472

		if (base != 0) return base;

   473

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

   474

	}

   475

   476

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

   477

   478

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

   479

	return base;

   480

}