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 "table/strings.h"

    10

#include "map.h"

    11

#include "tile.h"

    12

#include "tunnel_map.h"

    13

#include "vehicle.h"

    14

#include "command.h"

    15

#include "pathfind.h"

    16

#include "npf.h"

    17

#include "station.h"

    18

#include "table/train_cmd.h"

    19

#include "news.h"

    20

#include "engine.h"

    21

#include "player.h"

    22

#include "sound.h"

    23

#include "depot.h"

    24

#include "waypoint.h"

    25

#include "vehicle_gui.h"

    26

#include "train.h"

    27

#include "newgrf_callbacks.h"

    28

#include "newgrf_engine.h"

    29

#include "direction.h"

    30

    31

static bool TrainCheckIfLineEnds(Vehicle *v);

    32

static void TrainController(Vehicle *v);

    33

    34

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

    35

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

    36

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

    37

    38

/**

    39

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

    40

 * the consist changes.

    41

 * @param v First vehicle of the consist.

    42

 */

    43

static void TrainCargoChanged(Vehicle* v)

    44

{

    45

	Vehicle *u;

    46

	uint16 weight = 0;

    47

    48

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

    49

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

    50

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

    51

    52

		// Vehicle weight is not added for articulated parts.

    53

		if (!IsArticulatedPart(u)) {

    54

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

    55

			vweight += rvi->weight;

    56

    57

			// powered wagons have extra weight added

    58

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

    59

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

    60

		}

    61

    62

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

    63

		weight += vweight;

    64

    65

		// store vehicle weight in cache

    66

		u->u.rail.cached_veh_weight = vweight;

    67

	};

    68

    69

	// store consist weight in cache

    70

	v->u.rail.cached_weight = weight;

    71

}

    72

    73

/**

    74

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

    75

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

    76

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

    77

 * @param v First vehicle of the chain.

    78

 */

    79

void TrainConsistChanged(Vehicle* v)

    80

{

    81

	const RailVehicleInfo *rvi_v;

    82

	Vehicle *u;

    83

	uint16 max_speed = 0xFFFF;

    84

	uint32 power = 0;

    85

	EngineID first_engine;

    86

    87

	assert(v->type == VEH_Train);

    88

    89

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

    90

    91

	rvi_v = RailVehInfo(v->engine_type);

    92

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

    93

	v->u.rail.cached_total_length = 0;

    94

    95

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

    96

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

    97

		uint16 veh_len;

    98

    99

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

   100

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

   101

   102

		// update the 'first engine'

   103

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

   104

   105

		if (rvi_u->visual_effect != 0) {

   106

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

   107

		} else {

   108

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

   109

				// Wagons and articulated parts have no effect by default

   110

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

   111

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

   112

				// Steam is offset by -4 units

   113

				u->u.rail.cached_vis_effect = 4;

   114

			} else {

   115

				// Diesel fumes and sparks come from the centre

   116

				u->u.rail.cached_vis_effect = 8;

   117

			}

   118

		}

   119

   120

		if (!IsArticulatedPart(u)) {

   121

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

   122

			power += rvi_u->power;

   123

   124

			// check if its a powered wagon

   125

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

   126

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

   127

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

   128

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

   129

   130

					if (callback != CALLBACK_FAILED)

   131

						u->u.rail.cached_vis_effect = callback;

   132

				}

   133

   134

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

   135

					/* wagon is powered */

   136

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

   137

					power += rvi_v->pow_wag_power;

   138

				}

   139

			}

   140

   141

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

   142

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

   143

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

   144

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

   145

		}

   146

   147

		// check the vehicle length (callback)

   148

		veh_len = CALLBACK_FAILED;

   149

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

   150

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

   151

		if (veh_len == CALLBACK_FAILED)

   152

			veh_len = rvi_u->shorten_factor;

   153

		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

   154

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

   155

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

   156

   157

	};

   158

   159

	// store consist weight/max speed in cache

   160

	v->u.rail.cached_max_speed = max_speed;

   161

	v->u.rail.cached_power = power;

   162

   163

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

   164

	TrainCargoChanged(v);

   165

}

   166

   167

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

   168

 * be interpreted? */

   169

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

   170

	{7, 1},

   171

	{0, 2},

   172

	{1, 3},

   173

	{2, 4},

   174

	{3, 5},

   175

	{4, 6},

   176

	{5, 7},

   177

	{6, 0},

   178

};

   179

   180

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

   181

	{6, 2},

   182

	{7, 3},

   183

	{0, 4},

   184

	{1, 5},

   185

	{2, 6},

   186

	{3, 7},

   187

	{4, 0},

   188

	{5, 1},

   189

};

   190

   191

