1

/* $Id$ */

     2

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "bridge_map.h"

     8

#include "debug.h"

     9

#include "functions.h"

    11

#include "gui.h"

    12

#include "station_map.h"

    13

#include "table/strings.h"

    14

#include "map.h"

    15

#include "tile.h"

    16

#include "tunnel_map.h"

    17

#include "vehicle.h"

    18

#include "command.h"

    19

#include "pathfind.h"

    20

#include "npf.h"

    21

#include "station.h"

    22

#include "table/train_cmd.h"

    23

#include "news.h"

    24

#include "engine.h"

    25

#include "player.h"

    26

#include "sound.h"

    27

#include "depot.h"

    28

#include "waypoint.h"

    29

#include "vehicle_gui.h"

    30

#include "train.h"

    31

#include "bridge.h"

    32

#include "newgrf_callbacks.h"

    33

#include "newgrf_engine.h"

    34

#include "newgrf_sound.h"

    35

#include "newgrf_text.h"

    36

#include "direction.h"

    37

#include "yapf/yapf.h"

    38

#include "date.h"

    39

#include "cargotype.h"

    40

    41

static bool TrainCheckIfLineEnds(Vehicle *v);

    42

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

    43

    44

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

    45

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

    46

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

    47

    48

    49

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

    50

 * @param cargo Cargo type to get multiplier for

    51

 * @return Cargo weight multiplier

    52

 */

    53

byte FreightWagonMult(CargoID cargo)

    54

{

    55

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

    56

	return _patches.freight_trains;

    57

}

    58

    59

    60

/**

    61

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

    62

 * @param v First vehicle of the consist.

    63

 */

    64

void TrainPowerChanged(Vehicle* v)

    65

{

    66

	uint32 power = 0;

    67

	uint32 max_te = 0;

    68

    69

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

    70

		/* Power is not added for articulated parts */

    71

		if (IsArticulatedPart(u)) continue;

    72

    73

		RailType railtype = GetRailType(u->tile);

    74

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

    75

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

    76

    77

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

    78

    79

		if (engine_has_power && rvi_u->power != 0) {

    80

			power += rvi_u->power;

    81

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

    82

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

    83

		}

    84

    85

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

    86

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

    87

		}

    88

	}

    89

    90

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

    91

		v->u.rail.cached_power = power;

    92

		v->u.rail.cached_max_te = max_te;

    93

		InvalidateWindow(WC_VEHICLE_DETAILS, v->index);

    94

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

    95

	}

    96

}

    97

    98

    99

/**

   100

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

   101

 * the consist changes.

   102

 * @param v First vehicle of the consist.

   103

 */

   104

static void TrainCargoChanged(Vehicle* v)

   105

{

   106

	uint32 weight = 0;

   107

   108

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

   109

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

   110

   112

		if (!IsArticulatedPart(u)) {

   114

			vweight += RailVehInfo(u->engine_type)->weight;

   115

   117

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

   118

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

   119

		}

   120

   122

		weight += vweight;

   123

   125

		u->u.rail.cached_veh_weight = vweight;

   126

	}

   127

   129

	v->u.rail.cached_weight = weight;

   130

   131

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

   132

	TrainPowerChanged(v);

   133

}

   134

   135

   136

/**

   137

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

   138

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

   139

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

   140

 * @param v First vehicle of the chain.

   141

 */

   142

void TrainConsistChanged(Vehicle* v)

   143

{

   144

	uint16 max_speed = 0xFFFF;

   145

   146

	assert(v->type == VEH_TRAIN);

   147

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

   148

   149

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

   150

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

   151

	v->u.rail.cached_total_length = 0;

   152

	v->u.rail.compatible_railtypes = 0;

   153

   154

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

   155

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

   156

   158

		if (u->first == NULL) u->first = v;

   159

   161

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

   162

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

   163

   164

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

   165

   166

		if (rvi_u->visual_effect != 0) {

   167

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

   168

		} else {

   169

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

   171

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

   172

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

   174

				u->u.rail.cached_vis_effect = 4;

   175

			} else {

   177

				u->u.rail.cached_vis_effect = 8;

   178

			}

   179

		}

   180

   181

		if (!IsArticulatedPart(u)) {

   182

			/* Check powered wagon / visual effect callback */

   183

			if (HASBIT(EngInfo(u->engine_type)->callbackmask, CBM_WAGON_POWER)) {

   184

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

   185

   186

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

   187

			}

   188

   189

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

   190

				UsesWagonOverride(u) && (u->u.rail.cached_vis_effect < 0x40)) {

   191

				/* wagon is powered */

   192

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

   193

			} else {

   194

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

   195

			}

   196

   197

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

   198

			   have railtype normal */

   199

			if (rvi_u->power > 0) {

   200

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

   201

			}

   202

   203

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

   204

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

   205

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

   206

				u->u.rail.railtype = RAILTYPE_RAIL;

   207

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

   208

			}

   209

   211

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

   212

				rvi_u->max_speed != 0 && !UsesWagonOverride(u))

   213

				max_speed = min(rvi_u->max_speed, max_speed);

   214

		}

   215

   217

		uint16 veh_len = CALLBACK_FAILED;

   218

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

   219

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

   220

		}

   221

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

   222

		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

   223

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

   224

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

   225

	}

   226

   228

	v->u.rail.cached_max_speed = max_speed;

   229

   231

	TrainCargoChanged(v);

   232

}

   233

   234

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

   235

 * be interpreted? */

   236

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

   237

	{7, 1},

   238

	{0, 2},

   239

	{1, 3},

   240

	{2, 4},

   241

	{3, 5},

   242

	{4, 6},

   243

	{5, 7},

   244

	{6, 0},

   245

};

   246

   247

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

   248

	{6, 2},

   249

	{7, 3},

   250

	{0, 4},

   251

	{1, 5},

   252

	{2, 6},

   253

	{3, 7},

   254

	{4, 0},

   255

	{5, 1},

   256

};

   257

   258

