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

    31

#include "newgrf_text.h"

    32

#include "direction.h"

    33

#include "yapf/yapf.h"

    34

#include "date.h"

    35

    36

static bool TrainCheckIfLineEnds(Vehicle *v);

    37

static void TrainController(Vehicle *v);

    38

    39

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

    40

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

    41

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

    42

    43

/**

    44

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

    45

 * the consist changes.

    46

 * @param v First vehicle of the consist.

    47

 */

    48

static void TrainCargoChanged(Vehicle* v)

    49

{

    50

	Vehicle *u;

    51

	uint16 weight = 0;

    52

    53

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

    54

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

    55

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

    56

    57

		// Vehicle weight is not added for articulated parts.

    58

		if (!IsArticulatedPart(u)) {

    59

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

    60

			vweight += rvi->weight;

    61

    62

			// powered wagons have extra weight added

    63

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

    64

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

    65

		}

    66

    67

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

    68

		weight += vweight;

    69

    70

		// store vehicle weight in cache

    71

		u->u.rail.cached_veh_weight = vweight;

    72

	};

    73

    74

	// store consist weight in cache

    75

	v->u.rail.cached_weight = weight;

    76

}

    77

    78

/**

    79

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

    80

 * @param v First vehicle of the consist.

    81

 */

    82

void TrainPowerChanged(Vehicle* v)

    83

{

    84

	Vehicle* u;

    85

	uint32 power = 0;

    86

    87

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

    88

		const RailVehicleInfo *rvi_u;

    89

		bool engine_has_power = true;

    90

		bool wagon_has_power = true;

    91

    92

		/* Power is not added for articulated parts */

    93

		if (IsArticulatedPart(u)) continue;

    94

    95

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

    96

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

    97

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

    98

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

    99

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

   100

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

   101

		} else {

   102

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

   103

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

   104

		}

   105

   106

		rvi_u = RailVehInfo(u->engine_type);

   107

   108

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

   109

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

   110

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

   111

		}

   112

	}

   113

   114

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

   115

		v->u.rail.cached_power = power;

   116

		InvalidateWindow(WC_VEHICLE_DETAILS, v->index);

   117

		InvalidateWindowWidget(WC_VEHICLE_VIEW, v->index, STATUS_BAR);

   118

	}

   119

}

   120

   121

/**

   122

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

   123

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

   124

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

   125

 * @param v First vehicle of the chain.

   126

 */

   127

void TrainConsistChanged(Vehicle* v)

   128

{

   129

	const RailVehicleInfo *rvi_v;

   130

	Vehicle *u;

   131

	uint16 max_speed = 0xFFFF;

   132

	EngineID first_engine;

   133

   134

	assert(v->type == VEH_Train);

   135

   136

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

   137

   138

	rvi_v = RailVehInfo(v->engine_type);

   139

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

   140

	v->u.rail.cached_total_length = 0;

   141

	v->u.rail.compatible_railtypes = 0;

   142

   143

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

   144

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

   145

		uint16 veh_len;

   146

   147

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

   148

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

   149

   150

		// update the 'first engine'

   151

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

   152

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

   153

   154

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

   155

   156

		if (rvi_u->visual_effect != 0) {

   157

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

   158

		} else {

   159

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

   160

				// Wagons and articulated parts have no effect by default

   161

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

   162

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

   163

				// Steam is offset by -4 units

   164

				u->u.rail.cached_vis_effect = 4;

   165

			} else {

   166

				// Diesel fumes and sparks come from the centre

   167

				u->u.rail.cached_vis_effect = 8;

   168

			}

   169

		}

   170

   171

		if (!IsArticulatedPart(u)) {

   172

			// check if its a powered wagon

   173

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

   174

   175

			/* Check powered wagon / visual effect callback */

   176

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

   177

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

   178

   179

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

   180

			}

   181

   182

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

   183

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

   184

					/* wagon is powered */

   185

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

   186

				}

   187

			}

   188

   189

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

   190

			   have railtype normal */

   191

			if (rvi_u->power > 0) {

   192

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

   193

			}

   194

   195

			/* Some electric engines can be allowed to run on normal rail. It happens to all

   196

			 * existing electric engines when elrails are disabled and then re-enabled */

   197

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

   198

				u->u.rail.railtype = RAILTYPE_RAIL;

   199

				u->u.rail.compatible_railtypes |= (1 << RAILTYPE_RAIL);

   200

			}

   201

   202

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

   203

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

   204

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

   205

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

   206

		}

   207

   208

		// check the vehicle length (callback)

   209

		veh_len = CALLBACK_FAILED;

   210

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

   211

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

   212

		}

   213

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

   214

		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

   215

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

   216

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

   217

   218

	};

   219

   220

	// store consist weight/max speed in cache

   221

	v->u.rail.cached_max_speed = max_speed;

   222

   223

	TrainPowerChanged(v);

   224

   225

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

   226

	TrainCargoChanged(v);

   227

}

   228

   229

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

   230

 * be interpreted? */

   231

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

   232

	{7, 1},

   233

	{0, 2},

   234

	{1, 3},

   235

	{2, 4},

   236

	{3, 5},

   237

	{4, 6},

   238

	{5, 7},

   239

	{6, 0},

   240

};

   241

   242

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

   243

	{6, 2},

   244

	{7, 3},

   245

	{0, 4},

   246

	{1, 5},

   247

	{2, 6},

   248

	{3, 7},

   249

	{4, 0},

   250

	{5, 1},

   251

};

   252

   253

