1

/* $Id$ */

     2

     3

#include "stdafx.h"

     4

#include "openttd.h"

     5

#include "debug.h"

     6

#include "functions.h"

     7

#include "gui.h"

     8

#include "table/strings.h"

     9

#include "map.h"

    10

#include "tile.h"

    11

#include "vehicle.h"

    12

#include "command.h"

    13

#include "pathfind.h"

    14

#include "npf.h"

    15

#include "station.h"

    16

#include "table/train_cmd.h"

    17

#include "news.h"

    18

#include "engine.h"

    19

#include "player.h"

    20

#include "sound.h"

    21

#include "depot.h"

    22

#include "debug.h"

    23

#include "waypoint.h"

    24

#include "vehicle_gui.h"

    25

#include "train.h"

    26

    27

static bool TrainCheckIfLineEnds(Vehicle *v);

    28

static void TrainController(Vehicle *v);

    29

    30

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

    31

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

    32

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

    33

    34

/**

    35

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

    36

 * the consist changes.

    37

 * @param v First vehicle of the consist.

    38

 */

    39

static void TrainCargoChanged(Vehicle* v)

    40

{

    41

	Vehicle *u;

    42

	uint16 weight = 0;

    43

    44

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

    45

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

    46

		uint16 vweight = 0;

    47

    48

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

    49

    50

		// Vehicle weight is not added for articulated parts.

    51

		if (!IsArticulatedPart(u)) {

    52

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

    53

			vweight += rvi->weight;

    54

    55

			// powered wagons have extra weight added

    56

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

    57

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

    58

		}

    59

    60

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

    61

		weight += vweight;

    62

    63

		// store vehicle weight in cache

    64

		u->u.rail.cached_veh_weight = vweight;

    65

	};

    66

    67

	// store consist weight in cache

    68

	v->u.rail.cached_weight = weight;

    69

}

    70

    71

/**

    72

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

    73

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

    74

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

    75

 * @param v First vehicle of the chain.

    76

 */

    77

void TrainConsistChanged(Vehicle* v)

    78

{

    79

	const RailVehicleInfo *rvi_v;

    80

	Vehicle *u;

    81

	uint16 max_speed = 0xFFFF;

    82

	uint32 power = 0;

    83

	EngineID first_engine;

    84

    85

	assert(v->type == VEH_Train);

    86

    87

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

    88

    89

	rvi_v = RailVehInfo(v->engine_type);

    90

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

    91

	v->u.rail.cached_total_length = 0;

    92

    93

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

    94

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

    95

		uint16 veh_len;

    96

    97

		// update the 'first engine'

    98

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

    99

   100

		if (rvi_u->visual_effect != 0) {

   101

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

   102

		} else {

   103

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

   104

				// Wagons and articulated parts have no effect by default

   105

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

   106

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

   107

				// Steam is offset by -4 units

   108

				u->u.rail.cached_vis_effect = 4;

   109

			} else {

   110

				// Diesel fumes and sparks come from the centre

   111

				u->u.rail.cached_vis_effect = 8;

   112

			}

   113

		}

   114

   115

		if (!IsArticulatedPart(u)) {

   116

			// power is the sum of the powers of all engines and powered wagons in the consist

   117

			power += rvi_u->power;

   118

   119

			// check if its a powered wagon

   120

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

   121

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

   122

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

   123

					uint16 callback = GetCallBackResult(CBID_WAGON_POWER,  u->engine_type, u);

   124

   125

					if (callback != CALLBACK_FAILED)

   126

						u->u.rail.cached_vis_effect = callback;

   127

				}

   128

   129

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

   130

					/* wagon is powered */

   131

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

   132

					power += rvi_v->pow_wag_power;

   133

				}

   134

			}

   135

   136

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

   137

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

   138

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

   139

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

   140

		}

   141

   142

		// check the vehicle length (callback)

   143

		veh_len = CALLBACK_FAILED;

   144

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

   145

			veh_len = GetCallBackResult(CBID_VEH_LENGTH,  u->engine_type, u);

   146

		if (veh_len == CALLBACK_FAILED)

   147

			veh_len = rvi_u->shorten_factor;

   148

		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

   149

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

   150

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

   151

   152

	};

   153

   154

	// store consist weight/max speed in cache

   155

	v->u.rail.cached_max_speed = max_speed;

   156

	v->u.rail.cached_power = power;

   157

   158

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

   159

	TrainCargoChanged(v);

   160

}

   161

   162

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

   163

 * be interpreted? */

   164

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

   165

	{7, 1},

   166

	{0, 2},

   167

	{1, 3},

   168

	{2, 4},

   169

	{3, 5},

   170

	{4, 6},

   171

	{5, 7},

   172

	{6, 0},

   173

};

   174

   175

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

   176

	{6, 2},

   177

	{7, 3},

   178

	{0, 4},

   179

	{1, 5},

   180

	{2, 6},

   181

	{3, 7},

   182

	{4, 0},

   183

	{5, 1},

   184

};

   185

   186

