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

    10

#include "table/strings.h"

    11

#include "map.h"

    12

#include "tile.h"

    13

#include "tunnel_map.h"

    14

#include "vehicle.h"

    15

#include "command.h"

    16

#include "pathfind.h"

    17

#include "npf.h"

    18

#include "station.h"

    19

#include "table/train_cmd.h"

    20

#include "news.h"

    21

#include "engine.h"

    22

#include "player.h"

    23

#include "sound.h"

    24

#include "depot.h"

    25

#include "waypoint.h"

    26

#include "vehicle_gui.h"

    27

#include "train.h"

    28

#include "newgrf_callbacks.h"

    29

#include "newgrf_engine.h"

    30

#include "newgrf_text.h"

    31

#include "direction.h"

    32

#include "yapf/yapf.h"

    33

    34

static bool TrainCheckIfLineEnds(Vehicle *v);

    35

static void TrainController(Vehicle *v);

    36

    37

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

    38

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

    39

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

    40

    41

/**

    42

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

    43

 * the consist changes.

    44

 * @param v First vehicle of the consist.

    45

 */

    46

static void TrainCargoChanged(Vehicle* v)

    47

{

    48

	Vehicle *u;

    49

	uint16 weight = 0;

    50

    51

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

    52

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

    53

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

    54

    55

		// Vehicle weight is not added for articulated parts.

    56

		if (!IsArticulatedPart(u)) {

    57

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

    58

			vweight += rvi->weight;

    59

    60

			// powered wagons have extra weight added

    61

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

    62

				vweight += RailVehInfo(u->u.rail.first_engine)->pow_wag_weight;

    63

		}

    64

    65

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

    66

		weight += vweight;

    67

    68

		// store vehicle weight in cache

    69

		u->u.rail.cached_veh_weight = vweight;

    70

	};

    71

    72

	// store consist weight in cache

    73

	v->u.rail.cached_weight = weight;

    74

}

    75

    76

/**

    77

 * Recalculates the cached total power of a train. Should be called when the consist is changed

    78

 * @param v First vehicle of the consist.

    79

 */

    80

void TrainPowerChanged(Vehicle* v)

    81

{

    82

	Vehicle* u;

    83

	uint32 power = 0;

    84

    85

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

    86

		const RailVehicleInfo *rvi_u;

    87

		bool engine_has_power = true;

    88

		bool wagon_has_power = true;

    89

    90

		/* Power is not added for articulated parts */

    91

		if (IsArticulatedPart(u)) continue;

    92

    93

		if (IsBridgeTile(u->tile) && IsBridgeMiddle(u->tile) && DiagDirToAxis(DirToDiagDir(u->direction)) == GetBridgeAxis(u->tile)) {

    94

			if (!HasPowerOnRail(u->u.rail.railtype, GetRailTypeOnBridge(u->tile))) engine_has_power = false;

    95

			if (!HasPowerOnRail(v->u.rail.railtype, GetRailTypeOnBridge(u->tile))) wagon_has_power = false;

    96

		} else if (IsLevelCrossingTile(u->tile)) {

    97

			if (!HasPowerOnRail(u->u.rail.railtype, GetRailTypeCrossing(u->tile)))	engine_has_power = false;

    98

			if (!HasPowerOnRail(v->u.rail.railtype, GetRailTypeCrossing(u->tile)))	wagon_has_power = false;

    99

		} else {

   100

			if (!HasPowerOnRail(u->u.rail.railtype, GetRailType(u->tile))) engine_has_power = false;

   101

			if (!HasPowerOnRail(v->u.rail.railtype, GetRailType(u->tile))) wagon_has_power = false;

   102

		}

   103

   104

		rvi_u = RailVehInfo(u->engine_type);

   105

   106

		if (engine_has_power) power += rvi_u->power;

   107

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

   108

			power += RailVehInfo(u->u.rail.first_engine)->pow_wag_power;

   109

		}

   110

	}

   111

   112

	if (v->u.rail.cached_power != power) {

   113

		v->u.rail.cached_power = power;

   114

		InvalidateWindow(WC_VEHICLE_DETAILS, v->index);

   115

	}

   116

}

   117

   118

/**

   119

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

   120

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

   121

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

   122

 * @param v First vehicle of the chain.

   123

 */

   124

void TrainConsistChanged(Vehicle* v)

   125

