1

/* $Id$ */

     2

     3

#include "stdafx.h"

     4

#include "openttd.h"

     5

#include "bridge_map.h"

     6

#include "debug.h"

     7

#include "functions.h"

     8

#include "gui.h"

     9

#include "station_map.h"

    10

#include "table/strings.h"

    11

#include "map.h"

    12

#include "tile.h"

    13

#include "tunnel_map.h"

    14

#include "vehicle.h"

    15

#include "command.h"

    16

#include "pathfind.h"

    17

#include "npf.h"

    18

#include "station.h"

    19

#include "table/train_cmd.h"

    20

#include "news.h"

    21

#include "engine.h"

    22

#include "player.h"

    23

#include "sound.h"

    24

#include "depot.h"

    25

#include "waypoint.h"

    26

#include "vehicle_gui.h"

    27

#include "train.h"

    28

#include "newgrf_callbacks.h"

    29

#include "newgrf_engine.h"

    30

#include "newgrf_sound.h"

    31

#include "newgrf_text.h"

    32

#include "direction.h"

    33

#include "yapf/yapf.h"

    34

#include "date.h"

    35

    36

static bool TrainCheckIfLineEnds(Vehicle *v);

    37

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

    38

    39

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

    40

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

    41

static const byte _state_dir_table[4] = { 0x20, 8, 0x10, 4 };

    42

    43

    44

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

    45

 * @param v Vehicle (wagon) to get multiplier for

    46

 * @return Cargo weight multiplier

    47

 */

    48

byte FreightWagonMult(const Vehicle *v)

    49

{

    50

	assert(v->type == VEH_Train);

    51

	// XXX NewCargos introduces a specific "is freight" flag for this test.

    52

	if (v->cargo_type == CT_PASSENGERS || v->cargo_type == CT_MAIL) return 1;

    53

	return _patches.freight_trains;

    54

}

    55

    56

    57

/**

    58

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

    59

 * the consist changes.

    60

 * @param v First vehicle of the consist.

    61

 */

    62

static void TrainCargoChanged(Vehicle* v)

    63

{

    64

	Vehicle *u;

    65

	uint32 weight = 0;

    66

    67

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

    68

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

    69

		uint32 vweight = (_cargoc.weights[u->cargo_type] * u->cargo_count * FreightWagonMult(u)) / 16;

    70

    71

		// Vehicle weight is not added for articulated parts.

    72

		if (!IsArticulatedPart(u)) {

    73

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

    74

			vweight += rvi->weight;

    75

    76

			// powered wagons have extra weight added

    77

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

    78

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

    79

		}

    80

    81

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

    82

		weight += vweight;

    83

    84

		// store vehicle weight in cache

    85

		u->u.rail.cached_veh_weight = vweight;

    86

	};

    87

    88

	// store consist weight in cache

    89

	v->u.rail.cached_weight = weight;

    90

}

    91

    92

/**

    93

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

    94

 * @param v First vehicle of the consist.

    95

 */

    96

void TrainPowerChanged(Vehicle* v)

    97