enum AccelType {

   187

	AM_ACCEL,

   188

	AM_BRAKE

   189

};

   190

   191

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

   192

{

   193

	const Order* o = &v->current_order;

   194

   195

	assert(v->type == VEH_Train);

   196

	assert(IsTileType(v->tile, MP_STATION));

   197

	//When does a train drive through a station

   198

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

   199

	if (_patches.new_nonstop && o->flags & OF_NON_STOP &&

   200

			_m[tile].m2 == o->station )

   201

		return false;

   202

   203

	if (v->last_station_visited == _m[tile].m2)

   204

		return false;

   205

   206

	if (_m[tile].m2 != o->station &&

   207

			(o->flags & OF_NON_STOP || _patches.new_nonstop))

   208

		return false;

   209

   210

	return true;

   211

}

   212

   213

//new acceleration

   214

static int GetTrainAcceleration(Vehicle *v, bool mode)

   215

{

   216

	const Vehicle *u;

   217

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

   218

	int power = 0;

   219

	int mass = 0;

   220

	int max_speed = 2000;

   221

	int area = 120;

   222

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

   223

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

   224

	int incl = 0;

   225

	int resistance;

   226

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

   227

	int force = 0x3FFFFFFF;

   228

	int pos = 0;

   229

	int lastpos = -1;

   230

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

   231

	int sum = 0;

   232

	int numcurve = 0;

   233

   234

	speed *= 10;

   235

	speed /= 16;

   236

   237

	//first find the curve speed limit

   238

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

   239

		int dir = u->direction;

   240

		int ndir = u->next->direction;

   241

		int i;

   242

   243

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

   244

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

   245

				curvecount[i]++;

   246

				if (lastpos != -1) {

   247

					numcurve++;

   248

					sum += pos - lastpos;

   249

					if (pos - lastpos == 1) {

   250

						max_speed = 88;

   251

					}

   252

				}

   253

				lastpos = pos;

   254

			}

   255

		}

   256

   257

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

   258

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

   259

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

   260

			max_speed = 61;

   261

		}

   262

	}

   263

   264

	if (numcurve > 0) sum /= numcurve;

   265

   266

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

   267

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

   268

   269

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

   270

			max_speed = 0xFFFF;

   271

		} else if (total > 1) {

   272

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

   273

		}

   274

	}

   275

   276

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

   277

   278

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

   279

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

   280

			int station_length = 0;

   281

			TileIndex tile = v->tile;

   282

			int delta_v;

   283

   284

			max_speed = 120;

   285

			do {

   286

				station_length++;

   287

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

   288

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

   289

   290

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

   291

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

   292

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

   293

   294

			max_speed = max(max_speed, 25 * station_length);

   295

		}

   296

	}

   297

   298

	mass = v->u.rail.cached_weight;

   299

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

   300

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

   301

   302

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

   303

		num++;

   304

		drag_coeff += 3;

   305

   306

		if (u->u.rail.track == 0x80)

   307

			max_speed = min(61, max_speed);

   308

   309

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

   310

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

   311

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

   312

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

   313

		}

   314

	}

   315

   316

	v->max_speed = max_speed;

   317

   318

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

   319

		resistance = 13 * mass / 10;

   320

		resistance += 60 * num;

   321

		resistance += friction * mass * speed / 1000;

   322

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

   323

	} else

   324

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

   325

	resistance += incl;

   326

	resistance *= 4; //[N]

   327

   328

	if (speed > 0) {

   329

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

   330

			case RAILTYPE_RAIL:

   331

			case RAILTYPE_MONO:

   332

				force = power / speed; //[N]

   333

				force *= 22;

   334

				force /= 10;

   335

				break;

   336

   337

			case RAILTYPE_MAGLEV:

   338

				force = power / 25;

   339

				break;

   340

		}

   341

	} else {

   342

		//"kickoff" acceleration

   343

		force = (mass * 8) + resistance;

   344

	}

   345

   346

	if (force <= 0) force = 10000;

   347

   348

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

   349

   350

	if (mode == AM_ACCEL) {

   351

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

   352

	} else {

   353

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

   354

	}

   355

}

   356

   357