enum AccelType {

   254

	AM_ACCEL,

   255

	AM_BRAKE

   256

};

   257

   258

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

   259

{

   260

	const Order* o = &v->current_order;

   261

	StationID sid = GetStationIndex(tile);

   262

   263

	assert(v->type == VEH_Train);

   264

	//When does a train drive through a station

   265

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

   266

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

   267

		return false;

   268

	}

   269

   270

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

   271

   272

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

   273

		return false;

   274

	}

   275

   276

	return true;

   277

}

   278

   279

//new acceleration

   280

static int GetTrainAcceleration(Vehicle *v, bool mode)

   281

{

   282

	const Vehicle *u;

   283

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

   284

	int power = 0;

   285

	int mass = 0;

   286

	int max_speed = 2000;

   287

	int area = 120;

   288

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

   289

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

   290

	int incl = 0;

   291

	int resistance;

   292

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

   293

	int force = 0x3FFFFFFF;

   294

	int pos = 0;

   295

	int lastpos = -1;

   296

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

   297

	int sum = 0;

   298

	int numcurve = 0;

   299

   300

	speed *= 10;

   301

	speed /= 16;

   302

   303

	//first find the curve speed limit

   304

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

   305

		Direction dir = u->direction;

   306

		Direction ndir = u->next->direction;

   307

		int i;

   308

   309

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

   310

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

   311

				curvecount[i]++;

   312

				if (lastpos != -1) {

   313

					numcurve++;

   314

					sum += pos - lastpos;

   315

					if (pos - lastpos == 1) {

   316

						max_speed = 88;

   317

					}

   318

				}

   319

				lastpos = pos;

   320

			}

   321

		}

   322

   323

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

   324

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

   325

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

   326

			max_speed = 61;

   327

		}

   328

	}

   329

   330

	if (numcurve > 0) sum /= numcurve;

   331

   332

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

   333

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

   334

   335

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

   336

			max_speed = 0xFFFF;

   337

		} else if (total > 1) {

   338

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

   339

		}

   340

	}

   341

   342

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

   343

   344

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

   345

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

   346

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

   347

			int delta_v;

   348

   349

			max_speed = 120;

   350

   351

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

   352

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

   353

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

   354

   355

			max_speed = max(max_speed, 25 * station_length);

   356

		}

   357

	}

   358

   359

	mass = v->u.rail.cached_weight;

   360

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

   361

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

   362

   363

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

   364

		num++;

   365

		drag_coeff += 3;

   366

   367

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

   368

   369

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

   370

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

   371

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

   372

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

   373

		}

   374

	}

   375

   376

	v->max_speed = max_speed;

   377

   378

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

   379

		resistance = 13 * mass / 10;

   380

		resistance += 60 * num;

   381

		resistance += friction * mass * speed / 1000;

   382

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

   383

	} else {

   384

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

   385

	}

   386

	resistance += incl;

   387

	resistance *= 4; //[N]

   388

   389

	if (speed > 0) {

   390

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

   391

			case RAILTYPE_RAIL:

   392

			case RAILTYPE_ELECTRIC:

   393

			case RAILTYPE_MONO:

   394

				force = power / speed; //[N]

   395

				force *= 22;

   396

				force /= 10;

   397

				break;

   398

   399

			case RAILTYPE_MAGLEV:

   400

				force = power / 25;

   401

				break;

   402

		}

   403

	} else {

   404

		//"kickoff" acceleration

   405

		force = (mass * 8) + resistance;

   406

	}

   407

   408

	if (force <= 0) force = 10000;

   409

   410

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

   411

   412

	if (mode == AM_ACCEL) {

   413

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

   414

	} else {

   415

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

   416

	}

   417

}

   418

   419

static void UpdateTrainAcceleration(Vehicle* v)

   420

{

   421

	uint power = 0;

   422

	uint weight = 0;

   423

   424

	assert(IsFrontEngine(v));

   425

   426

	weight = v->u.rail.cached_weight;

   427

	power = v->u.rail.cached_power;

   428

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

   429

   430

	assert(weight != 0);

   431

   432

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

   433

}

   434

   435

int GetTrainImage(const Vehicle* v, Direction direction)

   436

{

   437

	int img = v->spritenum;

   438

	int base;

   439

   440

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

   441

   442

	if (is_custom_sprite(img)) {

   443

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

   444

		if (base != 0) return base;

   445

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

   446

	}

   447

   448

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

   449

   450

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

   451

	return base;

   452

}

   453

   454

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

   455

{

   456

	const RailVehicleInfo *rvi = RailVehInfo(engine);

   457

   458

	int img = rvi->image_index;

   459

	uint32 image = 0;

   460

   461

	if (is_custom_sprite(img)) {

   462

		image = GetCustomVehicleIcon(engine, DIR_W);

   463

		if (image == 0) {

   464

			img = orig_rail_vehicle_info[engine].image_index;

   465

		} else {

   466

			y += _traininfo_vehicle_pitch;

   467

		}

   468

	}

   469

	if (image == 0) {

   470

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

   471

	}

   472

   473

	if (rvi->flags & RVI_MULTIHEAD) {

   474

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

   475

		x += 15;

   476

		image = 0;

   477

		if (is_custom_sprite(img)) {

   478

			image = GetCustomVehicleIcon(engine, 2);

   479

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

   480

		}

   481

		if (image == 0) {

   482

			image =

   483

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

   484

				_engine_sprite_base[img + 1];

   485

		}

   486

	}