1

#include "stdafx.h"

     2

#include "openttd.h"

     3

#include "debug.h"

     4

#include "functions.h"

     5

#include "table/strings.h"

     6

#include "map.h"

     7

#include "tile.h"

     8

#include "vehicle.h"

     9

#include "command.h"

    10

#include "pathfind.h"

    11

#include "npf.h"

    12

#include "station.h"

    13

#include "table/train_cmd.h"

    14

#include "news.h"

    15

#include "engine.h"

    16

#include "player.h"

    17

#include "sound.h"

    18

#include "depot.h"

    19

#include "debug.h"

    20

#include "waypoint.h"

    21

#include "vehicle_gui.h"

    22

    23

#define IS_FIRSTHEAD_SPRITE(spritenum) \

    24

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

    25

    26

static bool TrainCheckIfLineEnds(Vehicle *v);

    27

static void TrainController(Vehicle *v);

    28

extern void ShowTrainViewWindow(Vehicle *v);

    29

    30

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

    31

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

    32

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

    33

    34

/**

    35

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

    36

 * the consist changes.

    37

 * @param v First vehicle of the consist.

    38

 */

    39

void TrainCargoChanged(Vehicle *v) {

    40

	Vehicle *u;

    41

	uint16 weight = 0;

    42

    43

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

    44

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

    45

		uint16 vweight = 0;

    46

    47

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

    48

		vweight += rvi->weight;

    49

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

    50

		// powered wagons have extra weight added

    51

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

    52

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

    53

    54

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

    55

		weight += vweight;

    56

    57

		// store vehicle weight in cache

    58

		u->u.rail.cached_veh_weight = vweight;

    59

	};

    60

    61

	// store consist weight in cache

    62

	v->u.rail.cached_weight = weight;

    63

}

    64

    65

/**

    66

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

    67

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

    68

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

    69

 * @param v First vehicle of the chain.

    70

 */

    71

void TrainConsistChanged(Vehicle *v) {

    72

	const RailVehicleInfo *rvi_v;

    73

	Vehicle *u;

    74

	uint16 max_speed = 0xFFFF;

    75

	uint32 power = 0;

    76

	EngineID first_engine;

    77

    78

	assert(v->type == VEH_Train);

    79

    80

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

    81

    82

	rvi_v = RailVehInfo(v->engine_type);

    83

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

    84

    85

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

    86

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

    87

		uint16 veh_len;

    88

    89

		// update the 'first engine'

    90

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

    91

    92

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

    93

		power += rvi_u->power;

    94

    95

		// check if its a powered wagon

    96

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

    97

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

    98

			uint16 callback = CALLBACK_FAILED;

    99

   100

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

   101

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

   102

   103

			if (callback == CALLBACK_FAILED)

   104

				callback = rvi_u->visual_effect;

   105

   106

			if (callback < 0x40) {

   107

				/* wagon is powered */

   108

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

   109

				power += rvi_v->pow_wag_power;

   110

			}

   111

		}

   112

   113

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

   114

		if (rvi_u->max_speed != 0)

   115

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

   116

   117

		// check the vehicle length (callback)

   118

		veh_len = CALLBACK_FAILED;

   119

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

   120

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

   121

		if (veh_len == CALLBACK_FAILED)

   122

			veh_len = rvi_u->shorten_factor;

   123

		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

   124

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

   125

   126

	};

   127

   128

	// store consist weight/max speed in cache

   129

	v->u.rail.cached_max_speed = max_speed;

   130

	v->u.rail.cached_power = power;

   131

   132

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

   133

	TrainCargoChanged(v);

   134

}

   135

   136

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

   137

 * be interpreted? */

   138

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

   139

	{7, 1},

   140

	{0, 2},

   141

	{1, 3},

   142

	{2, 4},

   143

	{3, 5},

   144

	{4, 6},

   145

	{5, 7},

   146

	{6, 0},

   147

};

   148

   149

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

   150

	{6, 2},

   151

	{7, 3},

   152

	{0, 4},

   153

	{1, 5},

   154

	{2, 6},

   155

	{3, 7},

   156

	{4, 0},

   157

	{5, 1},

   158

};

   159

   160

