1

#include "stdafx.h"

     2

#include "openttd.h"

     3

#include "debug.h"

     4

#include "table/strings.h"

     5

#include "map.h"

     6

#include "tile.h"

     7

#include "vehicle.h"

     8

#include "command.h"

     9

#include "pathfind.h"

    10

#include "npf.h"

    11

#include "station.h"

    12

#include "table/train_cmd.h"

    13

#include "news.h"

    14

#include "engine.h"

    15

#include "player.h"

    16

#include "sound.h"

    17

#include "depot.h"

    18

#include "debug.h"

    19

#include "waypoint.h"

    20

#include "vehicle_gui.h"

    21

    22

#define IS_FIRSTHEAD_SPRITE(spritenum) \

    23

	(is_custom_sprite(spritenum) ? IS_CUSTOM_FIRSTHEAD_SPRITE(spritenum) : _engine_sprite_add[spritenum] == 0)

    24

    25

static bool TrainCheckIfLineEnds(Vehicle *v);

    26

static void TrainController(Vehicle *v);

    27

extern void ShowTrainViewWindow(Vehicle *v);

    28

    29

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

    30

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

    31

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

    32

    33

/**

    34

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

    35

 * the consist changes.

    36

 * @param v First vehicle of the consist.

    37

 */

    38

void TrainCargoChanged(Vehicle *v) {

    39

	Vehicle *u;

    40

	uint16 weight = 0;

    41

    42

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

    43

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

    44

		uint16 vweight = 0;

    45

    46

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

    47

		vweight += rvi->weight;

    48

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

    49

		// powered wagons have extra weight added

    50

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

    51

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

    52

    53

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

    54

		weight += vweight;

    55

    56

		// store vehicle weight in cache

    57

		u->u.rail.cached_veh_weight = vweight;

    58

	};

    59

    60

	// store consist weight in cache

    61

	v->u.rail.cached_weight = weight;

    62

}

    63

    64

/**

    65

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

    66

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

    67

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

    68

 * @param v First vehicle of the chain.

    69

 */

    70

void TrainConsistChanged(Vehicle *v) {

    71

	const RailVehicleInfo *rvi_v;

    72

	Vehicle *u;

    73

	uint16 max_speed = 0xFFFF;

    74

	uint32 power = 0;

    75

	EngineID first_engine;

    76

    77

	assert(v->type == VEH_Train);

    78

    79

	assert(v->subtype == TS_Front_Engine || v->subtype == TS_Free_Car);

    80

    81

	rvi_v = RailVehInfo(v->engine_type);

    82

	first_engine = (v->subtype == TS_Front_Engine) ? v->engine_type : INVALID_VEHICLE;

    83

    84

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

    85

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

    86

		uint16 veh_len;

    87

    88

		// update the 'first engine'

    89

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

    90

    91

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

    92

		power += rvi_u->power;

    93

    94

		// check if its a powered wagon

    95

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

    96

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

    97

			uint16 callback = CALLBACK_FAILED;

    98

    99

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

   100

				callback = GetCallBackResult(CBID_WAGON_POWER,  u->engine_type, u);

   101

   102

			if (callback == CALLBACK_FAILED)

   103

				callback = rvi_u->visual_effect;

   104

   105

			if (callback < 0x40) {

   106

				/* wagon is powered */

   107

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

   108

				power += rvi_v->pow_wag_power;

   109

			}

   110

		}

   111

   112

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

   113

		if (rvi_u->max_speed != 0)

   114

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

   115

   116

		// check the vehicle length (callback)

   117

		veh_len = CALLBACK_FAILED;

   118

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

   119

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

   120

		if (veh_len == CALLBACK_FAILED)

   121

			veh_len = rvi_u->shorten_factor;

   122

		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

   123

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

   124

   125

	};

   126

   127

	// store consist weight/max speed in cache

   128

	v->u.rail.cached_max_speed = max_speed;

   129

	v->u.rail.cached_power = power;

   130

   131

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

   132

	TrainCargoChanged(v);

   133

}

   134

   135

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

   136

 * be interpreted? */

   137

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

   138

	{7, 1},

   139

	{0, 2},

   140

	{1, 3},

   141

	{2, 4},

   142

	{3, 5},

   143

	{4, 6},

   144

	{5, 7},

   145

	{6, 0},

   146

};

   147

   148

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

   149

	{6, 2},

   150

	{7, 3},

   151

	{0, 4},

   152

	{1, 5},

   153

	{2, 6},

   154

	{3, 7},

   155

	{4, 0},

   156

	{5, 1},

   157

};

   158

   159

enum AccelType {

   160

	AM_ACCEL,

   161

	AM_BRAKE

