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_text.h"

    31

#include "direction.h"

    32

#include "yapf/yapf.h"

    33

    34

static bool TrainCheckIfLineEnds(Vehicle *v);

    35

static void TrainController(Vehicle *v);

    36

    37

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

    38

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

    39

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

    40

    41

/**

    42

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

    43

 * the consist changes.

    44

 * @param v First vehicle of the consist.

    45

 */

    46

static void TrainCargoChanged(Vehicle* v)

    47

{

    48

	Vehicle *u;

    49

	uint16 weight = 0;

    50

    51

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

    52

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

    53

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

    54

    55

		// Vehicle weight is not added for articulated parts.

    56

		if (!IsArticulatedPart(u)) {

    57

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

    58

			vweight += rvi->weight;

    59

    60

			// powered wagons have extra weight added

    61

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

    62

				vweight += RailVehInfo(v->engine_type)->pow_wag_weight;

    63

		}

    64

    65

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

    66

		weight += vweight;

    67

    68

		// store vehicle weight in cache

    69

		u->u.rail.cached_veh_weight = vweight;

    70

	};

    71

    72

	// store consist weight in cache

    73

	v->u.rail.cached_weight = weight;

    74

}

    75

    76

/**

    77

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

    78

 * @param v First vehicle of the consist.

    79

 */

    80

void TrainPowerChanged(Vehicle* v)

    81

{

    82

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

    83

	Vehicle* u;

    84

	uint32 power = 0;

    85

    86

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

    87

		const RailVehicleInfo *rvi_u;

    88

		bool engine_has_power = true;

    89

		bool wagon_has_power = true;

    90

    91

		/* Power is not added for articulated parts */

    92

		if (IsArticulatedPart(u)) continue;

    93

    94

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

    95

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

    96

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

    97

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

    98

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

    99

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

   100

		} else {

   101

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

   102

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

   103

		}

   104

   105

		rvi_u = RailVehInfo(u->engine_type);

   106

   107

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

   108

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

   109

			power += rvi_v->pow_wag_power;

   110

		}

   111

	}

   112

   113

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

   114

		v->u.rail.cached_power = power;

   115

		InvalidateWindow(WC_VEHICLE_DETAILS, v->index);

   116

	}

   117

}

   118

   119

/**

   120

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

   121

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

   122

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

   123

 * @param v First vehicle of the chain.

   124

 */

   125

void TrainConsistChanged(Vehicle* v)

   126

{

   127

	const RailVehicleInfo *rvi_v;

   128

	Vehicle *u;

   129

	uint16 max_speed = 0xFFFF;

   130

	EngineID first_engine;

   131

   132

	assert(v->type == VEH_Train);

   133

   134

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

   135

   136

	rvi_v = RailVehInfo(v->engine_type);

   137

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

   138

	v->u.rail.cached_total_length = 0;

   139

	v->u.rail.compatible_railtypes = 0;

   140

   141

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

   142

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

   143

		uint16 veh_len;

   144

   145

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

   146

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

   147

   148

		// update the 'first engine'

   149

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

   150

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

   151

   152

		if (rvi_u->visual_effect != 0) {

   153

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

   154

		} else {

   155

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

   156

				// Wagons and articulated parts have no effect by default

   157

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

   158

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

   159

				// Steam is offset by -4 units

   160

				u->u.rail.cached_vis_effect = 4;

   161

			} else {

   162

				// Diesel fumes and sparks come from the centre

   163

				u->u.rail.cached_vis_effect = 8;

   164

			}

   165

		}

   166

   167

		if (!IsArticulatedPart(u)) {

   168

			// check if its a powered wagon

   169

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

   170

   171

			/* Check powered wagon / visual effect callback */

   172

			if (HASBIT(rvi_u->callbackmask, CBM_WAGON_POWER)) {

   173

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

   174

   175

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

   176

			}

   177

   178

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

   179

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

   180

					/* wagon is powered */

   181

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

   182

				}

   183

			}

   184

   185

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

   186

			   have railtype normal */

   187

			if (rvi_u->power > 0) {

   188

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

   189

			}

   190

   191

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

   192

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

   193

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

   194

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

   195

		}

   196

   197

		// check the vehicle length (callback)

   198

		veh_len = CALLBACK_FAILED;

   199

		if (HASBIT(rvi_u->callbackmask, CBM_VEHICLE_LENGTH))

   200

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

   201

		if (veh_len == CALLBACK_FAILED)

   202

			veh_len = rvi_u->shorten_factor;

   203

		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

   204

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

   205

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

   206

   207

	};

   208

   209

	// store consist weight/max speed in cache

   210

	v->u.rail.cached_max_speed = max_speed;

   211

   212

	TrainPowerChanged(v);

   213

   214

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

   215

	TrainCargoChanged(v);

   216

}

   217

   218

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

   219

 * be interpreted? */

   220

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

   221

	{7, 1},

   222

	{0, 2},

   223

	{1, 3},

   224

	{2, 4},

   225

	{3, 5},

   226

	{4, 6},

   227

	{5, 7},

   228

	{6, 0},

   229

};

   230

   231

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

   232

	{6, 2},

   233

	{7, 3},

   234

	{0, 4},

   235

	{1, 5},

   236

	{2, 6},

   237

	{3, 7},

   238

	{4, 0},

   239

	{5, 1},

   240

};

   241

   242

enum AccelType {

   243

	AM_ACCEL,

   244

	AM_BRAKE

   245

};

   246

   247

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

   248

{

   249

	const Order* o = &v->current_order;

   250

	StationID sid = GetStationIndex(tile);

   251

   252

	assert(v->type == VEH_Train);

   253

	//When does a train drive through a station

   254

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

   255

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

   256

		return false;

   257

	}

   258

   259

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

   260

   261

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

   262

		return false;

   263

	}

   264

   265

	return true;

   266

}

   267

   268

