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 cargo Cargo type to get multiplier for

    46

 * @return Cargo weight multiplier

    47

 */

    48

byte FreightWagonMult(CargoID cargo)

    49

{

    50

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

    51

	if (cargo == CT_PASSENGERS || cargo == CT_MAIL) return 1;

    52

	return _patches.freight_trains;

    53

}

    54

    55

    56

/**

    57

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

    58

 * the consist changes.

    59

 * @param v First vehicle of the consist.

    60

 */

    61

static void TrainCargoChanged(Vehicle* v)

    62

{

    63

	Vehicle *u;

    64

	uint32 weight = 0;

    65

    66

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

    67

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

    68

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

    69

    70

		// Vehicle weight is not added for articulated parts.

    71

		if (!IsArticulatedPart(u)) {

    72

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

    73

			vweight += rvi->weight;

    74

    75

			// powered wagons have extra weight added

    76

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

    77

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

    78

		}

    79

    80

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

    81

		weight += vweight;

    82

    83

		// store vehicle weight in cache

    84

		u->u.rail.cached_veh_weight = vweight;

    85

	};

    86

    87

	// store consist weight in cache

    88

	v->u.rail.cached_weight = weight;

    89

}

    90

    91

/**

    92

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

    93

 * @param v First vehicle of the consist.

    94

 */

    95

void TrainPowerChanged(Vehicle* v)

    96

{

    97

	Vehicle* u;

    98

	uint32 power = 0;

    99

   100

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

   101

		const RailVehicleInfo *rvi_u;

   102

		bool engine_has_power = true;

   103

		bool wagon_has_power = true;

   104

   105

		/* Power is not added for articulated parts */

   106

		if (IsArticulatedPart(u)) continue;

   107

   108

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

   109

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

   110

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

   111

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

   112

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

   113

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

   114

		} else {

   115

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

   116

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

   117

		}

   118

   119

		rvi_u = RailVehInfo(u->engine_type);

   120

   121

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

   122

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

   123

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

   124

		}

   125

	}

   126

   127

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

   128

		v->u.rail.cached_power = power;

   129

		InvalidateWindow(WC_VEHICLE_DETAILS, v->index);

   130

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

   131

	}

   132

}

   133

   134

/**

   135

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

   136

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

   137

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

   138

 * @param v First vehicle of the chain.

   139

 */

   140

void TrainConsistChanged(Vehicle* v)

   141