{

   126

	const RailVehicleInfo *rvi_v;

   127

	Vehicle *u;

   128

	uint16 max_speed = 0xFFFF;

   129

	EngineID first_engine;

   130

   131

	assert(v->type == VEH_Train);

   132

   133

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

   134

   135

	rvi_v = RailVehInfo(v->engine_type);

   136

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

   137

	v->u.rail.cached_total_length = 0;

   138

	v->u.rail.compatible_railtypes = 0;

   139

   140

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

   141

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

   142

		uint16 veh_len;

   143

   144

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

   145

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

   146

   147

		// update the 'first engine'

   148

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

   149

		u->u.rail.railtype = GetEngine(u->engine_type)->railtype;

   150

   151

		if (IsTrainEngine(u)) first_engine = u->engine_type;

   152

   153

		if (rvi_u->visual_effect != 0) {

   154

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

   155

		} else {

   156

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

   157

				// Wagons and articulated parts have no effect by default

   158

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

   159

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

   160

				// Steam is offset by -4 units

   161

				u->u.rail.cached_vis_effect = 4;

   162

			} else {

   163

				// Diesel fumes and sparks come from the centre

   164

				u->u.rail.cached_vis_effect = 8;

   165

			}

   166

		}

   167

   168

		if (!IsArticulatedPart(u)) {

   169

			// check if its a powered wagon

   170

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

   171

   172

			/* Check powered wagon / visual effect callback */

   173

			if (HASBIT(EngInfo(u->engine_type)->callbackmask, CBM_WAGON_POWER)) {

   174

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

   175

   176

				if (callback != CALLBACK_FAILED) u->u.rail.cached_vis_effect = callback;

   177

			}

   178

   179

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

   180

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

   181

					/* wagon is powered */

   182

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

   183

				}

   184

			}

   185

   186

			/* Do not count powered wagons for the compatible railtypes, as wagons always

   187

			   have railtype normal */

   188

			if (rvi_u->power > 0) {

   189

				v->u.rail.compatible_railtypes |= GetRailTypeInfo(u->u.rail.railtype)->powered_railtypes;

   190

			}

   191

   192

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

   193

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

   194

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

   195

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

   196

		}

   197

   198

		// check the vehicle length (callback)

   199

		veh_len = CALLBACK_FAILED;

   200

		if (HASBIT(EngInfo(u->engine_type)->callbackmask, CBM_VEHICLE_LENGTH)) {

   201

			veh_len = GetVehicleCallback(CBID_TRAIN_VEHICLE_LENGTH, 0, 0, u->engine_type, u);

   202

		}

   203

		if (veh_len == CALLBACK_FAILED) veh_len = rvi_u->shorten_factor;

   204

		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

   205

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

   206

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

   207

   208

	};

   209

   210

	// store consist weight/max speed in cache

   211

	v->u.rail.cached_max_speed = max_speed;

   212

   213

	TrainPowerChanged(v);

   214

   215

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

   216

	TrainCargoChanged(v);

   217

}

   218

   219

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

   220

 * be interpreted? */

   221

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

   222

	{7, 1},

   223

	{0, 2},

   224

	{1, 3},

   225

	{2, 4},

   226

	{3, 5},

   227

	{4, 6},

   228

	{5, 7},

   229

	{6, 0},

   230

};

   231

   232

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

   233

	{6, 2},

   234

	{7, 3},

   235

	{0, 4},

   236

	{1, 5},

   237

	{2, 6},

   238

	{3, 7},

   239

	{4, 0},

   240

	{5, 1},

   241

};

   242

   243

enum AccelType {

   244

	AM_ACCEL,

   245

	AM_BRAKE

   246

};

   247

   248

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

   249

{

   250

	const Order* o = &v->current_order;

   251

	StationID sid = GetStationIndex(tile);

   252

   253

	assert(v->type == VEH_Train);

   254

	//When does a train drive through a station

   255

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

   256

	if (_patches.new_nonstop && o->flags & OF_NON_STOP && sid == o->station) {

   257

		return false;

   258

	}

   259

   260

	if (v->last_station_visited == sid) return false;

   261

   262

	if (sid != o->station && (o->flags & OF_NON_STOP || _patches.new_nonstop)) {

   263

		return false;

   264

	}

   265

   266

	return true;

   267

}

   268

   269

//new acceleration

   270

static int GetTrainAcceleration(Vehicle *v, bool mode)

   271