//new acceleration

   269

static int GetTrainAcceleration(Vehicle *v, bool mode)

   270

{

   271

	const Vehicle *u;

   272

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

   273

	int power = 0;

   274

	int mass = 0;

   275

	int max_speed = 2000;

   276

	int area = 120;

   277

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

   278

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

   279

	int incl = 0;

   280

	int resistance;

   281

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

   282

	int force = 0x3FFFFFFF;

   283

	int pos = 0;

   284

	int lastpos = -1;

   285

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

   286

	int sum = 0;

   287

	int numcurve = 0;

   288

   289

	speed *= 10;

   290

	speed /= 16;

   291

   292

	//first find the curve speed limit

   293

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

   294

		Direction dir = u->direction;

   295

		Direction ndir = u->next->direction;

   296

		int i;

   297

   298

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

   299

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

   300

				curvecount[i]++;

   301

				if (lastpos != -1) {

   302

					numcurve++;

   303

					sum += pos - lastpos;

   304

					if (pos - lastpos == 1) {

   305

						max_speed = 88;

   306

					}

   307

				}

   308

				lastpos = pos;

   309

			}

   310

		}

   311

   312

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

   313

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

   314

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

   315

			max_speed = 61;

   316

		}

   317

	}

   318

   319

	if (numcurve > 0) sum /= numcurve;

   320

   321

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

   322

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

   323

   324

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

   325

			max_speed = 0xFFFF;

   326

		} else if (total > 1) {

   327

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

   328

		}

   329

	}

   330

   331

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

   332

   333

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

   334

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

   335

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

   336

			int delta_v;

   337

   338

			max_speed = 120;

   339

   340

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

   341

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

   342

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

   343

   344

			max_speed = max(max_speed, 25 * station_length);

   345

		}

   346

	}

   347

   348

	mass = v->u.rail.cached_weight;

   349

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

   350

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

   351

   352

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

   353

		num++;

   354

		drag_coeff += 3;

   355

   356

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

   357

   358

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

   359

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

   360

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

   361

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

   362

		}

   363

	}

   364

   365

	v->max_speed = max_speed;

   366

   367

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

   368

		resistance = 13 * mass / 10;

   369

		resistance += 60 * num;

   370

		resistance += friction * mass * speed / 1000;

   371

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

   372

	} else {

   373

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

   374

	}

   375

	resistance += incl;

   376

	resistance *= 4; //[N]

   377

   378

	if (speed > 0) {

   379

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

   380

			case RAILTYPE_RAIL:

   381

			case RAILTYPE_ELECTRIC:

   382

			case RAILTYPE_MONO:

   383

				force = power / speed; //[N]

   384

				force *= 22;

   385

				force /= 10;

   386

				break;

   387

   388

			case RAILTYPE_MAGLEV:

   389

				force = power / 25;

   390

				break;

   391

		}

   392

	} else {

   393

		//"kickoff" acceleration

   394

		force = (mass * 8) + resistance;

   395

	}

   396

   397

	if (force <= 0) force = 10000;

   398

   399

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

   400

   401

	if (mode == AM_ACCEL) {

   402

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

   403

	} else {

   404

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

   405

	}

   406

}

   407

   408

static void UpdateTrainAcceleration(Vehicle* v)

   409

{

   410

	uint power = 0;

   411

	uint weight = 0;

   412

   413

	assert(IsFrontEngine(v));

   414

   415

	weight = v->u.rail.cached_weight;

   416

	power = v->u.rail.cached_power;

   417

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

   418

   419

	assert(weight != 0);

   420

   421

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

   422

}

   423

   424

int GetTrainImage(const Vehicle* v, Direction direction)

   425

{

   426

	int img = v->spritenum;

   427

	int base;

   428

   429

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

   430

   431

	if (is_custom_sprite(img)) {

   432

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

   433

		if (base != 0) return base;

   434

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

   435

	}

   436

   437

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

   438

   439

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

   440

	return base;

   441

}

   442

   443

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

   444

{

   445

	const RailVehicleInfo *rvi = RailVehInfo(engine);

   446

   447

	int img = rvi->image_index;

   448

	uint32 image = 0;

   449

   450

	if (is_custom_sprite(img)) {

   451

		image = GetCustomVehicleIcon(engine, DIR_W);

   452

		if (image == 0) {

   453

			img = orig_rail_vehicle_info[engine].image_index;

   454

		} else {

   455

			y += _traininfo_vehicle_pitch;

   456

		}

   457

	}

   458

	if (image == 0) {

   459

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

   460

	}

   461

   462

	if (rvi->flags & RVI_MULTIHEAD) {

   463

		DrawSprite(image | image_ormod, x - 14, y);

   464

		x += 15;

   465

		image = 0;

   466

		if (is_custom_sprite(img)) {

   467

			image = GetCustomVehicleIcon(engine, 2);

   468

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

   469

		}

   470

		if (image == 0) {

   471

			image =

   472

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

   473

				_engine_sprite_base[img + 1];

   474

		}

   475

	}

   476

	DrawSprite(image | image_ormod, x, y);

   477

}

   478

   479

static uint CountArticulatedParts(const RailVehicleInfo *rvi, EngineID engine_type)

   480

{

   481

	uint16 callback;

   482

	uint i;

   483

   484

	if (!HASBIT(rvi->callbackmask, CBM_ARTIC_ENGINE)) return 0;

   485

   486

	for (i = 1; i < 10; i++) {

   487

		callback = GetVehicleCallback(CBID_TRAIN_ARTIC_ENGINE, i, 0, engine_type, NULL);