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

    31

    32

static bool TrainCheckIfLineEnds(Vehicle *v);

    33

static void TrainController(Vehicle *v);

    34

    35

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

    36

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

    37

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

    38

    39

/**

    40

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

    41

 * the consist changes.

    42

 * @param v First vehicle of the consist.

    43

 */

    44

static void TrainCargoChanged(Vehicle* v)

    45

{

    46

	Vehicle *u;

    47

	uint16 weight = 0;

    48

    49

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

    50

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

    51

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

    52

    53

		// Vehicle weight is not added for articulated parts.

    54

		if (!IsArticulatedPart(u)) {

    55

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

    56

			vweight += rvi->weight;

    57

    58

			// powered wagons have extra weight added

    59

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

    60

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

    61

		}

    62

    63

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

    64

		weight += vweight;

    65

    66

		// store vehicle weight in cache

    67

		u->u.rail.cached_veh_weight = vweight;

    68

	};

    69

    70

	// store consist weight in cache

    71

	v->u.rail.cached_weight = weight;

    72

}

    73

    74

/**

    75

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

    76

 * @param v First vehicle of the consist.

    77

 */

    78

void TrainPowerChanged(Vehicle* v)

    79

{

    80

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

    81

	Vehicle* u;

    82

	uint32 power = 0;

    83

    84

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

    85

		const RailVehicleInfo *rvi_u;

    86

		bool engine_has_power = true;

    87

		bool wagon_has_power = true;

    88

    89

		/* Power is not added for articulated parts */

    90

		if (IsArticulatedPart(u)) continue;

    91

    92

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

    93

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

    94

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

    95

		} else {

    96

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

    97

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

    98

		}

    99

   100

		rvi_u = RailVehInfo(u->engine_type);

   101

   102

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

   103

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

   104

			power += rvi_v->pow_wag_power;

   105

		}

   106

	}

   107

   108

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

   109

		v->u.rail.cached_power = power;

   110

		InvalidateWindow(WC_VEHICLE_DETAILS, v->index);

   111

	}

   112

}

   113

   114

/**

   115

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

   116

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

   117

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

   118

 * @param v First vehicle of the chain.

   119

 */

   120

void TrainConsistChanged(Vehicle* v)

   121

{

   122

	const RailVehicleInfo *rvi_v;

   123

	Vehicle *u;

   124

	uint16 max_speed = 0xFFFF;

   125

	EngineID first_engine;

   126

   127

	assert(v->type == VEH_Train);

   128

   129

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

   130

   131

	rvi_v = RailVehInfo(v->engine_type);

   132

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

   133

	v->u.rail.cached_total_length = 0;

   134

	v->u.rail.compatible_railtypes = 0;

   135

   136

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

   137

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

   138

		uint16 veh_len;

   139

   140

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

   141

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

   142

   143

		// update the 'first engine'

   144

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

   145

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

   146

   147

		if (rvi_u->visual_effect != 0) {

   148

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

   149

		} else {

   150

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

   151

				// Wagons and articulated parts have no effect by default

   152

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

   153

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

   154

				// Steam is offset by -4 units

   155

				u->u.rail.cached_vis_effect = 4;

   156

			} else {

   157

				// Diesel fumes and sparks come from the centre

   158

				u->u.rail.cached_vis_effect = 8;

   159

			}

   160

		}

   161

   162

		if (!IsArticulatedPart(u)) {

   163

			// check if its a powered wagon

   164

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

   165

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

   166

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

   167

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

   168

   169

					if (callback != CALLBACK_FAILED)

   170

						u->u.rail.cached_vis_effect = callback;

   171

				}

   172

   173

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

   174

					/* wagon is powered */

   175

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

   176

				}

   177

			}

   178

   179

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

   180

			   have railtype normal */

   181

			if (rvi_u->power > 0) {

   182

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

   183

			}

   184

   185

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

   186

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

   187

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

   188

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

   189

		}

   190

   191

		// check the vehicle length (callback)

   192

		veh_len = CALLBACK_FAILED;

   193

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

   194

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

   195

		if (veh_len == CALLBACK_FAILED)

   196

			veh_len = rvi_u->shorten_factor;

   197

		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

   198

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

   199

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

   200

   201

	};

   202

   203

	// store consist weight/max speed in cache

   204

	v->u.rail.cached_max_speed = max_speed;

   205

   206

	TrainPowerChanged(v);

   207

   208

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

   209

	TrainCargoChanged(v);

   210

}

   211

   212

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

   213

 * be interpreted? */

   214

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

   215

	{7, 1},

   216

	{0, 2},

   217

	{1, 3},

   218

	{2, 4},

   219

	{3, 5},

   220

	{4, 6},

   221

	{5, 7},

   222

	{6, 0},

   223

};

   224

   225

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

   226

	{6, 2},

   227

	{7, 3},

   228

	{0, 4},

   229

	{1, 5},

   230

	{2, 6},

   231

	{3, 7},

   232

	{4, 0},

   233

	{5, 1},

   234

};

   235

   236

enum AccelType {

   237

	AM_ACCEL,

   238

	AM_BRAKE

   239

};

   240

   241

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

   242

{

   243

	const Order* o = &v->current_order;

   244

	StationID sid = GetStationIndex(tile);

   245

   246

	assert(v->type == VEH_Train);

   247

	//When does a train drive through a station

   248

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

   249

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

   250

		return false;

   251

	}

   252

   253

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

   254

   255

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

   256

		return false;

   257

	}

   258

   259

	return true;

   260

}

   261

   262

