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

    29

#include "newgrf_callbacks.h"

    30

#include "newgrf_engine.h"

    31

#include "newgrf_text.h"

    32

#include "direction.h"

    33

#include "yapf/yapf.h"

    34

    35

static bool TrainCheckIfLineEnds(Vehicle *v);

    36

static void TrainController(Vehicle *v);

    37

    38

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

    39

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

    40

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

    41

    42

/**

    43

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

    44

 * the consist changes.

    45

 * @param v First vehicle of the consist.

    46

 */

    47

static void TrainCargoChanged(Vehicle* v)

    48

{

    49

	Vehicle *u;

    50

	uint16 weight = 0;

    51

    52

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

    53

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

    54

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

    55

    56

		// Vehicle weight is not added for articulated parts.

    57

		if (!IsArticulatedPart(u)) {

    58

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

    59

			vweight += rvi->weight;

    60

    61

			// powered wagons have extra weight added

    62

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

    63

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

    64

		}

    65

    66

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

    67

		weight += vweight;

    68

    69

		// store vehicle weight in cache

    70

		u->u.rail.cached_veh_weight = vweight;

    71

	};

    72

    73

	// store consist weight in cache

    74

	v->u.rail.cached_weight = weight;

    75

}

    76

    77

/**

    78

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

    79

 * @param v First vehicle of the consist.

    80

 */

    81

void TrainPowerChanged(Vehicle* v)

    82

{

    83

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

    84

	Vehicle* u;

    85

	uint32 power = 0;

    86

    87

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

    88

		const RailVehicleInfo *rvi_u;

    89

		bool engine_has_power = true;

    90

		bool wagon_has_power = true;

    91

    92

		/* Power is not added for articulated parts */

    93

		if (IsArticulatedPart(u)) continue;

    94

    95

		if (IsLevelCrossingTile(u->tile)) {

    96

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

    97

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

    98

		} else {

    99

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

   100

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

   101

		}

   102

   103

		rvi_u = RailVehInfo(u->engine_type);

   104

   105

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

   106

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

   107

			power += rvi_v->pow_wag_power;

   108

		}

   109

	}

   110

   111

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

   112

		v->u.rail.cached_power = power;

   113

		InvalidateWindow(WC_VEHICLE_DETAILS, v->index);

   114

	}

   115

}

   116

   117

/**

   118

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

   119

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

   120

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

   121

 * @param v First vehicle of the chain.

   122

 */

   123

void TrainConsistChanged(Vehicle* v)

   124

{

   125

	const RailVehicleInfo *rvi_v;

   126

	Vehicle *u;

   127

	uint16 max_speed = 0xFFFF;

   128

	EngineID first_engine;

   129

   130

	assert(v->type == VEH_Train);

   131

   132

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

   133

   134

	rvi_v = RailVehInfo(v->engine_type);

   135

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

   136

	v->u.rail.cached_total_length = 0;

   137

	v->u.rail.compatible_railtypes = 0;

   138

   139

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

   140

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

   141

		uint16 veh_len;

   142

   143

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

   144

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

   145

   146

		// update the 'first engine'

   147

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

   148

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

   149

   150

		if (rvi_u->visual_effect != 0) {

   151

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

   152

		} else {

   153

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

   154

				// Wagons and articulated parts have no effect by default

   155

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

   156

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

   157

				// Steam is offset by -4 units

   158

				u->u.rail.cached_vis_effect = 4;

   159

			} else {

   160

				// Diesel fumes and sparks come from the centre

   161

				u->u.rail.cached_vis_effect = 8;

   162

			}

   163

		}

   164

   165

		if (!IsArticulatedPart(u)) {

   166

			// check if its a powered wagon

   167

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

   168

   169

			/* Check powered wagon / visual effect callback */

   170

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

   171

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

   172

   173

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

   174

			}

   175

   176

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

   177

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

   178

					/* wagon is powered */

   179

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

   180

				}

   181

			}

   182

   183

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

   184

			   have railtype normal */

   185

			if (rvi_u->power > 0) {

   186

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

   187

			}

   188

   189

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

   190

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

   191

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

   192

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

   193

		}

   194

   195

		// check the vehicle length (callback)

   196

		veh_len = CALLBACK_FAILED;

   197

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

   198

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

   199

		if (veh_len == CALLBACK_FAILED)

   200

			veh_len = rvi_u->shorten_factor;

   201

		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

   202

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

   203

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

   204

   205

	};

   206

   207

	// store consist weight/max speed in cache

   208

	v->u.rail.cached_max_speed = max_speed;

   209

   210

	TrainPowerChanged(v);

   211

   212

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

   213

	TrainCargoChanged(v);

   214

}

   215

   216

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

   217

 * be interpreted? */

   218

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

   219

	{7, 1},

   220

	{0, 2},

   221

	{1, 3},

   222

	{2, 4},

   223

	{3, 5},

   224

	{4, 6},

   225

	{5, 7},

   226

	{6, 0},

   227

};

   228

   229

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

   230

	{6, 2},

   231

	{7, 3},

   232

	{0, 4},

   233

	{1, 5},

   234

	{2, 6},

   235

	{3, 7},

   236

	{4, 0},

   237

	{5, 1},

   238

};

   239

   240

enum AccelType {

   241

	AM_ACCEL,

   242

	AM_BRAKE

   243

};

   244

   245

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

   246