enum AccelType {

   161

	AM_ACCEL,

   162

	AM_BRAKE

   163

};

   164

   165

static bool TrainShouldStop(Vehicle *v, TileIndex tile)

   166

{

   167

	Order *o = &v->current_order;

   168

	assert(v->type == VEH_Train);

   169

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

   170

	//When does a train drive through a station

   171

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

   172

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

   173

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

   174

		return false;

   175

   176

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

   177

		return false;

   178

   179

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

   180

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

   181

		return false;

   182

   183

	return true;

   184

}

   185

   186

//new acceleration

   187

static int GetTrainAcceleration(Vehicle *v, bool mode)

   188

{

   189

	const Vehicle *u;

   190

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

   191

	int power = 0;

   192

	int mass = 0;

   193

	int max_speed = 2000;

   194

	int area = 120;

   195

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

   196

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

   197

	int incl = 0;

   198

	int resistance;

   199

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

   200

	int force = 0x3FFFFFFF;

   201

	int pos = 0;

   202

	int lastpos = -1;

   203

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

   204

	int sum = 0;

   205

	int numcurve = 0;

   206

   207

	speed *= 10;

   208

	speed /= 16;

   209

   210

	//first find the curve speed limit

   211

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

   212

		int dir = u->direction;

   213

		int ndir = u->next->direction;

   214

		int i;

   215

   216

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

   217

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

   218

				curvecount[i]++;

   219

				if (lastpos != -1) {

   220

					numcurve++;

   221

					sum += pos - lastpos;

   222

					if (pos - lastpos == 1) {

   223

						max_speed = 88;

   224

					}

   225

				}

   226

				lastpos = pos;

   227

			}

   228

		}

   229

   230

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

   231

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

   232

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

   233

			max_speed = 61;

   234

		}

   235

	}

   236

   237

	if (numcurve > 0) sum /= numcurve;

   238

   239

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

   240

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

   241

   242

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

   243

			max_speed = 0xFFFF;

   244

		} else if (total > 1) {

   245

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

   246

		}

   247

	}

   248

   249

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

   250

   251

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

   252

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

   253

			int station_length = 0;

   254

			TileIndex tile = v->tile;

   255

			int delta_v;

   256

   257

			max_speed = 120;

   258

			do {

   259

				station_length++;

   260

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

   261

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

   262

   263

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

   264

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

   265

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

   266

   267

			max_speed = max(max_speed, 25 * station_length);

   268

		}

   269

	}

   270

   271

	mass = v->u.rail.cached_weight;

   272

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

   273

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

   274

   275

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

   276

		num++;

   277

		drag_coeff += 3;

   278

   279

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

   280

			max_speed = min(61, max_speed);

   281

   282

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

   283

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

   284

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

   285

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

   286

		}

   287

	}

   288

   289

	v->max_speed = max_speed;

   290

   291

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

   292

		resistance = 13 * mass / 10;

   293

		resistance += 60 * num;

   294

		resistance += friction * mass * speed / 1000;

   295

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

   296

	} else

   297

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

   298

	resistance += incl;

   299

	resistance *= 4; //[N]

   300

   301

	if (speed > 0) {

   302

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

   303

			case 0:

   304

			case 1:

   305

				force = power / speed; //[N]

   306

				force *= 22;

   307

				force /= 10;

   308

				break;

   309

   310

			case 2:

   311

				force = power / 25;

   312

				break;

   313

		}

   314

	} else {

   315

		//"kickoff" acceleration

   316

		force = (mass * 8) + resistance;

   317

	}

   318

   319

	if (force <= 0) force = 10000;

   320

   321

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

   322

   323

	if (mode == AM_ACCEL) {

   324

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

   325

	} else {

   326

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

   327

	}

   328

}

   329

   330