{

   272

	const Vehicle *u;

   273

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

   274

	int power = 0;

   275

	int mass = 0;

   276

	int max_speed = 2000;

   277

	int area = 120;

   278

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

   279

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

   280

	int incl = 0;

   281

	int resistance;

   282

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

   283

	int force = 0x3FFFFFFF;

   284

	int pos = 0;

   285

	int lastpos = -1;

   286

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

   287

	int sum = 0;

   288

	int numcurve = 0;

   289

   290

	speed *= 10;

   291

	speed /= 16;

   292

   293

	//first find the curve speed limit

   294

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

   295

		Direction dir = u->direction;

   296

		Direction ndir = u->next->direction;

   297

		int i;

   298

   299

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

   300

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

   301

				curvecount[i]++;

   302

				if (lastpos != -1) {

   303

					numcurve++;

   304

					sum += pos - lastpos;

   305

					if (pos - lastpos == 1) {

   306

						max_speed = 88;

   307

					}

   308

				}

   309

				lastpos = pos;

   310

			}

   311

		}

   312

   313

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

   314

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

   315

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

   316

			max_speed = 61;

   317

		}

   318

	}

   319

   320

	if (numcurve > 0) sum /= numcurve;

   321

   322

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

   323

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

   324

   325

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

   326

			max_speed = 0xFFFF;

   327

		} else if (total > 1) {

   328

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

   329

		}

   330

	}

   331

   332

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

   333

   334

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

   335

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

   336

			uint station_length = GetPlatformLength(v->tile, DirToDiagDir(v->direction));

   337

			int delta_v;

   338

   339

			max_speed = 120;

   340

   341

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

   342

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

   343

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

   344

   345

			max_speed = max(max_speed, 25 * station_length);

   346

		}

   347

	}

   348

   349

	mass = v->u.rail.cached_weight;

   350

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

   351

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

   352

   353

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

   354

		num++;

   355

		drag_coeff += 3;

   356

   357

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

   358

   359

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

   360

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

   361

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

   362

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

   363

		}

   364

	}

   365

   366

	v->max_speed = max_speed;

   367

   368

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

   369

		resistance = 13 * mass / 10;

   370

		resistance += 60 * num;

   371

		resistance += friction * mass * speed / 1000;

   372

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

   373

	} else {

   374

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

   375

	}

   376

	resistance += incl;

   377

	resistance *= 4; //[N]

   378

   379

	if (speed > 0) {

   380

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

   381

			case RAILTYPE_RAIL:

   382

			case RAILTYPE_ELECTRIC:

   383

			case RAILTYPE_MONO:

   384

				force = power / speed; //[N]

   385

				force *= 22;

   386

				force /= 10;

   387

				break;

   388

   389

			case RAILTYPE_MAGLEV:

   390

				force = power / 25;

   391

				break;

   392

		}

   393

	} else {

   394

		//"kickoff" acceleration

   395

		force = (mass * 8) + resistance;

   396

	}

   397

   398

	if (force <= 0) force = 10000;

   399

   400

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

   401

   402

	if (mode == AM_ACCEL) {

   403

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

   404

	} else {

   405

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

   406

	}

   407

}

   408

   409

static void UpdateTrainAcceleration(Vehicle* v)

   410

{

   411

	uint power = 0;

   412

	uint weight = 0;

   413

   414

	assert(IsFrontEngine(v));

   415

   416

	weight = v->u.rail.cached_weight;

   417

	power = v->u.rail.cached_power;

   418

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

   419

   420

	assert(weight != 0);

   421

   422

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

   423

}

   424

   425

int GetTrainImage(const Vehicle* v, Direction direction)

   426

{

   427

	int img = v->spritenum;

   428

	int base;

   429

   430

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

   431

   432

	if (is_custom_sprite(img)) {

   433

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

   434

		if (base != 0) return base;

   435

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

   436

	}

   437

   438

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

   439

   440

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

   441

	return base;

   442

}

   443

   444

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

   445

{

   446

	const RailVehicleInfo *rvi = RailVehInfo(engine);

   447

   448

	int img = rvi->image_index;

   449

	uint32 image = 0;

   450

   451

	if (is_custom_sprite(img)) {

   452

		image = GetCustomVehicleIcon(engine, DIR_W);

   453

		if (image == 0) {

   454

			img = orig_rail_vehicle_info[engine].image_index;

   455

		} else {

   456

			y += _traininfo_vehicle_pitch;

   457

		}

   458

	}

   459

	if (image == 0) {

   460

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

   461

	}

   462

   463

	if (rvi->flags & RVI_MULTIHEAD) {

   464

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

   465

		x += 15;

   466

		image = 0;

   467

		if (is_custom_sprite(img)) {

   468

			image = GetCustomVehicleIcon(engine, 2);

   469

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

   470

		}

   471

		if (image == 0) {

   472

			image =

   473

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

   474

				_engine_sprite_base[img + 1];

   475

		}

   476

	}

   477

	DrawSprite(image | image_ormod, x, y);

   478

}

   479

   480

static uint CountArticulatedParts(EngineID engine_type)

   481

{

   482

	uint16 callback;

   483

	uint i;

   484

   485

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

   486

   487

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