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

    12

#include "vehicle.h"

    13

#include "command.h"

    14

#include "pathfind.h"

    15

#include "npf.h"

    16

#include "station.h"

    17

#include "table/train_cmd.h"

    18

#include "news.h"

    19

#include "engine.h"

    20

#include "player.h"

    21

#include "sound.h"

    22

#include "depot.h"

    23

#include "waypoint.h"

    24

#include "vehicle_gui.h"

    25

#include "train.h"

    26

#include "newgrf_callbacks.h"

    27

#include "newgrf_engine.h"

    28

    29

static bool TrainCheckIfLineEnds(Vehicle *v);

    30

static void TrainController(Vehicle *v);

    31

    32

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

    33

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

    34

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

    35

    36

/**

    37

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

    38

 * the consist changes.

    39

 * @param v First vehicle of the consist.

    40

 */

    41

static void TrainCargoChanged(Vehicle* v)

    42

{

    43

	Vehicle *u;

    44

	uint16 weight = 0;

    45

    46

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

    47

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

    48

		uint16 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_ENGINE;

    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 v->first cache. This is faster than having to brute force it later.

    98

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

    99

   100

		// update the 'first engine'

   101

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

   102

   103

		if (rvi_u->visual_effect != 0) {

   104

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

   105

		} else {

   106

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

   107

				// Wagons and articulated parts have no effect by default

   108

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

   109

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

   110

				// Steam is offset by -4 units

   111

				u->u.rail.cached_vis_effect = 4;

   112

			} else {

   113

				// Diesel fumes and sparks come from the centre

   114

				u->u.rail.cached_vis_effect = 8;

   115

			}

   116

		}

   117

   118

		if (!IsArticulatedPart(u)) {

   119

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

   120

			power += rvi_u->power;

   121

   122

			// check if its a powered wagon

   123

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

   124

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

   125

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

   126

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

   127

   128

					if (callback != CALLBACK_FAILED)

   129

						u->u.rail.cached_vis_effect = callback;

   130

				}

   131

   132

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

   133

					/* wagon is powered */

   134

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

   135

					power += rvi_v->pow_wag_power;

   136

				}

   137

			}

   138

   139

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

   140

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

   141

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

   142

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

   143

		}

   144

   145

		// check the vehicle length (callback)

   146

		veh_len = CALLBACK_FAILED;

   147

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

   148

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

   149

		if (veh_len == CALLBACK_FAILED)

   150

			veh_len = rvi_u->shorten_factor;

   151

		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

   152

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

   153

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

   154

   155

	};

   156

   157

	// store consist weight/max speed in cache

   158

	v->u.rail.cached_max_speed = max_speed;

   159

	v->u.rail.cached_power = power;

   160

   161

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

   162

	TrainCargoChanged(v);

   163

}

   164

   165

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

   166

 * be interpreted? */

   167

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

   168

	{7, 1},

   169

	{0, 2},

   170

	{1, 3},

   171

	{2, 4},

   172

	{3, 5},

   173

	{4, 6},

   174

	{5, 7},

   175

	{6, 0},

   176

};

   177

   178

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

   179

	{6, 2},

   180

	{7, 3},

   181

	{0, 4},

   182

	{1, 5},

   183

	{2, 6},

   184

	{3, 7},

   185

	{4, 0},

   186

	{5, 1},

   187

};

   188

   189

enum AccelType {

   190

	AM_ACCEL,

   191

	AM_BRAKE

   192

};

   193

   194

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

   195

{

   196

	const Order* o = &v->current_order;

   197

   198

	assert(v->type == VEH_Train);

   199

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

   200

	//When does a train drive through a station

   201

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

   202

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

   203

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

   204

		return false;

   205

   206

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

   207

		return false;

   208

   209

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

   210

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

   211

		return false;

   212

   213

	return true;

   214

}

   215

   216

//new acceleration

   217

static int GetTrainAcceleration(Vehicle *v, bool mode)

   218

