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

    19

#include "vehicle_gui.h"

    20

    21

#define IS_FIRSTHEAD_SPRITE(spritenum) \

    22

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

    23

    24

static bool TrainCheckIfLineEnds(Vehicle *v);

    25

static void TrainController(Vehicle *v);

    26

extern void ShowTrainViewWindow(Vehicle *v);

    27

    28

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

    29

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

    30

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

    31

    32

/**

    33

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

    34

 * the consist changes.

    35

 * @param v First vehicle of the consist.

    36

 */

    37

void TrainCargoChanged(Vehicle *v) {

    38

	Vehicle *u;

    39

	uint16 weight = 0;

    40

    41

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

    42

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

    43

		uint16 vweight = 0;

    44

    45

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

    46

		vweight += rvi->weight;

    47

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

    48

		// powered wagons have extra weight added

    49

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

    50

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

    51

    52

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

    53

		weight += vweight;

    54

    55

		// store vehicle weight in cache

    56

		u->u.rail.cached_veh_weight = vweight;

    57

	};

    58

    59

	// store consist weight in cache

    60

	v->u.rail.cached_weight = weight;

    61

}

    62

    63

/**

    64

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

    65

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

    66

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

    67

 * @param v First vehicle of the chain.

    68

 */

    69

void TrainConsistChanged(Vehicle *v) {

    70

	const RailVehicleInfo *rvi_v;

    71

	Vehicle *u;

    72

	uint16 max_speed = 0xFFFF;

    73

	uint32 power = 0;

    74

	EngineID first_engine;

    75

    76

	assert(v->type == VEH_Train);

    77

    78

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

    79

    80

	rvi_v = RailVehInfo(v->engine_type);

    81

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

    82

    83

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

    84

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

    85

		uint16 veh_len;

    86

    87

		// update the 'first engine'

    88

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

    89

    90

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

    91

		power += rvi_u->power;

    92

    93

		// check if its a powered wagon

    94

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

    95

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

    96

			uint16 callback = CALLBACK_FAILED;

    97

    98

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

    99

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

   100

   101

			if (callback == CALLBACK_FAILED)

   102

				callback = rvi_u->visual_effect;

   103

   104

			if (callback < 0x40) {

   105

				/* wagon is powered */

   106

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

   107

				power += rvi_v->pow_wag_power;

   108

			}

   109

		}

   110

   111

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

   112

		if (rvi_u->max_speed != 0)

   113

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

   114

   115

		// check the vehicle length (callback)

   116

		veh_len = CALLBACK_FAILED;

   117

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

   118

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

   119

		if (veh_len == CALLBACK_FAILED)

   120

			veh_len = rvi_u->shorten_factor;

   121

		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

   122

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

   123

   124

	};

   125

   126

	// store consist weight/max speed in cache

   127

	v->u.rail.cached_max_speed = max_speed;

   128

	v->u.rail.cached_power = power;

   129

   130

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

   131

	TrainCargoChanged(v);

   132

}

   133

   134

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

   135

 * be interpreted? */

   136

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

   137

	{7, 1},

   138

	{0, 2},

   139

	{1, 3},

   140

	{2, 4},

   141

	{3, 5},

   142

	{4, 6},

   143

	{5, 7},

   144

	{6, 0},

   145

};

   146

   147

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

   148

	{6, 2},

   149

	{7, 3},

   150

	{0, 4},

   151

	{1, 5},

   152

	{2, 6},

   153

	{3, 7},

   154

	{4, 0},

   155

	{5, 1},

   156

};

   157

   158

enum AccelType {

   159

	AM_ACCEL,

   160

	AM_BRAKE

   161

};

   162

   163

static bool TrainShouldStop(Vehicle *v, TileIndex tile)

   164

{

   165

	Order *o = &v->current_order;

   166

	assert(v->type == VEH_Train);

   167

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

   168

	//When does a train drive through a station

   169

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

   170

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

   171

			_map2[tile] == o->station )

   172

		return false;

   173

   174

	if (v->last_station_visited == _map2[tile])

   175

		return false;

   176

   177

	if (_map2[tile] != o->station &&

   178

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

   179

		return false;

   180

   181

	return true;

   182

}

   183

   184