   162

};

   163

   164

static bool TrainShouldStop(Vehicle *v, TileIndex tile)

   165

{

   166

	Order *o = &v->current_order;

   167

	assert(v->type == VEH_Train);

   168

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

   169

	//When does a train drive through a station

   170

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

   171

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

   172

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

   173

		return false;

   174

   175

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

   176

		return false;

   177

   178

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

   179

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

   180

		return false;

   181

   182

	return true;

   183

}

   184

   185

//new acceleration

   186

static int GetTrainAcceleration(Vehicle *v, bool mode)

   187

{

   188

	const Vehicle *u;

   189

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

   190

	int power = 0;

   191

	int mass = 0;

   192

	int max_speed = 2000;

   193

	int area = 120;

   194

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

   195

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

   196

	int incl = 0;

   197

	int resistance;

   198

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

   199

	int force = 0x3FFFFFFF;

   200

	int pos = 0;

   201

	int lastpos = -1;

   202

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

   203

	int sum = 0;

   204

	int numcurve = 0;

   205

   206

	speed *= 10;

   207

	speed /= 16;

   208

   209

	//first find the curve speed limit

   210

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

   211

		int dir = u->direction;

   212

		int ndir = u->next->direction;

   213

		int i;

   214

   215

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

   216

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

   217

				curvecount[i]++;

   218

				if (lastpos != -1) {

   219

					numcurve++;

   220

					sum += pos - lastpos;

   221

					if (pos - lastpos == 1) {

   222

						max_speed = 88;

   223

					}

   224

				}

   225

				lastpos = pos;

   226

			}

   227

		}

   228

   229

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

   230

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

   231

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

   232

			max_speed = 61;

   233

		}

   234

	}

   235

   236

	if (numcurve > 0) sum /= numcurve;

   237

   238

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

   239

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

   240

   241

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

   242

			max_speed = 0xFFFF;

   243

		} else if (total > 1) {

   244

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

   245

		}

   246

	}

   247

   248

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

   249

   250

	if (IsTileType(v->tile, MP_STATION) && v->subtype == TS_Front_Engine) {

   251

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

   252

			int station_length = 0;

   253

			TileIndex tile = v->tile;

   254

			int delta_v;

   255

   256

			max_speed = 120;

   257

			do {

   258

				station_length++;

   259

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

   260

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

   261

   262

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

   263

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

   264

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

   265

   266

			max_speed = max(max_speed, 25 * station_length);

   267

		}

   268

	}

   269

   270

	mass = v->u.rail.cached_weight;

   271

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

   272

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

   273

   274

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

   275

		num++;

   276

		drag_coeff += 3;

   277

   278

		if (u->u.rail.track == 0x80)

   279

			max_speed = min(61, max_speed);

   280

   281

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

   282

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

   283

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

   284

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

   285

		}

   286

	}

   287

   288

	v->max_speed = max_speed;

   289

   290

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

   291

		resistance = 13 * mass / 10;

   292

		resistance += 60 * num;

   293

		resistance += friction * mass * speed / 1000;

   294

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

   295

	} else

   296

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

   297

	resistance += incl;

   298

	resistance *= 4; //[N]

   299

   300

	if (speed > 0) {

   301

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

   302

			case 0:

   303

			case 1:

   304

				force = power / speed; //[N]

   305

				force *= 22;

   306

				force /= 10;

   307

				break;

   308

   309

			case 2:

   310

				force = power / 25;

   311

				break;

   312

		}

   313

	} else {

   314

		//"kickoff" acceleration

   315

		force = (mass * 8) + resistance;

   316

	}

   317

   318

	if (force <= 0) force = 10000;

   319

   320

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

   321

   322

	if (mode == AM_ACCEL) {

   323

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

   324

	} else {

   325

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

   326

	}

   327

}

   328

   329

void UpdateTrainAcceleration(Vehicle *v)

   330

{

   331

	uint power = 0;

   332

	uint weight = 0;

   333

   334

	assert(v->subtype == TS_Front_Engine);

   335

   336

	weight = v->u.rail.cached_weight;

   337

	power = v->u.rail.cached_power;

   338

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

   339

   340

	assert(weight != 0);

   341

   342

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

   343

}

   344

   345

int GetTrainImage(const Vehicle *v, byte direction)

   346

{

   347

	int img = v->spritenum;

   348

	int base;

   349

   350

	if (is_custom_sprite(img)) {

   351

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

   352

		if (base != 0) return base;

   353

		img = _engine_original_sprites[v->engine_type];

   354

	}

   355

   356

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

   357

   358

	if (v->cargo_count >= (v->cargo_cap >> 1))

   359

		base += _wagon_full_adder[img];

   360

	return base;

   361

}

   362

   363

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

   364