enum AccelType {

   259

	AM_ACCEL,

   260

	AM_BRAKE

   261

};

   262

   263

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

   264

{

   265

	const Order* o = &v->current_order;

   266

	StationID sid = GetStationIndex(tile);

   267

   268

	assert(v->type == VEH_TRAIN);

   271

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

   272

		return false;

   273

	}

   274

   275

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

   276

   277

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

   278

		return false;

   279

	}

   280

   281

	return true;

   282

}

   283

   285

static int GetTrainAcceleration(Vehicle *v, bool mode)

   286

{

   287

	int max_speed = 2000;

   288

	int speed = v->cur_speed * 10 / 16; //[mph]

   289

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

   290

   292

	int numcurve = 0;

   293

	int sum = 0;

   294

	int pos = 0;

   295

	int lastpos = -1;

   296

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

   297

		Direction dir = u->direction;

   298

		Direction ndir = u->next->direction;

   299

		int i;

   300

   301

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

   302

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

   303

				curvecount[i]++;

   304

				if (lastpos != -1) {

   305

					numcurve++;

   306

					sum += pos - lastpos;

   307

					if (pos - lastpos == 1) {

   308

						max_speed = 88;

   309

					}

   310

				}

   311

				lastpos = pos;

   312

			}

   313

		}

   314

   316

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

   317

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

   318

			max_speed = 61;

   319

		}

   320

	}

   321

   322

	if (numcurve > 0) sum /= numcurve;

   323

   324

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

   325

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

   326

   327

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

   328

			max_speed = 0xFFFF;

   329

		} else if (total > 1) {

   330

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

   331

		}

   332

	}

   333

   334

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

   335

   336

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

   337

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

   338

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

   339

			int delta_v;

   340

   341

			max_speed = 120;

   342

   343

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

   344

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

   345

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

   346

   347

			max_speed = max(max_speed, 25 * station_length);

   348

		}

   349

	}

   350

   351

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

   352

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

   353

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

   354

   355

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

   356

	int incl = 0;

   357

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

   358

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

   359

		num++;

   360

		drag_coeff += 3;

   361

   362

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

   363

   364

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

   365

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

   366

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

   367

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

   368

		}

   369

	}

   370

   371

	v->max_speed = max_speed;

   372

   373

	const int area = 120;

   374

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

   375

	int resistance;

   376

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

   377

		resistance = 13 * mass / 10;

   378

		resistance += 60 * num;

   379

		resistance += friction * mass * speed / 1000;

   380

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

   381

	} else {

   382

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

   383

	}

   384

	resistance += incl;

   385

	resistance *= 4; //[N]

   386

   387

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

   388

	 * actually double the train's power */

   389

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

   390

	int force;

   391

	if (speed > 2) {

   392

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

   393

			case RAILTYPE_RAIL:

   394

			case RAILTYPE_ELECTRIC:

   395

			case RAILTYPE_MONO:

   396

				force = power / speed; //[N]

   397

				force *= 22;

   398

				force /= 10;

   399

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

   400

				break;

   401

   402

			default: NOT_REACHED();

   403

			case RAILTYPE_MAGLEV:

   404

				force = power / 25;

   405

				break;

   406

		}

   407

	} else {

   409

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

   410

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

   411

	}

   412

   413

	if (force <= 0) force = 10000;

   414

   415

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

   416

   417

	if (mode == AM_ACCEL) {

   418

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

   419

	} else {

   420

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

   421

	}

   422

}

   423

   424

static void UpdateTrainAcceleration(Vehicle* v)

   425

{

   426

	assert(IsFrontEngine(v));

   427

   428

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

   429

   430

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

   431

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

   432

	assert(weight != 0);

   433

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

   434

}

   435

   436

int GetTrainImage(const Vehicle* v, Direction direction)

   437

{

   438

	int img = v->spritenum;

   439

	int base;

   440

   441

	if (HASBIT(v->u.rail.flags, VRF_REVERSE_DIRECTION)) direction = ReverseDir(direction);

   442

   443

	if (is_custom_sprite(img)) {

   444

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

   445

		if (base != 0) return base;

   446

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

   447

	}

   448

   449

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

   450

   451

	if (v->cargo_count >= v->cargo_cap / 2) base += _wagon_full_adder[img];

   452

	return base;

   453

}

   454

   455

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

   456

{

   457

	const RailVehicleInfo *rvi = RailVehInfo(engine);

   458

   459

	int img = rvi->image_index;

   460

	SpriteID image = 0;

   461

   462

	if (is_custom_sprite(img)) {

   463

		image = GetCustomVehicleIcon(engine, DIR_W);

   464

		if (image == 0) {

   465

			img = orig_rail_vehicle_info[engine].image_index;

   466

		} else {

   467

			y += _traininfo_vehicle_pitch;

   468

		}

   469

	}

   470

	if (image == 0) {

   471

		image = (6 & _engine_sprite_and[img]) + _engine_sprite_base[img];

   472

	}

   473

   474

	if (rvi->railveh_type == RAILVEH_MULTIHEAD) {

   475

		DrawSprite(image, pal, x - 14, y);

   476

		x += 15;

   477

		image = 0;

   478

		if (is_custom_sprite(img)) {

   479

			image = GetCustomVehicleIcon(engine, DIR_E);

   480

			if (image == 0) img = orig_rail_vehicle_info[engine].image_index;

   481

		}

   482

		if (image == 0) {

   483