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

    30

static bool TrainCheckIfLineEnds(Vehicle *v);

    31

static void TrainController(Vehicle *v);

    32

    33

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

    34

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

    35

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

    36

    37

/**

    38

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

    39

 * the consist changes.

    40

 * @param v First vehicle of the consist.

    41

 */

    42

static void TrainCargoChanged(Vehicle* v)

    43

{

    44

	Vehicle *u;

    45

	uint16 weight = 0;

    46

    47

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

    48

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

    49

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

    50

    51

		// Vehicle weight is not added for articulated parts.

    52

		if (!IsArticulatedPart(u)) {

    53

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

    54

			vweight += rvi->weight;

    55

    56

			// powered wagons have extra weight added

    57

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

    58

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

    59

		}

    60

    61

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

    62

		weight += vweight;

    63

    64

		// store vehicle weight in cache

    65

		u->u.rail.cached_veh_weight = vweight;

    66

	};

    67

    68

	// store consist weight in cache

    69

	v->u.rail.cached_weight = weight;

    70

}

    71

    72

/**

    73

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

    74

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

    75

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

    76

 * @param v First vehicle of the chain.

    77

 */

    78

void TrainConsistChanged(Vehicle* v)

    79

{

    80

	const RailVehicleInfo *rvi_v;

    81

	Vehicle *u;

    82

	uint16 max_speed = 0xFFFF;

    83

	uint32 power = 0;

    84

	EngineID first_engine;

    85

    86

	assert(v->type == VEH_Train);

    87

    88

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

    89

    90

	rvi_v = RailVehInfo(v->engine_type);

    91

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

    92

	v->u.rail.cached_total_length = 0;

    93

    94

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

    95

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

    96

		uint16 veh_len;

    97

    98

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

    99

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

   100

   101

		// update the 'first engine'

   102

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

   103

   104

		if (rvi_u->visual_effect != 0) {

   105

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

   106

		} else {

   107

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

   108

				// Wagons and articulated parts have no effect by default

   109

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

   110

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

   111

				// Steam is offset by -4 units

   112

				u->u.rail.cached_vis_effect = 4;

   113

			} else {

   114

				// Diesel fumes and sparks come from the centre

   115

				u->u.rail.cached_vis_effect = 8;

   116

			}

   117

		}

   118

   119

		if (!IsArticulatedPart(u)) {

   120

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

   121

			power += rvi_u->power;

   122

   123

			// check if its a powered wagon

   124

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

   125

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

   126

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

   127

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

   128

   129

					if (callback != CALLBACK_FAILED)

   130

						u->u.rail.cached_vis_effect = callback;

   131

				}

   132

   133

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

   134

					/* wagon is powered */

   135

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

   136

					power += rvi_v->pow_wag_power;

   137

				}

   138

			}

   139

   140

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

   141

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

   142

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

   143

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

   144

		}

   145

   146

		// check the vehicle length (callback)

   147

		veh_len = CALLBACK_FAILED;

   148

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

   149

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

   150

		if (veh_len == CALLBACK_FAILED)

   151

			veh_len = rvi_u->shorten_factor;

   152

		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

   153

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

   154

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

   155

   156

	};

   157

   158

	// store consist weight/max speed in cache

   159

	v->u.rail.cached_max_speed = max_speed;

   160

	v->u.rail.cached_power = power;

   161

   162

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

   163

	TrainCargoChanged(v);

   164

}

   165

   166

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

   167

 * be interpreted? */

   168

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

   169

	{7, 1},

   170

	{0, 2},

   171

	{1, 3},

   172

	{2, 4},

   173

	{3, 5},

   174

	{4, 6},

   175

	{5, 7},

   176

	{6, 0},

   177

};

   178

   179

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

   180

	{6, 2},

   181

	{7, 3},

   182

	{0, 4},

   183

	{1, 5},

   184

	{2, 6},

   185

	{3, 7},

   186

	{4, 0},

   187

	{5, 1},

   188

};

   189

   190

enum AccelType {

   191

	AM_ACCEL,

   192

	AM_BRAKE

   193

};

   194

   195

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

   196

{

   197

	const Order* o = &v->current_order;

   198

   199

	assert(v->type == VEH_Train);

   200

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

   201

	//When does a train drive through a station

   202

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

   203

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

   204

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

   205

		return false;

   206

   207

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

   208

		return false;

   209

   210

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

   211

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

   212

		return false;

   213

   214

	return true;

   215

}

   216

   217

//new acceleration

   218

static int GetTrainAcceleration(Vehicle *v, bool mode)

   219