{

   365

	const RailVehicleInfo *rvi = RailVehInfo(engine);

   366

   367

	int img = rvi->image_index;

   368

	uint32 image = 0;

   369

   370

	if (is_custom_sprite(img)) {

   371

		image = GetCustomVehicleIcon(engine, 6);

   372

		if (image == 0) img = _engine_original_sprites[engine];

   373

	}

   374

	if (image == 0) {

   375

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

   376

	}

   377

   378

	if (rvi->flags & RVI_MULTIHEAD) {

   379

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

   380

		x += 15;

   381

		image = 0;

   382

		if (is_custom_sprite(img)) {

   383

			image = GetCustomVehicleIcon(engine, 2);

   384

			if (image == 0) img = _engine_original_sprites[engine];

   385

		}

   386

		if (image == 0) {

   387

			image =

   388

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

   389

				_engine_sprite_base[img + 1];

   390

		}

   391

	}

   392

	DrawSprite(image | image_ormod, x, y);

   393

}

   394

   395

   396

static int32 CmdBuildRailWagon(uint engine, TileIndex tile, uint32 flags)

   397

{

   398

	int32 value;

   399

	Vehicle *v;

   400

	const RailVehicleInfo *rvi;

   401

	int dir;

   402

	const Engine *e;

   403

	int x,y;

   404

   405

	SET_EXPENSES_TYPE(EXPENSES_NEW_VEHICLES);

   406

   407

	rvi = RailVehInfo(engine);

   408

	value = (rvi->base_cost * _price.build_railwagon) >> 8;

   409

   410

	if (!(flags & DC_QUERY_COST)) {

   411

		_error_message = STR_00E1_TOO_MANY_VEHICLES_IN_GAME;

   412

   413

		v = AllocateVehicle();

   414

		if (v == NULL)

   415

			return CMD_ERROR;

   416

   417

		if (flags & DC_EXEC) {

   418

			byte img = rvi->image_index;

   419

			Vehicle *u, *w;

   420

   421

			v->spritenum = img;

   422

   423

			u = NULL;

   424

   425

			FOR_ALL_VEHICLES(w) {

   426

				if (w->type == VEH_Train && w->tile == tile &&

   427

				    w->subtype == TS_Free_Car && w->engine_type == engine) {

   428

					u = GetLastVehicleInChain(w);

   429

					break;

   430

				}

   431

			}

   432

   433

			v->engine_type = engine;

   434

   435

			dir = _m[tile].m5 & 3;

   436

   437

			v->direction = (byte)(dir*2+1);

   438

			v->tile = tile;

   439

   440

			x = TileX(tile) * TILE_SIZE | _vehicle_initial_x_fract[dir];

   441

			y = TileY(tile) * TILE_SIZE | _vehicle_initial_y_fract[dir];

   442

   443

			v->x_pos = x;

   444

			v->y_pos = y;

   445

			v->z_pos = GetSlopeZ(x,y);

   446

			v->owner = _current_player;

   447

			v->z_height = 6;

   448

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

   449

			v->vehstatus = VS_HIDDEN | VS_DEFPAL;

   450

   451

			v->subtype = TS_Free_Car;

   452

			if (u != NULL) {

   453

				u->next = v;

   454

				v->subtype = TS_Not_First;

   455

			}

   456

   457

			v->cargo_type = rvi->cargo_type;

   458

			v->cargo_cap = rvi->capacity;

   459

			v->value = value;

   460

//			v->day_counter = 0;

   461

   462

			e = GetEngine(engine);

   463

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

   464

   465

			v->build_year = _cur_year;

   466

			v->type = VEH_Train;

   467

			v->cur_image = 0xAC2;

   468

   469

			_new_wagon_id = v->index;

   470

   471

			VehiclePositionChanged(v);

   472

			TrainConsistChanged(GetFirstVehicleInChain(v));

   473

   474

			InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   475

		}

   476

	}

   477

   478

	return value;

   479

}

   480

   481

// Move all free vehicles in the depot to the train

   482

static void NormalizeTrainVehInDepot(Vehicle *u)

   483

{

   484

	Vehicle *v;

   485

   486

	FOR_ALL_VEHICLES(v) {

   487

		if (v->type == VEH_Train && v->subtype == TS_Free_Car &&

   488

				v->tile == u->tile &&

   489

				v->u.rail.track == 0x80) {

   490

			if (DoCommandByTile(0, v->index | (u->index << 16), 1, DC_EXEC,

   491

					CMD_MOVE_RAIL_VEHICLE) == CMD_ERROR)

   492

				break;

   493

		}

   494

	}