void UpdateTrainAcceleration(Vehicle *v)

   331

{

   332

	uint power = 0;

   333

	uint weight = 0;

   334

   335

	assert(v->subtype == TS_Front_Engine);

   336

   337

	weight = v->u.rail.cached_weight;

   338

	power = v->u.rail.cached_power;

   339

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

   340

   341

	assert(weight != 0);

   342

   343

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

   344

}

   345

   346

int GetTrainImage(const Vehicle *v, byte direction)

   347

{

   348

	int img = v->spritenum;

   349

	int base;

   350

   351

	if (is_custom_sprite(img)) {

   352

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

   353

		if (base != 0) return base;

   354

		img = _engine_original_sprites[v->engine_type];

   355

	}

   356

   357

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

   358

   359

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

   360

		base += _wagon_full_adder[img];

   361

	return base;

   362

}

   363

   364

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

   365

{

   366

	const RailVehicleInfo *rvi = RailVehInfo(engine);

   367

   368

	int img = rvi->image_index;

   369

	uint32 image = 0;

   370

   371

	if (is_custom_sprite(img)) {

   372

		image = GetCustomVehicleIcon(engine, 6);

   373

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

   374

	}

   375

	if (image == 0) {

   376

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

   377

	}

   378

   379

	if (rvi->flags & RVI_MULTIHEAD) {

   380

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

   381

		x += 15;

   382

		image = 0;

   383

		if (is_custom_sprite(img)) {

   384

			image = GetCustomVehicleIcon(engine, 2);

   385

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

   386

		}

   387

		if (image == 0) {

   388

			image =

   389

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

   390

				_engine_sprite_base[img + 1];

   391

		}

   392

	}

   393

	DrawSprite(image | image_ormod, x, y);

   394

}

   395

   396

   397

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

   398

{

   399

	int32 value;

   400

	Vehicle *v;

   401

	const RailVehicleInfo *rvi;

   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

			uint dir;

   421

   422

			v->spritenum = img;

   423

   424

			u = NULL;

   425

   426

			FOR_ALL_VEHICLES(w) {

   427

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

   428

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

   429

					u = GetLastVehicleInChain(w);

   430

					break;

   431

				}

   432

			}

   433

   434

			v->engine_type = engine;

   435

   436

			dir = GB(_m[tile].m5, 0, 2);

   437

   438

			v->direction = dir * 2 + 1;

   439

			v->tile = tile;

   440

   441

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

   442

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

   443

   444

			v->x_pos = x;

   445

			v->y_pos = y;

   446

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

   447

			v->owner = _current_player;

   448

			v->z_height = 6;

   449

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

   450

			v->vehstatus = VS_HIDDEN | VS_DEFPAL;

   451

   452

			v->subtype = TS_Free_Car;

   453

			if (u != NULL) {

   454

				u->next = v;

   455

				v->subtype = TS_Not_First;

   456

			}

   457

   458

			v->cargo_type = rvi->cargo_type;

   459

			v->cargo_cap = rvi->capacity;

   460

			v->value = value;

   461

//			v->day_counter = 0;

   462

   463

			e = GetEngine(engine);

   464

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

   465

   466

			v->build_year = _cur_year;

   467

			v->type = VEH_Train;

   468

			v->cur_image = 0xAC2;

   469

   470

			_new_wagon_id = v->index;

   471

   472

			VehiclePositionChanged(v);

   473

			TrainConsistChanged(GetFirstVehicleInChain(v));

   474

   475

			InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   476

		}

   477

	}

   478

   479

	return value;

   480

}

   481

   482

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

   483

static void NormalizeTrainVehInDepot(Vehicle *u)

   484

{

   485

	Vehicle *v;

   486

   487

	FOR_ALL_VEHICLES(v) {

   488

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

   489

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

   490

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

   491

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

   492

					CMD_MOVE_RAIL_VEHICLE) == CMD_ERROR)

   493

				break;

   494

		}