{

   247

	const Order* o = &v->current_order;

   248

	StationID sid = GetStationIndex(tile);

   249

   250

	assert(v->type == VEH_Train);

   251

	//When does a train drive through a station

   252

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

   253

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

   254

		return false;

   255

	}

   256

   257

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

   258

   259

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

   260

		return false;

   261

	}

   262

   263

	return true;

   264

}

   265

   266

//new acceleration

   267

static int GetTrainAcceleration(Vehicle *v, bool mode)

   268

{

   269

	const Vehicle *u;

   270

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

   271

	int power = 0;

   272

	int mass = 0;

   273

	int max_speed = 2000;

   274

	int area = 120;

   275

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

   276

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

   277

	int incl = 0;

   278

	int resistance;

   279

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

   280

	int force = 0x3FFFFFFF;

   281

	int pos = 0;

   282

	int lastpos = -1;

   283

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

   284

	int sum = 0;

   285

	int numcurve = 0;

   286

   287

	speed *= 10;

   288

	speed /= 16;

   289

   290

	//first find the curve speed limit

   291

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

   292

		Direction dir = u->direction;

   293

		Direction ndir = u->next->direction;

   294

		int i;

   295

   296

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

   297

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

   298

				curvecount[i]++;

   299

				if (lastpos != -1) {

   300

					numcurve++;

   301

					sum += pos - lastpos;

   302

					if (pos - lastpos == 1) {

   303

						max_speed = 88;

   304

					}

   305

				}

   306

				lastpos = pos;

   307

			}

   308

		}

   309

   310

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

   311

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

   312

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

   313

			max_speed = 61;

   314

		}

   315

	}

   316

   317

	if (numcurve > 0) sum /= numcurve;

   318

   319

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

   320

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

   321

   322

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

   323

			max_speed = 0xFFFF;

   324

		} else if (total > 1) {

   325

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

   326

		}

   327

	}

   328

   329

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

   330

   331

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

   332

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

   333

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

   334

			int delta_v;

   335

   336

			max_speed = 120;

   337

   338

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

   339

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

   340

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

   341

   342

			max_speed = max(max_speed, 25 * station_length);

   343

		}

   344

	}

   345

   346

	mass = v->u.rail.cached_weight;

   347

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

   348

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

   349

   350

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

   351

		num++;

   352

		drag_coeff += 3;

   353

   354

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

   355

   356

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

   357

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

   358

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

   359

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

   360

		}

   361

	}

   362

   363

	v->max_speed = max_speed;

   364

   365

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

   366

		resistance = 13 * mass / 10;

   367

		resistance += 60 * num;

   368

		resistance += friction * mass * speed / 1000;

   369

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

   370

	} else {

   371

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

   372

	}

   373

	resistance += incl;

   374

	resistance *= 4; //[N]

   375

   376

	if (speed > 0) {

   377

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

   378

			case RAILTYPE_RAIL:

   379

			case RAILTYPE_ELECTRIC:

   380

			case RAILTYPE_MONO:

   381

				force = power / speed; //[N]

   382

				force *= 22;

   383

				force /= 10;

   384

				break;

   385

   386

			case RAILTYPE_MAGLEV:

   387

				force = power / 25;

   388

				break;

   389

		}

   390

	} else {

   391

		//"kickoff" acceleration

   392

		force = (mass * 8) + resistance;

   393

	}

   394

   395

	if (force <= 0) force = 10000;

   396

   397

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

   398

   399

	if (mode == AM_ACCEL) {

   400

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

   401

	} else {

   402

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

   403

	}

   404

}

   405

   406

static void UpdateTrainAcceleration(Vehicle* v)

   407

{

   408

	uint power = 0;

   409

	uint weight = 0;

   410

   411

	assert(IsFrontEngine(v));

   412

   413

	weight = v->u.rail.cached_weight;

   414

	power = v->u.rail.cached_power;

   415

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

   416

   417

	assert(weight != 0);

   418

   419

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

   420

}

   421

   422

int GetTrainImage(const Vehicle* v, Direction direction)

   423

{

   424

	int img = v->spritenum;

   425

	int base;

   426

   427

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

   428

   429

	if (is_custom_sprite(img)) {

   430

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

   431

		if (base != 0) return base;

   432

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

   433

	}

   434

   435

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

   436

   437

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

   438

	return base;

   439

}

   440

   441

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

   442

{

   443

	const RailVehicleInfo *rvi = RailVehInfo(engine);

   444

   445

	int img = rvi->image_index;

   446

	uint32 image = 0;

   447

   448

	if (is_custom_sprite(img)) {

   449

		image = GetCustomVehicleIcon(engine, DIR_W);

   450

		if (image == 0) {

   451

			img = orig_rail_vehicle_info[engine].image_index;

   452

		} else {

   453

			y += _traininfo_vehicle_pitch;

   454

		}

   455

	}

   456

	if (image == 0) {

   457

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

   458

	}

   459

   460

	if (rvi->flags & RVI_MULTIHEAD) {

   461

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

   462

		x += 15;

   463

		image = 0;

   464

		if (is_custom_sprite(img)) {

   465

			image = GetCustomVehicleIcon(engine, 2);

   466

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

   467

		}

   468

		if (image == 0) {

   469

			image =

   470

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

   471

				_engine_sprite_base[img + 1];

   472

		}

   473

	}

   474

	DrawSprite(image | image_ormod, x, y);

   475

}

   476

   477

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

   478

{

   479

	uint16 callback;

   480

	uint i;

   481

   482

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

   483

   484

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

   485

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

   486

		if (callback == CALLBACK_FAILED || callback == 0xFF) break;

   487

	}