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

    23

#include "vehicle_gui.h"

    24

#include "train.h"

    25

#include "newgrf_callbacks.h"

    26

#include "newgrf_engine.h"

    27

    28

static bool TrainCheckIfLineEnds(Vehicle *v);

    29

static void TrainController(Vehicle *v);

    30

    31

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

    32

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

    33

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

    34

    35

/**

    36

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

    37

 * the consist changes.

    38

 * @param v First vehicle of the consist.

    39

 */

    40

static void TrainCargoChanged(Vehicle* v)

    41

{

    42

	Vehicle *u;

    43

	uint16 weight = 0;

    44

    45

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

    46

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

    47

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

    48

    49

		// Vehicle weight is not added for articulated parts.

    50

		if (!IsArticulatedPart(u)) {

    51

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

    52

			vweight += rvi->weight;

    53

    54

			// powered wagons have extra weight added

    55

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

    56

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

    57

		}

    58

    59

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

    60

		weight += vweight;

    61

    62

		// store vehicle weight in cache

    63

		u->u.rail.cached_veh_weight = vweight;

    64

	};

    65

    66

	// store consist weight in cache

    67

	v->u.rail.cached_weight = weight;

    68

}

    69

    70

/**

    71

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

    72

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

    73

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

    74

 * @param v First vehicle of the chain.

    75

 */

    76

void TrainConsistChanged(Vehicle* v)

    77

{

    78

	const RailVehicleInfo *rvi_v;

    79

	Vehicle *u;

    80

	uint16 max_speed = 0xFFFF;

    81

	uint32 power = 0;

    82

	EngineID first_engine;

    83

    84

	assert(v->type == VEH_Train);

    85

    86

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

    87

    88

	rvi_v = RailVehInfo(v->engine_type);

    89

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

    90

	v->u.rail.cached_total_length = 0;

    91

    92

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

    93

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

    94

		uint16 veh_len;

    95

    96

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

    97

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

    98

    99

		// update the 'first engine'

   100

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

   101

   102

		if (rvi_u->visual_effect != 0) {

   103

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

   104

		} else {

   105

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

   106

				// Wagons and articulated parts have no effect by default

   107

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

   108

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

   109

				// Steam is offset by -4 units

   110

				u->u.rail.cached_vis_effect = 4;

   111

			} else {

   112

				// Diesel fumes and sparks come from the centre

   113

				u->u.rail.cached_vis_effect = 8;

   114

			}

   115

		}

   116

   117

		if (!IsArticulatedPart(u)) {

   118

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

   119

			power += rvi_u->power;

   120

   121

			// check if its a powered wagon

   122

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

   123

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

   124

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

   125

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

   126

   127

					if (callback != CALLBACK_FAILED)

   128

						u->u.rail.cached_vis_effect = callback;

   129

				}

   130

   131

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

   132

					/* wagon is powered */

   133

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

   134

					power += rvi_v->pow_wag_power;

   135

				}

   136

			}

   137

   138

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

   139

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

   140

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

   141

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

   142

		}

   143

   144

		// check the vehicle length (callback)

   145

		veh_len = CALLBACK_FAILED;

   146

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

   147

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

   148

		if (veh_len == CALLBACK_FAILED)

   149

			veh_len = rvi_u->shorten_factor;

   150

		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

   151

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

   152

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

   153

   154

	};

   155

   156

	// store consist weight/max speed in cache

   157

	v->u.rail.cached_max_speed = max_speed;

   158

	v->u.rail.cached_power = power;

   159

   160

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

   161

	TrainCargoChanged(v);

   162

}

   163

   164

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

   165

 * be interpreted? */

   166

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

   167

	{7, 1},

   168

	{0, 2},

   169

	{1, 3},

   170

	{2, 4},

   171

	{3, 5},

   172

	{4, 6},

   173

	{5, 7},

   174

	{6, 0},

   175

};

   176

   177

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

   178

	{6, 2},

   179

	{7, 3},

   180

	{0, 4},

   181

	{1, 5},

   182

	{2, 6},

   183

	{3, 7},

   184

	{4, 0},

   185

	{5, 1},

   186

};

   187

   188

enum AccelType {

   189

	AM_ACCEL,

   190

	AM_BRAKE

   191

};

   192

   193

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

   194

{

   195

	const Order* o = &v->current_order;

   196

   197

	assert(v->type == VEH_Train);

   198

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

   199

	//When does a train drive through a station

   200

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

   201

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

   202

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

   203

		return false;

   204

   205

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

   206

		return false;

   207

   208

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

   209

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

   210

		return false;

   211

   212

	return true;

   213

}

   214

   215

//new acceleration

   216

static int GetTrainAcceleration(Vehicle *v, bool mode)

   217