//new acceleration

   185

static int GetTrainAcceleration(Vehicle *v, bool mode)

   186

{

   187

	const Vehicle *u;

   188

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

   189

	int power = 0;

   190

	int mass = 0;

   191

	int max_speed = 2000;

   192

	int area = 120;

   193

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

   194

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

   195

	int incl = 0;

   196

	int resistance;

   197

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

   198

	int force = 0x3FFFFFFF;

   199

	int pos = 0;

   200

	int lastpos = -1;

   201

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

   202

	int sum = 0;

   203

	int numcurve = 0;

   204

   205

	speed *= 10;

   206

	speed /= 16;

   207

   208

	//first find the curve speed limit

   209

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

   210

		int dir = u->direction;

   211

		int ndir = u->next->direction;

   212

		int i;

   213

   214

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

   215

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

   216

				curvecount[i]++;

   217

				if (lastpos != -1) {

   218

					numcurve++;

   219

					sum += pos - lastpos;

   220

					if (pos - lastpos == 1) {

   221

						max_speed = 88;

   222

					}

   223

				}

   224

				lastpos = pos;

   225

			}

   226

		}

   227

   228

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

   229

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

   230

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

   231

			max_speed = 61;

   232

		}

   233

	}

   234

   235

	if (numcurve > 0) sum /= numcurve;

   236

   237

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

   238

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

   239

   240

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

   241

			max_speed = 0xFFFF;

   242

		} else if (total > 1) {

   243

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

   244

		}

   245

	}

   246

   247

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

   248

   249

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

   250

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

   251

			int station_length = 0;

   252

			TileIndex tile = v->tile;

   253

			int delta_v;

   254

   255

			max_speed = 120;

   256

			do {

   257

				station_length++;

   258

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

   259

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

   260

   261

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

   262

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

   263

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

   264

   265

			max_speed = max(max_speed, 25 * station_length);

   266

		}

   267

	}

   268

   269

	mass = v->u.rail.cached_weight;

   270

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

   271

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

   272

   273

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

   274

		num++;

   275

		drag_coeff += 3;

   276

   277

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

   278

			max_speed = min(61, max_speed);

   279

   280

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

   281

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

   282

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

   283

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

   284

		}

   285

	}

   286

   287

	v->max_speed = max_speed;

   288

   289

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

   290

		resistance = 13 * mass / 10;

   291

		resistance += 60 * num;

   292

		resistance += friction * mass * speed / 1000;

   293

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

   294

	} else

   295

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

   296

	resistance += incl;

   297

	resistance *= 4; //[N]

   298

   299

	if (speed > 0) {

   300

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

   301

			case 0:

   302

			case 1:

   303

				force = power / speed; //[N]

   304

				force *= 22;

   305

				force /= 10;

   306

				break;

   307

   308

			case 2:

   309

				force = power / 25;

   310

				break;

   311

		}

   312

	} else {

   313

		//"kickoff" acceleration

   314

		force = (mass * 8) + resistance;

   315

	}

   316

   317

	if (force <= 0) force = 10000;

   318

   319

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

   320

   321

	if (mode == AM_ACCEL) {

   322

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

   323

	} else {

   324

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

   325

	}

   326

}

   327

   328

void UpdateTrainAcceleration(Vehicle *v)

   329

{

   330

	uint power = 0;

   331

	uint weight = 0;

   332

   333

	assert(v->subtype == TS_Front_Engine);

   334

   335

	weight = v->u.rail.cached_weight;

   336

	power = v->u.rail.cached_power;

   337

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

   338

   339

	assert(weight != 0);

   340

   341

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

   342

}

   343

   344

int GetTrainImage(const Vehicle *v, byte direction)

   345