static void UpdateTrainAcceleration(Vehicle* v)

   358

{

   359

	uint power = 0;

   360

	uint weight = 0;

   361

   362

	assert(IsFrontEngine(v));

   363

   364

	weight = v->u.rail.cached_weight;

   365

	power = v->u.rail.cached_power;

   366

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

   367

   368

	assert(weight != 0);

   369

   370

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

   371

}

   372

   373

int GetTrainImage(const Vehicle *v, byte direction)

   374

{

   375

	int img = v->spritenum;

   376

	int base;

   377

   378

	if (is_custom_sprite(img)) {

   379

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

   380

		if (base != 0) return base;

   381

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

   382

	}

   383

   384

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

   385

   386

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

   387

	return base;

   388

}

   389

   390

extern int _traininfo_vehicle_pitch;

   391

   392

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

   393

{

   394

	const RailVehicleInfo *rvi = RailVehInfo(engine);

   395

   396

	int img = rvi->image_index;

   397

	uint32 image = 0;

   398

   399

	if (is_custom_sprite(img)) {

   400

		image = GetCustomVehicleIcon(engine, 6);

   401

		if (image == 0) {

   402

			img = orig_rail_vehicle_info[engine].image_index;

   403

		} else {

   404

			y += _traininfo_vehicle_pitch;

   405

		}

   406

	}

   407

	if (image == 0) {

   408

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

   409

	}

   410

   411

	if (rvi->flags & RVI_MULTIHEAD) {

   412

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

   413

		x += 15;

   414

		image = 0;

   415

		if (is_custom_sprite(img)) {

   416

			image = GetCustomVehicleIcon(engine, 2);

   417

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

   418

		}

   419

		if (image == 0) {

   420

			image =

   421

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

   422

				_engine_sprite_base[img + 1];

   423

		}

   424

	}

   425

	DrawSprite(image | image_ormod, x, y);

   426

}

   427

   428

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

   429

{

   430

	uint16 callback;

   431

	uint i;

   432

   433

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

   434

   435

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

   436

		callback = GetCallBackResult(CBID_ARTIC_ENGINE + (i << 8), engine_type, NULL);

   437

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

   438

	}

   439

   440

	return i - 1;

   441

}

   442

   443

static void AddArticulatedParts(const RailVehicleInfo *rvi, Vehicle **vl)

   444

{

   445

	const RailVehicleInfo *rvi_artic;

   446

	EngineID engine_type;

   447

	Vehicle *v = vl[0];

   448

	Vehicle *u = v;

   449

	uint16 callback;

   450

	bool flip_image;

   451

	uint i;

   452

   453

	if (!HASBIT(rvi->callbackmask, CBM_ARTIC_ENGINE))

   454

		return;

   455

   456

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

   457

		callback = GetCallBackResult(CBID_ARTIC_ENGINE + (i << 8), v->engine_type, NULL);

   458

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

   459

			return;

   460

   461

		u->next = vl[i];

   462

		u = u->next;

   463

   464

		engine_type = GB(callback, 0, 7);

   465

		flip_image = HASBIT(callback, 7);

   466

		rvi_artic = RailVehInfo(engine_type);

   467

   468

		// get common values from first engine

   469

		u->direction = v->direction;

   470

		u->owner = v->owner;

   471

		u->tile = v->tile;

   472

		u->x_pos = v->x_pos;

   473

		u->y_pos = v->y_pos;

   474

		u->z_pos = v->z_pos;

   475

		u->z_height = v->z_height;

   476

		u->u.rail.track = v->u.rail.track;

   477

		u->u.rail.railtype = v->u.rail.railtype;

   478

		u->build_year = v->build_year;

   479

		u->vehstatus = v->vehstatus & ~VS_STOPPED;

   480

		u->u.rail.first_engine = v->engine_type;

   481

   482

		// get more settings from rail vehicle info

   483

		u->spritenum = rvi_artic->image_index;

   484

		if (flip_image) u->spritenum++;

   485

		u->cargo_type = rvi_artic->cargo_type;

   486

		u->cargo_cap = rvi_artic->capacity;

   487

		u->max_speed = 0;

   488

		u->max_age = 0;

   489

		u->engine_type = engine_type;