1

/* $Id$ */

     2

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "bridge_map.h"

     8

#include "debug.h"

     9

#include "functions.h"

    10

#include "gui.h"

    11

#include "station_map.h"

    12

#include "table/strings.h"

    13

#include "map.h"

    14

#include "tile.h"

    15

#include "tunnel_map.h"

    16

#include "vehicle.h"

    17

#include "command.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 "sound.h"

    26

#include "depot.h"

    27

#include "waypoint.h"

    28

#include "vehicle_gui.h"

    29

#include "train.h"

    30

#include "bridge.h"

    31

#include "newgrf_callbacks.h"

    32

#include "newgrf_engine.h"

    33

#include "newgrf_sound.h"

    34

#include "newgrf_text.h"

    35

#include "direction.h"

    36

#include "yapf/yapf.h"

    37

#include "date.h"

    38

#include "cargotype.h"

    39

    40

static bool TrainCheckIfLineEnds(Vehicle *v);

    41

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

    42

    43

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

    44

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

    45

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

    46

    47

    48

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

    49

 * @param cargo Cargo type to get multiplier for

    50

 * @return Cargo weight multiplier

    51

 */

    52

byte FreightWagonMult(CargoID cargo)

    53

{

    54

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

    55

	return _patches.freight_trains;

    56

}

    57

    58

    59

/**

    60

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

    61

 * @param v First vehicle of the consist.

    62

 */

    63

void TrainPowerChanged(Vehicle* v)

    64

{

    65

	uint32 power = 0;

    66

	uint32 max_te = 0;

    67

    68

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

    69

		/* Power is not added for articulated parts */

    70

		if (IsArticulatedPart(u)) continue;

    71

    72

		RailType railtype = GetRailType(u->tile);

    73

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

    74

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

    75

    76

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

    77

    78

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

    79

			power += rvi_u->power;

    80

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

    81

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

    82

		}

    83

    84

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

    85

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

    86

		}

    87

	}

    88

    89

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

    90

		v->u.rail.cached_power = power;

    91

		v->u.rail.cached_max_te = max_te;

    92

		InvalidateWindow(WC_VEHICLE_DETAILS, v->index);

    93

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

    94

	}

    95

}

    96

    97

    98

/**

    99

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

   100

 * the consist changes.

   101

 * @param v First vehicle of the consist.

   102

 */

   103

static void TrainCargoChanged(Vehicle* v)

   104

{

   105

	uint32 weight = 0;

   106

   107

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

   108

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

   109

   111

		if (!IsArticulatedPart(u)) {

   113

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

   114

   116

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

   117

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

   118

		}

   119

   121

		weight += vweight;

   122

   124

		u->u.rail.cached_veh_weight = vweight;

   125

	}

   126

   128

	v->u.rail.cached_weight = weight;

   129

   130

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

   131

	TrainPowerChanged(v);

   132

}

   133

   134

   135

/**

   136

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

   137

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

   138

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

   139

 * @param v First vehicle of the chain.

   140

 */

   141

void TrainConsistChanged(Vehicle* v)

   142

{

   143

	uint16 max_speed = 0xFFFF;

   144

   145

	assert(v->type == VEH_TRAIN);

   146

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

   147

   148

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

   149

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

   150

	v->u.rail.cached_total_length = 0;

   151

	v->u.rail.compatible_railtypes = 0;

   152

   153

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

   154

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

   155

   157

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

   158

   160

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

   161

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

   162

   163

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

   164

   165

		if (rvi_u->visual_effect != 0) {

   166

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

   167

		} else {

   168

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

   170

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

   171

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

   173

				u->u.rail.cached_vis_effect = 4;

   174

			} else {

   176

				u->u.rail.cached_vis_effect = 8;

   177

			}

   178

		}

   179

   180

		if (!IsArticulatedPart(u)) {

   181

			/* Check powered wagon / visual effect callback */

   182

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

   183

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

   184

   185

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

   186

			}

   187

   188

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

   189

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

   190

				/* wagon is powered */

   191

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

   192

			} else {

   193

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

   194

			}

   195

   196

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

   197

			   have railtype normal */

   198

			if (rvi_u->power > 0) {

   199

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

   200

			}

   201

   202

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

   203

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

   204

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

   205

				u->u.rail.railtype = RAILTYPE_RAIL;

   206

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

   207

			}

   208

   210

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

   211

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

   212

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

   213

		}

   214

   216

		uint16 veh_len = CALLBACK_FAILED;

   217

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

   218

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

   219

		}

   220

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

   221

		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

   222

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

   223

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

   224

	}

   225

   227

	v->u.rail.cached_max_speed = max_speed;

   228

   230

	TrainCargoChanged(v);

   231

}

   232

   233

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

   234

 * be interpreted? */

   235

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

   236

	{7, 1},

   237

	{0, 2},

   238

	{1, 3},

   239

	{2, 4},

   240

	{3, 5},

   241

	{4, 6},

   242

	{5, 7},

   243

	{6, 0},

   244

};

   245

   246

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

   247

	{6, 2},

   248

	{7, 3},

   249

	{0, 4},

   250

	{1, 5},

   251

	{2, 6},

   252

	{3, 7},

   253

	{4, 0},

   254

	{5, 1},

   255

};

   256

   257