{

   219

	const Vehicle *u;

   220

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

   221

	int power = 0;

   222

	int mass = 0;

   223

	int max_speed = 2000;

   224

	int area = 120;

   225

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

   226

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

   227

	int incl = 0;

   228

	int resistance;

   229

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

   230

	int force = 0x3FFFFFFF;

   231

	int pos = 0;

   232

	int lastpos = -1;

   233

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

   234

	int sum = 0;

   235

	int numcurve = 0;

   236

   237

	speed *= 10;

   238

	speed /= 16;

   239

   240

	//first find the curve speed limit

   241

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

   242

		Direction dir = u->direction;

   243

		Direction ndir = u->next->direction;

   244

		int i;

   245

   246

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

   247

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

   248

				curvecount[i]++;

   249

				if (lastpos != -1) {

   250

					numcurve++;

   251

					sum += pos - lastpos;

   252

					if (pos - lastpos == 1) {

   253

						max_speed = 88;

   254

					}

   255

				}

   256

				lastpos = pos;

   257

			}

   258

		}

   259

   260

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

   261

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

   262

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

   263

			max_speed = 61;

   264

		}

   265

	}

   266

   267

	if (numcurve > 0) sum /= numcurve;

   268

   269

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

   270

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

   271

   272

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

   273

			max_speed = 0xFFFF;

   274

		} else if (total > 1) {

   275

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

   276

		}

   277

	}

   278

   279

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

   280

   281

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

   282

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

   283

			int station_length = 0;

   284

			TileIndex tile = v->tile;

   285

			int delta_v;

   286

   287

			max_speed = 120;

   288

			do {

   289

				station_length++;

   290

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

   291

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

   292

   293

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

   294

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

   295

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

   296

   297

			max_speed = max(max_speed, 25 * station_length);

   298

		}

   299

	}

   300

   301

	mass = v->u.rail.cached_weight;

   302

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

   303

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

   304

   305

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

   306

		num++;

   307

		drag_coeff += 3;

   308

   309

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

   310

   311

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

   312

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

   313

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

   314

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

   315

		}

   316

	}

   317

   318

	v->max_speed = max_speed;

   319

   320

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

   321

		resistance = 13 * mass / 10;

   322

		resistance += 60 * num;

   323

		resistance += friction * mass * speed / 1000;

   324

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

   325

	} else {

   326

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

   327

	}

   328

	resistance += incl;

   329

	resistance *= 4; //[N]

   330

   331

	if (speed > 0) {

   332

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

   333

			case RAILTYPE_RAIL:

   334

			case RAILTYPE_MONO:

   335

				force = power / speed; //[N]

   336

				force *= 22;

   337

				force /= 10;

   338

				break;

   339

   340

			case RAILTYPE_MAGLEV:

   341

				force = power / 25;

   342

				break;

   343

		}

   344

	} else {

   345

		//"kickoff" acceleration

   346

		force = (mass * 8) + resistance;

   347

	}

   348

   349

	if (force <= 0) force = 10000;

   350

   351

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

   352

   353

	if (mode == AM_ACCEL) {

   354

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

   355

	} else {

   356

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

   357

	}

   358

}

   359

   360

static void UpdateTrainAcceleration(Vehicle* v)

   361

{

   362

	uint power = 0;

   363

	uint weight = 0;

   364

   365

	assert(IsFrontEngine(v));

   366

   367

	weight = v->u.rail.cached_weight;

   368

	power = v->u.rail.cached_power;

   369

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

   370

   371

	assert(weight != 0);

   372

   373

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

   374

}

   375

   376

int GetTrainImage(const Vehicle* v, Direction direction)

   377

{

   378

	int img = v->spritenum;

   379

	int base;

   380

   381

	if (is_custom_sprite(img)) {

   382

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

   383

		if (base != 0) return base;

   384

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

   385

	}

   386

   387

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

   388

   389

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

   390

	return base;

   391

}

   392

   393

extern int _traininfo_vehicle_pitch;

   394

   395

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

   396

{

   397

	const RailVehicleInfo *rvi = RailVehInfo(engine);

   398

   399

	int img = rvi->image_index;

   400

	uint32 image = 0;

   401

   402

	if (is_custom_sprite(img)) {

   403

		image = GetCustomVehicleIcon(engine, 6);

   404

		if (image == 0) {

   405

			img = orig_rail_vehicle_info[engine].image_index;

   406

		} else {

   407

			y += _traininfo_vehicle_pitch;

   408

		}

   409

	}

   410

	if (image == 0) {

   411

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

   412

	}

   413

   414

	if (rvi->flags & RVI_MULTIHEAD) {

   415

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

   416

		x += 15;

   417

		image = 0;

   418

		if (is_custom_sprite(img)) {

   419

			image = GetCustomVehicleIcon(engine, 2);

   420

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

   421

		}

   422

		if (image == 0) {

   423

			image =

   424

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

   425

				_engine_sprite_base[img + 1];

   426

		}

   427

	}

   428

	DrawSprite(image | image_ormod, x, y);

   429

}

   430

   431

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

   432

{

   433

	uint16 callback;

   434

	uint i;

   435

   436

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

   437

   438

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

   439

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

   440

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

   441

	}

   442

   443

	return i - 1;

   444

}

   445

   446

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

   447

{

   448

	const RailVehicleInfo *rvi_artic;

   449

	EngineID engine_type;

   450

	Vehicle *v = vl[0];

   451

	Vehicle *u = v;

   452

	uint16 callback;

   453

	bool flip_image;

   454

	uint i;

   455

   456

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

   457

   458

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

   459

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

   460

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

   461

   462

		u->next = vl[i];

   463

		u = u->next;

   464

   465

		engine_type = GB(callback, 0, 7);

   466

		flip_image = HASBIT(callback, 7);

   467

		rvi_artic = RailVehInfo(engine_type);

   468

   469

		// get common values from first engine

   470

		u->direction = v->direction;

   471

		u->owner = v->owner;

   472

		u->tile = v->tile;

   473

		u->x_pos = v->x_pos;

   474

		u->y_pos = v->y_pos;

   475

		u->z_pos = v->z_pos;

   476

		u->z_height = v->z_height;

   477

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

   478

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

   479

		u->build_year = v->build_year;

   480

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

   481

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

   482

   483

		// get more settings from rail vehicle info

   484

		u->spritenum = rvi_artic->image_index;

   485

		if (flip_image) u->spritenum++;

   486

		u->cargo_type = rvi_artic->cargo_type;

   487

		u->cargo_cap = rvi_artic->capacity;

   488

		u->max_speed = 0;