{

    98

	Vehicle* u;

    99

	uint32 power = 0;

   100

   101

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

   102

		const RailVehicleInfo *rvi_u;

   103

		bool engine_has_power = true;

   104

		bool wagon_has_power = true;

   105

   106

		/* Power is not added for articulated parts */

   107

		if (IsArticulatedPart(u)) continue;

   108

   109

		if (IsBridgeTile(u->tile) && IsBridgeMiddle(u->tile) && DiagDirToAxis(DirToDiagDir(u->direction)) == GetBridgeAxis(u->tile)) {

   110

			if (!HasPowerOnRail(u->u.rail.railtype, GetRailTypeOnBridge(u->tile))) engine_has_power = false;

   111

			if (!HasPowerOnRail(v->u.rail.railtype, GetRailTypeOnBridge(u->tile))) wagon_has_power = false;

   112

		} else if (IsLevelCrossingTile(u->tile)) {

   113

			if (!HasPowerOnRail(u->u.rail.railtype, GetRailTypeCrossing(u->tile))) engine_has_power = false;

   114

			if (!HasPowerOnRail(v->u.rail.railtype, GetRailTypeCrossing(u->tile))) wagon_has_power = false;

   115

		} else {

   116

			if (!HasPowerOnRail(u->u.rail.railtype, GetRailType(u->tile))) engine_has_power = false;

   117

			if (!HasPowerOnRail(v->u.rail.railtype, GetRailType(u->tile))) wagon_has_power = false;

   118

		}

   119

   120

		rvi_u = RailVehInfo(u->engine_type);

   121

   122

		if (engine_has_power) power += rvi_u->power;

   123

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

   124

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

   125

		}

   126

	}

   127

   128

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

   129

		v->u.rail.cached_power = power;

   130

		InvalidateWindow(WC_VEHICLE_DETAILS, v->index);

   131

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

   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

	const RailVehicleInfo *rvi_v;

   144

	Vehicle *u;

   145

	uint16 max_speed = 0xFFFF;

   146

	EngineID first_engine;

   147

   148

	assert(v->type == VEH_Train);

   149

   150

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

   151

   152

	rvi_v = RailVehInfo(v->engine_type);

   153

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

   154

	v->u.rail.cached_total_length = 0;

   155

	v->u.rail.compatible_railtypes = 0;

   156

   157

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

   158

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

   159

		uint16 veh_len;

   160

   161

		// Update the v->first cache. This is faster than having to brute force it later.

   162

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

   163

   164

		// update the 'first engine'

   165

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

   166

		u->u.rail.railtype = GetEngine(u->engine_type)->railtype;

   167

   168

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

   169

   170

		if (rvi_u->visual_effect != 0) {

   171

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

   172

		} else {

   173

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

   174

				// Wagons and articulated parts have no effect by default

   175

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

   176

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

   177

				// Steam is offset by -4 units

   178

				u->u.rail.cached_vis_effect = 4;

   179

			} else {

   180

				// Diesel fumes and sparks come from the centre

   181

				u->u.rail.cached_vis_effect = 8;

   182

			}

   183

		}

   184

   185

		if (!IsArticulatedPart(u)) {

   186

			// check if its a powered wagon

   187

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

   188

   189

			/* Check powered wagon / visual effect callback */

   190

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

   191

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

   192

   193

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

   194

			}

   195

   196

			if ((rvi_v->pow_wag_power != 0) && (rvi_u->flags & RVI_WAGON) && UsesWagonOverride(u)) {

   197

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

   198

					/* wagon is powered */

   199

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

   200

				}

   201

			}

   202

   203

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

   204

			   have railtype normal */

   205

			if (rvi_u->power > 0) {

   206

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

   207

			}

   208

   209

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

   210

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

   211

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

   212

				u->u.rail.railtype = RAILTYPE_RAIL;

   213

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

   214

			}

   215

   216

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

   217

			if (!(rvi_u->flags & RVI_WAGON) || _patches.wagon_speed_limits)

   218

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

   219

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

   220

		}

   221

   222

		// check the vehicle length (callback)

   223

		veh_len = CALLBACK_FAILED;

   224

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

   225

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

   226

		}

   227

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

   228

		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

   229

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

   230

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

   231

   232

	};

   233

   234

	// store consist weight/max speed in cache

   235

	v->u.rail.cached_max_speed = max_speed;

   236

   237

	TrainPowerChanged(v);

   238

   239

	// recalculate cached weights too (we do this *after* the rest, so it is known which wagons are powered and need extra weight added)

   240

	TrainCargoChanged(v);

   241

}

   242

   243

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

   244

 * be interpreted? */

   245

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

   246

	{7, 1},

   247

	{0, 2},

   248

	{1, 3},

   249

	{2, 4},

   250

	{3, 5},

   251

	{4, 6},

   252

	{5, 7},

   253

	{6, 0},

   254

};

   255

   256

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

   257

	{6, 2},

   258

	{7, 3},

   259

	{0, 4},

   260

	{1, 5},

   261

	{2, 6},

   262

	{3, 7},

   263

	{4, 0},

   264

	{5, 1},

   265

};

   266

   267

enum AccelType {

   268

	AM_ACCEL,

   269

	AM_BRAKE

   270

};

   271

   272

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

   273

{

   274

	const Order* o = &v->current_order;

   275

	StationID sid = GetStationIndex(tile);

   276

   277

	assert(v->type == VEH_Train);

   278

	//When does a train drive through a station

   279

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

   280

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

   281

		return false;

   282

	}

   283

   284

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

   285

   286

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

   287

		return false;

   288

	}

   289

   290

	return true;

   291

}

   292

   293

//new acceleration

   294

static int GetTrainAcceleration(Vehicle *v, bool mode)

   295