enum AccelType {

   258

	AM_ACCEL,

   259

	AM_BRAKE

   260

};

   261

   262

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

   263

{

   264

	const Order* o = &v->current_order;

   265

	StationID sid = GetStationIndex(tile);

   266

   267

	assert(v->type == VEH_TRAIN);

   270

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

   271

		return false;

   272

	}

   273

   274

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

   275

   276

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

   277

		return false;

   278

	}

   279

   280

	return true;

   281

}

   282

   284

static int GetTrainAcceleration(Vehicle *v, bool mode)

   285

{

   286

	int max_speed = 2000;

   287

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

   288

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

   289

   291

	int numcurve = 0;

   292

	int sum = 0;

   293

	int pos = 0;

   294

	int lastpos = -1;

   295

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

   296

		Direction dir = u->direction;

   297

		Direction ndir = u->next->direction;

   298

		int i;

   299

   300

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

   301

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

   302

				curvecount[i]++;

   303

				if (lastpos != -1) {

   304

					numcurve++;

   305

					sum += pos - lastpos;

   306

					if (pos - lastpos == 1) {

   307

						max_speed = 88;

   308

					}

   309

				}

   310

				lastpos = pos;

   311

			}

   312

		}

   313

   315

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

   316

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

   317

			max_speed = 61;

   318

		}

   319

	}

   320

   321

	if (numcurve > 0) sum /= numcurve;

   322

   323

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

   324

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

   325

   326

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

   327

			max_speed = 0xFFFF;

   328

		} else if (total > 1) {

   329

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

   330

		}

   331

	}

   332

   333

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

   334

   335

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

   336

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

   337

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

   338

			int delta_v;

   339

   340

			max_speed = 120;

   341

   342

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

   343

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

   344

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

   345

   346

			max_speed = max(max_speed, 25 * station_length);

   347

		}

   348

	}

   349

   350

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

   351

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

   352

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

   353

   354

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

   355

	int incl = 0;

   356

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

   357

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

   358

		num++;

   359

		drag_coeff += 3;

   360

   361

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

   362

   363

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

   364

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

   365

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

   366

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

   367

		}

   368

	}

   369

   370

	v->max_speed = max_speed;

   371

   372

	const int area = 120;

   373

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

   374

	int resistance;

   375

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

   376

		resistance = 13 * mass / 10;

   377

		resistance += 60 * num;

   378

		resistance += friction * mass * speed / 1000;

   379

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

   380

	} else {

   381

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

   382

	}

   383

	resistance += incl;

   384

	resistance *= 4; //[N]

   385

   386

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

   387

	 * actually double the train's power */

   388

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

   389

	int force;

   390

	if (speed > 2) {

   391

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

   392

			case RAILTYPE_RAIL:

   393

			case RAILTYPE_ELECTRIC:

   394

			case RAILTYPE_MONO:

   395

				force = power / speed; //[N]

   396

				force *= 22;

   397

				force /= 10;

   398

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

   399

				break;

   400

   401

			default: NOT_REACHED();

   402

			case RAILTYPE_MAGLEV:

   403

				force = power / 25;

   404

				break;

   405

		}

   406

	} else {

   408

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

   409

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

   410

	}

   411

   412

	if (force <= 0) force = 10000;

   413

   414

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

   415

   416

	if (mode == AM_ACCEL) {

   417

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

   418

	} else {

   419

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

   420

	}

   421

}

   422

   423

static void UpdateTrainAcceleration(Vehicle* v)

   424

{

   425

	assert(IsFrontEngine(v));

   426

   427

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

   428

   429

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

   430

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

   431

	assert(weight != 0);

   432

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

   433

}

   434

   435

int GetTrainImage(const Vehicle* v, Direction direction)

   436

{

   437

	int img = v->spritenum;

   438

	int base;

   439

   440

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

   441

   442

	if (is_custom_sprite(img)) {

   443

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

   444

		if (base != 0) return base;

   445

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

   446

	}

   447

   448

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

   449

   450

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

   451

	return base;

   452

}

   453

   454

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

   455

{

   456

	const RailVehicleInfo *rvi = RailVehInfo(engine);

   457

   458

	int img = rvi->image_index;

   459

	SpriteID image = 0;

   460

   461

	if (is_custom_sprite(img)) {

   462

		image = GetCustomVehicleIcon(engine, DIR_W);

   463

		if (image == 0) {

   464

			img = orig_rail_vehicle_info[engine].image_index;

   465

		} else {

   466

			y += _traininfo_vehicle_pitch;

   467

		}

   468

	}

   469

	if (image == 0) {

   470

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

   471

	}

   472

   473

	if (rvi->railveh_type == RAILVEH_MULTIHEAD) {

   474

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

   475

		x += 15;

   476

		image = 0;

   477

		if (is_custom_sprite(img)) {

   478

			image = GetCustomVehicleIcon(engine, DIR_E);

   479

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

   480

		}

   481

		if (image == 0) {

   482

			image =

   483

				((6 + _engine_sprite_add[img + 1]) & _engine_sprite_and[img + 1]) +