{

   220

	const Vehicle *u;

   221

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

   222

	int power = 0;

   223

	int mass = 0;

   224

	int max_speed = 2000;

   225

	int area = 120;

   226

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

   227

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

   228

	int incl = 0;

   229

	int resistance;

   230

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

   231

	int force = 0x3FFFFFFF;

   232

	int pos = 0;

   233

	int lastpos = -1;

   234

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

   235

	int sum = 0;

   236

	int numcurve = 0;

   237

   238

	speed *= 10;

   239

	speed /= 16;

   240

   241

	//first find the curve speed limit

   242

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

   243

		Direction dir = u->direction;

   244

		Direction ndir = u->next->direction;

   245

		int i;

   246

   247

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

   248

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

   249

				curvecount[i]++;

   250

				if (lastpos != -1) {

   251

					numcurve++;

   252

					sum += pos - lastpos;

   253

					if (pos - lastpos == 1) {

   254

						max_speed = 88;

   255

					}

   256

				}

   257

				lastpos = pos;

   258

			}

   259

		}

   260

   261

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

   262

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

   263

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

   264

			max_speed = 61;

   265

		}

   266

	}

   267

   268

	if (numcurve > 0) sum /= numcurve;

   269

   270

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

   271

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

   272

   273

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

   274

			max_speed = 0xFFFF;

   275

		} else if (total > 1) {

   276

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

   277

		}

   278

	}

   279

   280

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

   281

   282

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

   283

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

   284

			int station_length = 0;

   285

			TileIndex tile = v->tile;

   286

			int delta_v;

   287

   288

			max_speed = 120;

   289

			do {

   290

				station_length++;

   291

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

   292

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

   293

   294

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

   295

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

   296

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

   297

   298

			max_speed = max(max_speed, 25 * station_length);

   299

		}

   300

	}

   301

   302

	mass = v->u.rail.cached_weight;

   303

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

   304

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

   305

   306

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

   307

		num++;

   308

		drag_coeff += 3;

   309

   310

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

   311

   312

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

   313

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

   314

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

   315

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

   316

		}

   317

	}

   318

   319

	v->max_speed = max_speed;

   320

   321

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

   322

		resistance = 13 * mass / 10;

   323

		resistance += 60 * num;

   324

		resistance += friction * mass * speed / 1000;

   325

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

   326

	} else {

   327

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

   328

	}

   329

	resistance += incl;

   330

	resistance *= 4; //[N]

   331

   332

	if (speed > 0) {

   333

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

   334

			case RAILTYPE_RAIL:

   335

			case RAILTYPE_MONO:

   336

				force = power / speed; //[N]

   337

				force *= 22;

   338

				force /= 10;

   339

				break;

   340

   341

			case RAILTYPE_MAGLEV:

   342

				force = power / 25;

   343

				break;

   344

		}

   345

	} else {

   346

		//"kickoff" acceleration

   347

		force = (mass * 8) + resistance;

   348

	}

   349

   350

	if (force <= 0) force = 10000;

   351

   352

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

   353

   354

	if (mode == AM_ACCEL) {

   355

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

   356

	} else {

   357

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

   358

	}

   359

}

   360

   361

static void UpdateTrainAcceleration(Vehicle* v)

   362

{

   363

	uint power = 0;

   364

	uint weight = 0;

   365

   366

	assert(IsFrontEngine(v));

   367

   368

	weight = v->u.rail.cached_weight;

   369

	power = v->u.rail.cached_power;

   370

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

   371

   372

	assert(weight != 0);

   373

   374

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

   375

}

   376

   377

int GetTrainImage(const Vehicle* v, Direction direction)

   378

{

   379

	int img = v->spritenum;

   380

	int base;

   381

   382

	if (is_custom_sprite(img)) {

   383

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

   384

		if (base != 0) return base;

   385

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

   386

	}

   387

   388

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

   389

   390

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

   391

	return base;

   392

}

   393

   394

extern int _traininfo_vehicle_pitch;

   395

   396

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

   397

{

   398

	const RailVehicleInfo *rvi = RailVehInfo(engine);

   399

   400

	int img = rvi->image_index;

   401

	uint32 image = 0;

   402

   403

	if (is_custom_sprite(img)) {

   404

		image = GetCustomVehicleIcon(engine, DIR_W);

   405

		if (image == 0) {

   406

			img = orig_rail_vehicle_info[engine].image_index;

   407

		} else {

   408

			y += _traininfo_vehicle_pitch;

   409

		}

   410

	}

   411

	if (image == 0) {

   412

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

   413

	}

   414

   415

	if (rvi->flags & RVI_MULTIHEAD) {

   416

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

   417

		x += 15;

   418

		image = 0;

   419

		if (is_custom_sprite(img)) {

   420

			image = GetCustomVehicleIcon(engine, 2);

   421

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

   422

		}

   423

		if (image == 0) {

   424

			image =

   425

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

   426

				_engine_sprite_base[img + 1];

   427

		}

   428

	}

   429

	DrawSprite(image | image_ormod, x, y);

   430

}

   431

   432

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

   433

{

   434

	uint16 callback;

   435

	uint i;

   436

   437

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

   438

   439

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

   440

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

   441

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

   442

	}

   443

   444

	return i - 1;

   445

}

   446

   447

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

   448

{

   449

	const RailVehicleInfo *rvi_artic;

   450

	EngineID engine_type;

   451

	Vehicle *v = vl[0];

   452

	Vehicle *u = v;

   453

	uint16 callback;

   454

	bool flip_image;

   455

	uint i;

   456

   457

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

   458

   459

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

   460

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

   461

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

   462

   463

		u->next = vl[i];

   464

		u = u->next;

   465

   466

		engine_type = GB(callback, 0, 7);

   467

		flip_image = HASBIT(callback, 7);

   468

		rvi_artic = RailVehInfo(engine_type);

   469

   470

		// get common values from first engine

   471

		u->direction = v->direction;

   472

		u->owner = v->owner;

   473

		u->tile = v->tile;

   474

		u->x_pos = v->x_pos;

   475

		u->y_pos = v->y_pos;

   476

		u->z_pos = v->z_pos;

   477

		u->z_height = v->z_height;

   478

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

   479

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

   480

		u->build_year = v->build_year;

   481

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

   482

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

   483

   484

		// get more settings from rail vehicle info

   485

		u->spritenum = rvi_artic->image_index;

   486

		if (flip_image) u->spritenum++;

   487

		u->cargo_type = rvi_artic->cargo_type;

   488