enum AccelType {

   192

	AM_ACCEL,

   193

	AM_BRAKE

   194

};

   195

   196

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

   197

{

   198

	const Order* o = &v->current_order;

   199

   200

	assert(v->type == VEH_Train);

   201

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

   202

	//When does a train drive through a station

   203

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

   204

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

   205

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

   206

		return false;

   207

   208

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

   209

		return false;

   210

   211

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

   212

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

   213

		return false;

   214

   215

	return true;

   216

}

   217

   218

//new acceleration

   219

static int GetTrainAcceleration(Vehicle *v, bool mode)

   220

{

   221

	const Vehicle *u;

   222

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

   223

	int power = 0;

   224

	int mass = 0;

   225

	int max_speed = 2000;

   226

	int area = 120;

   227

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

   228

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

   229

	int incl = 0;

   230

	int resistance;

   231

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

   232

	int force = 0x3FFFFFFF;

   233

	int pos = 0;

   234

	int lastpos = -1;

   235

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

   236

	int sum = 0;

   237

	int numcurve = 0;

   238

   239

	speed *= 10;

   240

	speed /= 16;

   241

   242

	//first find the curve speed limit

   243

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

   244

		Direction dir = u->direction;

   245

		Direction ndir = u->next->direction;

   246

		int i;

   247

   248

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

   249

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

   250

				curvecount[i]++;

   251

				if (lastpos != -1) {

   252

					numcurve++;

   253

					sum += pos - lastpos;

   254

					if (pos - lastpos == 1) {

   255

						max_speed = 88;

   256

					}

   257

				}

   258

				lastpos = pos;

   259

			}

   260

		}

   261

   262

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

   263

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

   264

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

   265

			max_speed = 61;

   266

		}

   267

	}

   268

   269

	if (numcurve > 0) sum /= numcurve;

   270

   271

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

   272

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

   273

   274

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

   275

			max_speed = 0xFFFF;

   276

		} else if (total > 1) {

   277

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

   278

		}

   279

	}

   280

   281

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

   282

   283

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

   284

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

   285

			int station_length = 0;

   286

			TileIndex tile = v->tile;

   287

			int delta_v;

   288

   289

			max_speed = 120;

   290

			do {

   291

				station_length++;

   292

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

   293

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

   294

   295

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

   296

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

   297

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

   298

   299

			max_speed = max(max_speed, 25 * station_length);

   300

		}

   301

	}

   302

   303

	mass = v->u.rail.cached_weight;

   304

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

   305

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

   306

   307

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

   308

		num++;

   309

		drag_coeff += 3;

   310

   311

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

   312

   313

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

   314

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

   315

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

   316

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

   317

		}

   318

	}

   319

   320

	v->max_speed = max_speed;

   321

   322

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

   323

		resistance = 13 * mass / 10;

   324

		resistance += 60 * num;

   325

		resistance += friction * mass * speed / 1000;

   326

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

   327

	} else {

   328

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

   329

	}

   330

	resistance += incl;

   331

	resistance *= 4; //[N]

   332

   333

	if (speed > 0) {

   334

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

   335

			case RAILTYPE_RAIL:

   336

			case RAILTYPE_MONO:

   337

				force = power / speed; //[N]

   338

				force *= 22;

   339

				force /= 10;

   340

				break;

   341

   342

			case RAILTYPE_MAGLEV:

   343

				force = power / 25;

   344

				break;

   345

		}

   346

	} else {

   347

		//"kickoff" acceleration

   348

		force = (mass * 8) + resistance;

   349

	}

   350

   351

	if (force <= 0) force = 10000;

   352

   353

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

   354

   355

	if (mode == AM_ACCEL) {

   356

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

   357

	} else {

   358

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

   359

	}

   360

}

   361

   362