{

   142

	const RailVehicleInfo *rvi_v;

   143

	Vehicle *u;

   144

	uint16 max_speed = 0xFFFF;

   145

	EngineID first_engine;

   146

   147

	assert(v->type == VEH_Train);

   148

   149

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

   150

   151

	rvi_v = RailVehInfo(v->engine_type);

   152

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

   153

	v->u.rail.cached_total_length = 0;

   154

	v->u.rail.compatible_railtypes = 0;

   155

   156

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

   157

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

   158

		uint16 veh_len;

   159

   160

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

   161

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

   162

   163

		// update the 'first engine'

   164

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

   165

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

   166

   167

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

   168

   169

		if (rvi_u->visual_effect != 0) {

   170

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

   171

		} else {

   172

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

   173

				// Wagons and articulated parts have no effect by default

   174

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

   175

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

   176

				// Steam is offset by -4 units

   177

				u->u.rail.cached_vis_effect = 4;

   178

			} else {

   179

				// Diesel fumes and sparks come from the centre

   180

				u->u.rail.cached_vis_effect = 8;

   181

			}

   182

		}

   183

   184

		if (!IsArticulatedPart(u)) {

   185

			// check if its a powered wagon

   186

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

   187

   188

			/* Check powered wagon / visual effect callback */

   189

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

   190

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

   191

   192

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

   193

			}

   194

   195

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

   196

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

   197

					/* wagon is powered */

   198

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

   199

				}

   200

			}

   201

   202

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

   203

			   have railtype normal */

   204

			if (rvi_u->power > 0) {

   205

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

   206

			}

   207

   208

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

   209

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

   210

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

   211

				u->u.rail.railtype = RAILTYPE_RAIL;

   212

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

   213

			}

   214

   215

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

   216

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

   217

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

   218

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

   219

		}

   220

   221

		// check the vehicle length (callback)

   222

		veh_len = CALLBACK_FAILED;

   223

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

   224

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

   225

		}

   226

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

   227

		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

   228

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

   229

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

   230

   231

	};

   232

   233

	// store consist weight/max speed in cache

   234

	v->u.rail.cached_max_speed = max_speed;

   235

   236

	TrainPowerChanged(v);

   237

   238

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

   239

	TrainCargoChanged(v);

   240

}

   241

   242

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

   243

 * be interpreted? */

   244

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

   245

	{7, 1},

   246

	{0, 2},

   247

	{1, 3},

   248

	{2, 4},

   249

	{3, 5},

   250

	{4, 6},

   251

	{5, 7},

   252

	{6, 0},

   253

};

   254

   255

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

   256

	{6, 2},

   257

	{7, 3},

   258

	{0, 4},

   259

	{1, 5},

   260

	{2, 6},

   261

	{3, 7},

   262

	{4, 0},

   263

	{5, 1},

   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

	const Vehicle *u;

   296

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

   297

	int power = 0;

   298

	int mass = 0;

   299

	int max_speed = 2000;

   300

	int area = 120;

   301

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

   302

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

   303

	int incl = 0;

   304

	int resistance;

   305

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

   306

	int force = 0x3FFFFFFF;

   307

	int pos = 0;

   308

	int lastpos = -1;

   309

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

   310

	int sum = 0;

   311

	int numcurve = 0;

   312

   313

	speed *= 10;

   314

	speed /= 16;

   315

   316

	//first find the curve speed limit

   317

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

   318

		Direction dir = u->direction;

   319

		Direction ndir = u->next->direction;

   320

		int i;

   321

   322

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

   323

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

   324

				curvecount[i]++;

   325

				if (lastpos != -1) {

   326

					numcurve++;

   327

					sum += pos - lastpos;

   328

					if (pos - lastpos == 1) {

   329

						max_speed = 88;

   330

					}

   331

				}

   332

				lastpos = pos;

   333

			}

   334

		}

   335

   336

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

   337

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

   338

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

   339

			max_speed = 61;

   340

		}

   341

	}

   342

   343

	if (numcurve > 0) sum /= numcurve;

   344

   345

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

   346

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

   347

   348

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

   349

			max_speed = 0xFFFF;

   350

		} else if (total > 1) {

   351

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

   352

		}

   353

	}

   354

   355

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

   356

   357

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

   358

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

   359

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

   360

			int delta_v;

   361

   362

			max_speed = 120;

   363

   364

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

   365

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

   366

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

   367

   368

			max_speed = max(max_speed, 25 * station_length);

   369

		}

   370

	}

   371

   372

	mass = v->u.rail.cached_weight;

   373

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

   374

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

   375

   376

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

   377

		num++;

   378

		drag_coeff += 3;

   379

   380

		if (u->u.rail.track == 0x80) 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

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

   392

		resistance = 13 * mass / 10;

   393

		resistance += 60 * num;

   394

		resistance += friction * mass * speed / 1000;

   395

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

   396

	} else {

   397

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

   398

	}

   399

	resistance += incl;

   400

	resistance *= 4; //[N]

   401

   402

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

   403

	 * actually double the train's power */

   404

	if (speed > 2) {

   405

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

   406

			case RAILTYPE_RAIL:

   407

			case RAILTYPE_ELECTRIC:

   408

			case RAILTYPE_MONO:

   409

				force = power / speed; //[N]

   410

				force *= 22;

   411

				force /= 10;

   412

				break;

   413

   414

			case RAILTYPE_MAGLEV:

   415

				force = power / 25;

   416

				break;

   417

		}

   418

	} else {

   419

		//"kickoff" acceleration

   420

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

   421

	}

   422

   423

	if (force <= 0) force = 10000;

   424

   425

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

   426

   427

	if (mode == AM_ACCEL) {

   428

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

   429

	} else {

   430

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

   431

	}

   432

}

   433

   434

static void UpdateTrainAcceleration(Vehicle* v)

   435

{

   436

	uint power = 0;

   437

	uint weight = 0;

   438

   439

	assert(IsFrontEngine(v));

   440

   441

	weight = v->u.rail.cached_weight;

   442

	power = v->u.rail.cached_power;

   443

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

   444

   445

	assert(weight != 0);

   446

   447

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

   448

}

   449

   450

int GetTrainImage(const Vehicle* v, Direction direction)

   451

{

   452

	int img = v->spritenum;

   453

	int base;

   454

   455

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

   456

   457

	if (is_custom_sprite(img)) {

   458

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

   459

		if (base != 0) return base;

   460

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

   461

	}

   462

   463

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

   464

   465

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

   466

	return base;

   467

}

   468

   469

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

   470

{

   471

	const RailVehicleInfo *rvi = RailVehInfo(engine);

   472

   473

	int img = rvi->image_index;

   474

	uint32 image = 0;

   475

   476

	if (is_custom_sprite(img)) {

   477

		image = GetCustomVehicleIcon(engine, DIR_W);

   478

		if (image == 0) {

   479

			img = orig_rail_vehicle_info[engine].image_index;

   480

		} else {

   481

			y += _traininfo_vehicle_pitch;

   482

		}

   483

	}

   484

	if (image == 0) {

   485

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

   486