{

   346

	int img = v->spritenum;

   347

	int base;

   348

   349

	if (is_custom_sprite(img)) {

   350

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

   351

		if (base != 0) return base;

   352

		img = _engine_original_sprites[v->engine_type];

   353

	}

   354

   355

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

   356

   357

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

   358

		base += _wagon_full_adder[img];

   359

	return base;

   360

}

   361

   362

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

   363

{

   364

	const RailVehicleInfo *rvi = RailVehInfo(engine);

   365

   366

	int img = rvi->image_index;

   367

	uint32 image = 0;

   368

   369

	if (is_custom_sprite(img)) {

   370

		image = GetCustomVehicleIcon(engine, 6);

   371

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

   372

	}

   373

	if (image == 0) {

   374

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

   375

	}

   376

   377

	if (rvi->flags & RVI_MULTIHEAD) {

   378

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

   379

		x += 15;

   380

		image = 0;

   381

		if (is_custom_sprite(img)) {

   382

			image = GetCustomVehicleIcon(engine, 2);

   383

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

   384

		}

   385

		if (image == 0) {

   386

			image =

   387

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

   388

				_engine_sprite_base[img + 1];

   389

		}

   390

	}

   391

	DrawSprite(image | image_ormod, x, y);

   392

}

   393

   394

   395

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

   396

{

   397

	int32 value;

   398

	Vehicle *v;

   399

	const RailVehicleInfo *rvi;

   400

	int dir;

   401

	const Engine *e;

   402

	int x,y;

   403

   404

	SET_EXPENSES_TYPE(EXPENSES_NEW_VEHICLES);

   405

   406

	rvi = RailVehInfo(engine);

   407

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

   408

   409

	if (!(flags & DC_QUERY_COST)) {

   410

		_error_message = STR_00E1_TOO_MANY_VEHICLES_IN_GAME;

   411

   412

		v = AllocateVehicle();

   413

		if (v == NULL)

   414

			return CMD_ERROR;

   415

   416

		if (flags & DC_EXEC) {

   417

			byte img = rvi->image_index;

   418

			Vehicle *u, *w;

   419

   420

			v->spritenum = img;

   421

   422

			u = NULL;

   423

   424

			FOR_ALL_VEHICLES(w) {

   425

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

   426

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

   427

					u = GetLastVehicleInChain(w);

   428

					break;

   429

				}

   430

			}

   431

   432

			v->engine_type = engine;

   433

   434

			dir = _map5[tile] & 3;

   435

   436

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

   437

			v->tile = tile;

   438

   439

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

   440

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

   441

   442

			v->x_pos = x;

   443

			v->y_pos = y;

   444

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

   445

			v->owner = _current_player;

   446

			v->z_height = 6;

   447

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

   448

			v->vehstatus = VS_HIDDEN | VS_DEFPAL;

   449

   450

			v->subtype = TS_Free_Car;

   451

			if (u != NULL) {

   452

				u->next = v;

   453

				v->subtype = TS_Not_First;

   454

			}

   455

   456

			v->cargo_type = rvi->cargo_type;

   457

			v->cargo_cap = rvi->capacity;

   458

			v->value = value;

   459

//			v->day_counter = 0;

   460

   461

			e = GetEngine(engine);

   462

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

   463

   464

			v->build_year = _cur_year;

   465

			v->type = VEH_Train;

   466

			v->cur_image = 0xAC2;

   467

   468

			_new_wagon_id = v->index;

   469

   470

			VehiclePositionChanged(v);

   471

			TrainConsistChanged(GetFirstVehicleInChain(v));

   472

   473

			InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   474

		}

   475

	}

   476

   477

	return value;

   478

}

   479

   480

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

   481

static void NormalizeTrainVehInDepot(Vehicle *u)

   482

{

   483

	Vehicle *v;

   484

   485

	FOR_ALL_VEHICLES(v) {

   486

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

   487

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

   488

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

   489

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

   490

					CMD_MOVE_RAIL_VEHICLE) == CMD_ERROR)

   491

				break;

   492

		}

   493

	}

   494

}

   495