static void UpdateTrainAcceleration(Vehicle* v)

   363

{

   364

	uint power = 0;

   365

	uint weight = 0;

   366

   367

	assert(IsFrontEngine(v));

   368

   369

	weight = v->u.rail.cached_weight;

   370

	power = v->u.rail.cached_power;

   371

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

   372

   373

	assert(weight != 0);

   374

   375

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

   376

}

   377

   378

int GetTrainImage(const Vehicle* v, Direction direction)

   379

{

   380

	int img = v->spritenum;

   381

	int base;

   382

   383

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

   384

   385

	if (is_custom_sprite(img)) {

   386

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

   387

		if (base != 0) return base;

   388

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

   389

	}

   390

   391

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

   392

   393

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

   394

	return base;

   395

}

   396

   397

extern int _traininfo_vehicle_pitch;

   398

   399

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

   400

{

   401

	const RailVehicleInfo *rvi = RailVehInfo(engine);

   402

   403

	int img = rvi->image_index;

   404

	uint32 image = 0;

   405

   406

	if (is_custom_sprite(img)) {

   407

		image = GetCustomVehicleIcon(engine, DIR_W);

   408

		if (image == 0) {

   409

			img = orig_rail_vehicle_info[engine].image_index;

   410

		} else {

   411

			y += _traininfo_vehicle_pitch;

   412

		}

   413

	}

   414

	if (image == 0) {

   415

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

   416

	}

   417

   418

	if (rvi->flags & RVI_MULTIHEAD) {

   419

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

   420

		x += 15;

   421

		image = 0;

   422

		if (is_custom_sprite(img)) {

   423

			image = GetCustomVehicleIcon(engine, 2);

   424

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

   425

		}

   426

		if (image == 0) {

   427

			image =

   428

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

   429

				_engine_sprite_base[img + 1];

   430

		}

   431

	}

   432

	DrawSprite(image | image_ormod, x, y);

   433

}

   434

   435

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

   436

{

   437

	uint16 callback;

   438

	uint i;

   439

   440

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

   441

   442

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

   443

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

   444

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

   445

	}

   446

   447

	return i - 1;

   448

}

   449

   450

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

   451

{

   452

	const RailVehicleInfo *rvi_artic;

   453

	EngineID engine_type;

   454

	Vehicle *v = vl[0];

   455

	Vehicle *u = v;

   456

	uint16 callback;

   457

	bool flip_image;

   458

	uint i;

   459

   460

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

   461

   462

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

   463

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

   464

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

   465

   466

		u->next = vl[i];

   467

		u = u->next;

   468

   469

		engine_type = GB(callback, 0, 7);

   470

		flip_image = HASBIT(callback, 7);

   471

		rvi_artic = RailVehInfo(engine_type);

   472

   473

		// get common values from first engine

   474

		u->direction = v->direction;

   475

		u->owner = v->owner;

   476

		u->tile = v->tile;

   477

		u->x_pos = v->x_pos;

   478

		u->y_pos = v->y_pos;

   479

		u->z_pos = v->z_pos;

   480

		u->z_height = v->z_height;

   481

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

   482

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

   483

		u->build_year = v->build_year;

   484

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

   485

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

   486

   487

		// get more settings from rail vehicle info