{

   296

	const Vehicle *u;

   297

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

   298

	int power = 0;

   299

	int mass = 0;

   300

	int max_speed = 2000;

   301

	int area = 120;

   302

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

   303

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

   304

	int incl = 0;

   305

	int resistance;

   306

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

   307

	int force = 0x3FFFFFFF;

   308

	int pos = 0;

   309

	int lastpos = -1;

   310

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

   311

	int sum = 0;

   312

	int numcurve = 0;

   313

   314

	speed *= 10;

   315

	speed /= 16;

   316

   317

	//first find the curve speed limit

   318

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

   319

		Direction dir = u->direction;

   320

		Direction ndir = u->next->direction;

   321

		int i;

   322

   323

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

   324

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

   325

				curvecount[i]++;

   326

				if (lastpos != -1) {

   327

					numcurve++;

   328

					sum += pos - lastpos;

   329

					if (pos - lastpos == 1) {

   330

						max_speed = 88;

   331

					}

   332

				}

   333

				lastpos = pos;

   334

			}

   335

		}

   336

   337

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

   338

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

   339

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

   340

			max_speed = 61;

   341

		}

   342

	}

   343

   344

	if (numcurve > 0) sum /= numcurve;

   345

   346

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

   347

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

   348

   349

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

   350

			max_speed = 0xFFFF;

   351

		} else if (total > 1) {

   352

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

   353

		}

   354

	}

   355

   356

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

   357

   358

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

   359

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

   360

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

   361

			int delta_v;

   362

   363

			max_speed = 120;

   364

   365

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

   366

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

   367

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

   368

   369

			max_speed = max(max_speed, 25 * station_length);

   370

		}

   371

	}

   372

   373

	mass = v->u.rail.cached_weight;

   374

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

   375

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

   376

   377

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

   378

		num++;

   379

		drag_coeff += 3;

   380

   381

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

   382

   383

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

   384

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

   385

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

   386

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

   387

		}

   388

	}

   389

   390

	v->max_speed = max_speed;

   391

   392

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

   393

		resistance = 13 * mass / 10;

   394

		resistance += 60 * num;

   395

		resistance += friction * mass * speed / 1000;

   396

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

   397

	} else {

   398

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

   399

	}

   400

	resistance += incl;

   401

	resistance *= 4; //[N]

   402

   403

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

   404

	 * actually double the train's power */

   405

	if (speed > 2) {

   406

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

   407

			case RAILTYPE_RAIL:

   408

			case RAILTYPE_ELECTRIC:

   409

			case RAILTYPE_MONO:

   410

				force = power / speed; //[N]

   411

				force *= 22;

   412

				force /= 10;

   413

				break;

   414

   415

			case RAILTYPE_MAGLEV:

   416

				force = power / 25;

   417

				break;

   418

		}

   419

	} else {

   420

		//"kickoff" acceleration

   421

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

   422

	}

   423

   424

	if (force <= 0) force = 10000;

   425

   426

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

   427

   428

	if (mode == AM_ACCEL) {

   429

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

   430

	} else {

   431

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

   432

	}

   433

}

   434

   435

static void UpdateTrainAcceleration(Vehicle* v)

   436

{

   437

	uint power = 0;

   438

	uint weight = 0;

   439

   440

	assert(IsFrontEngine(v));

   441

   442

	weight = v->u.rail.cached_weight;

   443

	power = v->u.rail.cached_power;

   444

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

   445

   446

	assert(weight != 0);

   447

   448

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

   449

}

   450

   451

int GetTrainImage(const Vehicle* v, Direction direction)

   452

{

   453

	int img = v->spritenum;

   454

	int base;

   455

   456

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

   457

   458

	if (is_custom_sprite(img)) {

   459

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

   460

		if (base != 0) return base;

   461

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

   462

	}

   463

   464

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

   465

   466

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

   467

	return base;

   468

}

   469

   470

void DrawTrainEngine(int x, int y, EngineID engine, uint32 image_ormod)

   471

{

   472

	const RailVehicleInfo *rvi = RailVehInfo(engine);

   473

   474

	int img = rvi->image_index;

   475

	uint32 image = 0;

   476

   477

	if (is_custom_sprite(img)) {

   478

		image = GetCustomVehicleIcon(engine, DIR_W);

   479

		if (image == 0) {

   480

			img = orig_rail_vehicle_info[engine].image_index;

   481

		} else {

   482

			y += _traininfo_vehicle_pitch;

   483

		}

   484

	}

   485

	if (image == 0) {

   486

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