//new acceleration

   263

static int GetTrainAcceleration(Vehicle *v, bool mode)

   264

{

   265

	const Vehicle *u;

   266

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

   267

	int power = 0;

   268

	int mass = 0;

   269

	int max_speed = 2000;

   270

	int area = 120;

   271

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

   272

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

   273

	int incl = 0;

   274

	int resistance;

   275

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

   276

	int force = 0x3FFFFFFF;

   277

	int pos = 0;

   278

	int lastpos = -1;

   279

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

   280

	int sum = 0;

   281

	int numcurve = 0;

   282

   283

	speed *= 10;

   284

	speed /= 16;

   285

   286

	//first find the curve speed limit

   287

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

   288

		Direction dir = u->direction;

   289

		Direction ndir = u->next->direction;

   290

		int i;

   291

   292

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

   293

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

   294

				curvecount[i]++;

   295

				if (lastpos != -1) {

   296

					numcurve++;

   297

					sum += pos - lastpos;

   298

					if (pos - lastpos == 1) {

   299

						max_speed = 88;

   300

					}

   301

				}

   302

				lastpos = pos;

   303

			}

   304

		}

   305

   306

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

   307

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

   308

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

   309

			max_speed = 61;

   310

		}

   311

	}

   312

   313

	if (numcurve > 0) sum /= numcurve;

   314

   315

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

   316

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

   317

   318

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

   319

			max_speed = 0xFFFF;

   320

		} else if (total > 1) {

   321

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

   322

		}

   323

	}

   324

   325

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

   326

   327

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

   328

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

   329

			int station_length = 0;

   330

			TileIndex tile = v->tile;

   331

			int delta_v;

   332

   333

			max_speed = 120;

   334

			do {

   335

				station_length++;

   336

				tile = TILE_ADD(tile, TileOffsByDir(v->direction / 2));

   337

			} while (IsCompatibleTrainStationTile(tile, v->tile));

   338

   339

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

   340

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

   341

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

   342

   343

			max_speed = max(max_speed, 25 * station_length);

   344

		}

   345

	}

   346

   347

	mass = v->u.rail.cached_weight;

   348

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

   349

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

   350

   351

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

   352

		num++;

   353

		drag_coeff += 3;

   354

   355

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

   356

   357

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

   358

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

   359

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

   360

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

   361

		}

   362

	}

   363

   364

	v->max_speed = max_speed;

   365

   366

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

   367

		resistance = 13 * mass / 10;

   368

		resistance += 60 * num;

   369

		resistance += friction * mass * speed / 1000;

   370

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

   371

	} else {

   372

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

   373

	}

   374

	resistance += incl;

   375

	resistance *= 4; //[N]

   376

   377

	if (speed > 0) {

   378

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

   379

			case RAILTYPE_RAIL:

   380

			case RAILTYPE_ELECTRIC:

   381

			case RAILTYPE_MONO:

   382

				force = power / speed; //[N]

   383

				force *= 22;

   384

				force /= 10;

   385

				break;

   386

   387

			case RAILTYPE_MAGLEV:

   388

				force = power / 25;

   389

				break;

   390

		}

   391

	} else {

   392

		//"kickoff" acceleration

   393

		force = (mass * 8) + resistance;

   394

	}

   395

   396

	if (force <= 0) force = 10000;

   397

   398

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

   399

   400

	if (mode == AM_ACCEL) {

   401

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

   402

	} else {

   403

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

   404

	}

   405

}

   406

   407

static void UpdateTrainAcceleration(Vehicle* v)

   408

{

   409

	uint power = 0;

   410

	uint weight = 0;

   411

   412

	assert(IsFrontEngine(v));

   413

   414

	weight = v->u.rail.cached_weight;

   415

	power = v->u.rail.cached_power;

   416

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

   417

   418

	assert(weight != 0);

   419

   420

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

   421

}

   422

   423

int GetTrainImage(const Vehicle* v, Direction direction)

   424

{

   425

	int img = v->spritenum;

   426

	int base;

   427

   428

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

   429

   430

	if (is_custom_sprite(img)) {

   431

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

   432

		if (base != 0) return base;

   433

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

   434

	}

   435

   436

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

   437

   438

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

   439

	return base;

   440

}

   441

   442

extern int _traininfo_vehicle_pitch;

   443

   444

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

   445

{

   446

	const RailVehicleInfo *rvi = RailVehInfo(engine);

   447

   448

	int img = rvi->image_index;

   449

	uint32 image = 0;

   450

   451

	if (is_custom_sprite(img)) {

   452

		image = GetCustomVehicleIcon(engine, DIR_W);

   453

		if (image == 0) {

   454

			img = orig_rail_vehicle_info[engine].image_index;

   455

		} else {

   456

			y += _traininfo_vehicle_pitch;

   457

		}

   458

	}

   459

	if (image == 0) {

   460

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

   461

	}

   462

   463

	if (rvi->flags & RVI_MULTIHEAD) {

   464

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

   465

		x += 15;

   466

		image = 0;

   467

		if (is_custom_sprite(img)) {

   468

			image = GetCustomVehicleIcon(engine, 2);

   469

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

   470

		}

   471

		if (image == 0) {

   472

			image =

   473

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

   474

				_engine_sprite_base[img + 1];

   475

		}

   476

	}

   477

	DrawSprite(image | image_ormod, x, y);

   478

}

   479

   480

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

   481

{

   482

	uint16 callback;

   483

	uint i;

   484

   485

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

   486

   487

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

   488