{

   218

	const Vehicle *u;

   219

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

   220

	int power = 0;

   221

	int mass = 0;

   222

	int max_speed = 2000;

   223

	int area = 120;

   224

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

   225

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

   226

	int incl = 0;

   227

	int resistance;

   228

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

   229

	int force = 0x3FFFFFFF;

   230

	int pos = 0;

   231

	int lastpos = -1;

   232

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

   233

	int sum = 0;

   234

	int numcurve = 0;

   235

   236

	speed *= 10;

   237

	speed /= 16;

   238

   239

	//first find the curve speed limit

   240

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

   241

		int dir = u->direction;

   242

		int ndir = u->next->direction;

   243

		int i;

   244

   245

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

   246

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

   247

				curvecount[i]++;

   248

				if (lastpos != -1) {

   249

					numcurve++;

   250

					sum += pos - lastpos;

   251

					if (pos - lastpos == 1) {

   252

						max_speed = 88;

   253

					}

   254

				}

   255

				lastpos = pos;

   256

			}

   257

		}

   258

   259

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

   260

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

   261

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

   262

			max_speed = 61;

   263

		}

   264

	}

   265

   266

	if (numcurve > 0) sum /= numcurve;

   267

   268

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

   269

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

   270

   271

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

   272

			max_speed = 0xFFFF;

   273

		} else if (total > 1) {

   274

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

   275

		}

   276

	}

   277

   278

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

   279

   280

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

   281

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

   282

			int station_length = 0;

   283

			TileIndex tile = v->tile;

   284

			int delta_v;

   285

   286

			max_speed = 120;

   287

			do {

   288

				station_length++;

   289

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

   290

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

   291

   292

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

   293

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

   294

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

   295

   296

			max_speed = max(max_speed, 25 * station_length);

   297

		}

   298

	}

   299

   300

	mass = v->u.rail.cached_weight;

   301

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

   302

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

   303

   304

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

   305

		num++;

   306

		drag_coeff += 3;

   307

   308

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

   309

   310

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

   311

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

   312

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

   313

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

   314

		}

   315

	}

   316

   317

	v->max_speed = max_speed;

   318

   319

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

   320

		resistance = 13 * mass / 10;

   321

		resistance += 60 * num;

   322

		resistance += friction * mass * speed / 1000;

   323

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

   324

	} else {

   325

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

   326

	}

   327

	resistance += incl;

   328

	resistance *= 4; //[N]

   329

   330

	if (speed > 0) {

   331

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

   332

			case RAILTYPE_RAIL:

   333

			case RAILTYPE_MONO:

   334

				force = power / speed; //[N]

   335

				force *= 22;

   336

				force /= 10;

   337

				break;

   338

   339

			case RAILTYPE_MAGLEV:

   340

				force = power / 25;

   341

				break;

   342

		}

   343

	} else {

   344

		//"kickoff" acceleration

   345

		force = (mass * 8) + resistance;

   346

	}

   347

   348

	if (force <= 0) force = 10000;

   349

   350

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

   351

   352

	if (mode == AM_ACCEL) {

   353

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

   354

	} else {

   355

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

   356

	}

   357

}

   358

   359

static void UpdateTrainAcceleration(Vehicle* v)

   360

{

   361

	uint power = 0;

   362

	uint weight = 0;

   363

   364

	assert(IsFrontEngine(v));

   365

   366

	weight = v->u.rail.cached_weight;

   367

	power = v->u.rail.cached_power;

   368

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

   369

   370

	assert(weight != 0);

   371

   372

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

   373

}

   374

   375

int GetTrainImage(const Vehicle *v, byte direction)

   376

{

   377

	int img = v->spritenum;

   378

	int base;

   379

   380

	if (is_custom_sprite(img)) {

   381

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

   382

		if (base != 0) return base;

   383

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

   384

	}

   385

   386

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

   387

   388

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

   389

	return base;

   390

}

   391

   392

extern int _traininfo_vehicle_pitch;

   393

   394

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

   395

{

   396

	const RailVehicleInfo *rvi = RailVehInfo(engine);

   397

   398

	int img = rvi->image_index;

   399

	uint32 image = 0;

   400

   401

	if (is_custom_sprite(img)) {

   402

		image = GetCustomVehicleIcon(engine, 6);

   403

		if (image == 0) {

   404

			img = orig_rail_vehicle_info[engine].image_index;

   405

		} else {

   406

			y += _traininfo_vehicle_pitch;

   407

		}

   408

	}

   409

	if (image == 0) {

   410

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

   411

	}

   412

   413

	if (rvi->flags & RVI_MULTIHEAD) {

   414

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

   415

		x += 15;

   416

		image = 0;

   417

		if (is_custom_sprite(img)) {

   418

			image = GetCustomVehicleIcon(engine, 2);

   419

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

   420

		}

   421

		if (image == 0) {

   422

			image =

   423

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

   424

				_engine_sprite_base[img + 1];

   425

		}

   426

	}

   427

	DrawSprite(image | image_ormod, x, y);

   428

}

   429

   430

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

   431

{

   432

	uint16 callback;

   433

	uint i;

   434

   435

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

   436

   437

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

   438

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

   439

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

   440

	}

   441

   442

	return i - 1;

   443

}

   444

   445

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

   446

{

   447

	const RailVehicleInfo *rvi_artic;

   448

	EngineID engine_type;

   449

	Vehicle *v = vl[0];

   450

	Vehicle *u = v;

   451

	uint16 callback;

   452

	bool flip_image;

   453

	uint i;

   454

   455

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

   456

   457

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

   458

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

   459

		if (callback == CALLBACK_FAILED || callback == 0xFF) 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;