1

/* $Id$ */

     2

     3

#include "stdafx.h"

     4

#include "openttd.h"

     5

#include "debug.h"

     6

#include "functions.h"

     7

#include "table/strings.h"

     8

#include "map.h"

     9

#include "tile.h"

    10

#include "vehicle.h"

    11

#include "command.h"

    12

#include "pathfind.h"

    13

#include "npf.h"

    14

#include "station.h"

    15

#include "table/train_cmd.h"

    16

#include "news.h"

    17

#include "engine.h"

    18

#include "player.h"

    19

#include "sound.h"

    20

#include "depot.h"

    21

#include "debug.h"

    22

#include "waypoint.h"

    23

#include "vehicle_gui.h"

    24

    25

#define IS_FIRSTHEAD_SPRITE(spritenum) \

    26

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

    27

    28

static bool TrainCheckIfLineEnds(Vehicle *v);

    29

static void TrainController(Vehicle *v);

    30

extern void ShowTrainViewWindow(Vehicle *v);

    31

    32

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

    33

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

    34

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

    35

    36

/**

    37

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

    38

 * the consist changes.

    39

 * @param v First vehicle of the consist.

    40

 */

    41

void TrainCargoChanged(Vehicle *v) {

    42

	Vehicle *u;

    43

	uint16 weight = 0;

    44

    45

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

    46

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

    47

		uint16 vweight = 0;

    48

    49

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

    50

		vweight += rvi->weight;

    51

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

    52

		// powered wagons have extra weight added

    53

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

    54

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

    55

    56

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

    57

		weight += vweight;

    58

    59

		// store vehicle weight in cache

    60

		u->u.rail.cached_veh_weight = vweight;

    61

	};

    62

    63

	// store consist weight in cache

    64

	v->u.rail.cached_weight = weight;

    65

}

    66

    67

/**

    68

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

    69

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

    70

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

    71

 * @param v First vehicle of the chain.

    72

 */

    73

void TrainConsistChanged(Vehicle *v) {

    74

	const RailVehicleInfo *rvi_v;

    75

	Vehicle *u;

    76

	uint16 max_speed = 0xFFFF;

    77

	uint32 power = 0;

    78

	EngineID first_engine;

    79

    80

	assert(v->type == VEH_Train);

    81

    82

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

    83

    84

	rvi_v = RailVehInfo(v->engine_type);

    85

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

    86

    87

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

    88

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

    89

		uint16 veh_len;

    90

    91

		// update the 'first engine'

    92

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

    93

    94

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

    95

		power += rvi_u->power;

    96

    97

		// check if its a powered wagon

    98

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

    99

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

   100

			uint16 callback = CALLBACK_FAILED;

   101

   102

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

   103

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

   104

   105

			if (callback == CALLBACK_FAILED)

   106

				callback = rvi_u->visual_effect;

   107

   108

			if (callback < 0x40) {

   109

				/* wagon is powered */

   110

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

   111

				power += rvi_v->pow_wag_power;

   112

			}

   113

		}

   114

   115

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

   116

		if (rvi_u->max_speed != 0)

   117

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

   118

   119

		// check the vehicle length (callback)

   120

		veh_len = CALLBACK_FAILED;

   121

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

   122

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

   123

		if (veh_len == CALLBACK_FAILED)

   124

			veh_len = rvi_u->shorten_factor;

   125

		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

   126

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

   127

   128

	};

   129

   130

	// store consist weight/max speed in cache

   131

	v->u.rail.cached_max_speed = max_speed;

   132

	v->u.rail.cached_power = power;

   133

   134

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

   135

	TrainCargoChanged(v);

   136

}

   137

   138

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

   139

 * be interpreted? */

   140

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

   141

	{7, 1},

   142

	{0, 2},

   143

	{1, 3},

   144

	{2, 4},

   145

	{3, 5},

   146

	{4, 6},

   147

	{5, 7},

   148

	{6, 0},

   149

};

   150

   151

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

   152

	{6, 2},

   153

	{7, 3},

   154

	{0, 4},

   155

	{1, 5},

   156

	{2, 6},

   157

	{3, 7},

   158

	{4, 0},

   159

	{5, 1},

   160

};

   161

   162

enum AccelType {

   163

	AM_ACCEL,

   164

	AM_BRAKE

   165

};

   166

   167

static bool TrainShouldStop(Vehicle *v, TileIndex tile)

   168

{

   169

	Order *o = &v->current_order;

   170

	assert(v->type == VEH_Train);

   171

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

   172

	//When does a train drive through a station

   173

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

   174

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

   175

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

   176

		return false;

   177

   178

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

   179

		return false;

   180

   181

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

   182

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

   183

		return false;

   184

   185

	return true;

   186

}

   187

   188

//new acceleration

   189

static int GetTrainAcceleration(Vehicle *v, bool mode)

   190

{

   191

	const Vehicle *u;

   192

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

   193

	int power = 0;

   194

	int mass = 0;

   195

	int max_speed = 2000;

   196

	int area = 120;

   197

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

   198

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

   199

	int incl = 0;

   200

	int resistance;

   201

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

   202

	int force = 0x3FFFFFFF;

   203

	int pos = 0;

   204

	int lastpos = -1;

   205

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

   206

	int sum = 0;

   207

	int numcurve = 0;

   208

   209

	speed *= 10;

   210

	speed /= 16;

   211

   212

	//first find the curve speed limit

   213

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

   214

		int dir = u->direction;

   215

		int ndir = u->next->direction;

   216

		int i;

   217

   218

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

   219

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

   220

				curvecount[i]++;

   221

				if (lastpos != -1) {

   222

					numcurve++;

   223

					sum += pos - lastpos;

   224

					if (pos - lastpos == 1) {

   225

						max_speed = 88;

   226

					}

   227

				}

   228

				lastpos = pos;

   229

			}

   230

		}

   231

   232

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

   233

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

   234

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

   235

			max_speed = 61;

   236

		}

   237

	}

   238

   239

	if (numcurve > 0) sum /= numcurve;

   240

   241

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

   242

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

   243

   244

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

   245

			max_speed = 0xFFFF;

   246

		} else if (total > 1) {

   247

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

   248

		}

   249

	}

   250

   251

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

   252

   253

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

   254

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

   255

			int station_length = 0;

   256

			TileIndex tile = v->tile;

   257

			int delta_v;

   258

   259

			max_speed = 120;

   260

			do {

   261

				station_length++;

   262

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

   263

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

   264

   265

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

   266

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

   267

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

   268

   269

			max_speed = max(max_speed, 25 * station_length);

   270

		}

   271

	}

   272

   273

	mass = v->u.rail.cached_weight;

   274

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

   275

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

   276

   277

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

   278

		num++;

   279

		drag_coeff += 3;

   280

   281

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

   282

			max_speed = min(61, max_speed);

   283

   284

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

   285

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

   286

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

   287

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

   288

		}

   289

	}

   290

   291

	v->max_speed = max_speed;

   292

   293

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

   294

		resistance = 13 * mass / 10;

   295

		resistance += 60 * num;

   296

		resistance += friction * mass * speed / 1000;

   297

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

   298

	} else

   299

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

   300

	resistance += incl;

   301

	resistance *= 4; //[N]

   302

   303

	if (speed > 0) {

   304

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

   305

			case 0:

   306

			case 1:

   307

				force = power / speed; //[N]

   308

				force *= 22;

   309

				force /= 10;

   310

				break;

   311

   312

			case 2:

   313

				force = power / 25;

   314

				break;

   315

		}

   316

	} else {

   317

		//"kickoff" acceleration

   318

		force = (mass * 8) + resistance;

   319

	}

   320

   321

	if (force <= 0) force = 10000;

   322

   323

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

   324

   325

	if (mode == AM_ACCEL) {

   326

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

   327

	} else {

   328

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

   329

	}

   330

}

   331

   332

void UpdateTrainAcceleration(Vehicle *v)

   333

{

   334

	uint power = 0;

   335

	uint weight = 0;

   336

   337

	assert(v->subtype == TS_Front_Engine);

   338

   339

	weight = v->u.rail.cached_weight;

   340

	power = v->u.rail.cached_power;

   341

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

   342

   343

	assert(weight != 0);

   344

   345

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

   346

}

   347

   348

int GetTrainImage(const Vehicle *v, byte direction)

   349

{

   350

	int img = v->spritenum;

   351

	int base;

   352

   353

	if (is_custom_sprite(img)) {

   354

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

   355

		if (base != 0) return base;

   356

		img = _engine_original_sprites[v->engine_type];

   357

	}

   358

   359

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

   360

   361

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

   362

		base += _wagon_full_adder[img];

   363

	return base;

   364

}

   365

   366

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

   367

{

   368

	const RailVehicleInfo *rvi = RailVehInfo(engine);

   369

   370

	int img = rvi->image_index;

   371

	uint32 image = 0;

   372

   373

	if (is_custom_sprite(img)) {

   374

		image = GetCustomVehicleIcon(engine, 6);

   375

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

   376

	}

   377

	if (image == 0) {

   378

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

   379

	}

   380

   381

	if (rvi->flags & RVI_MULTIHEAD) {

   382

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

   383

		x += 15;

   384

		image = 0;

   385

		if (is_custom_sprite(img)) {

   386

			image = GetCustomVehicleIcon(engine, 2);

   387

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

   388

		}

   389

		if (image == 0) {

   390

			image =

   391

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

   392

				_engine_sprite_base[img + 1];

   393

		}

   394

	}

   395

	DrawSprite(image | image_ormod, x, y);

   396

}

   397

   398

   399

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

   400

{

   401

	int32 value;

   402

	Vehicle *v;

   403

	const RailVehicleInfo *rvi;

   404

	const Engine *e;

   405

	int x,y;

   406

   407

	SET_EXPENSES_TYPE(EXPENSES_NEW_VEHICLES);

   408

   409

	rvi = RailVehInfo(engine);

   410

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

   411

   412

	if (!(flags & DC_QUERY_COST)) {

   413

		_error_message = STR_00E1_TOO_MANY_VEHICLES_IN_GAME;

   414

   415

		v = AllocateVehicle();

   416

		if (v == NULL)

   417

			return CMD_ERROR;

   418

   419

		if (flags & DC_EXEC) {

   420

			byte img = rvi->image_index;

   421

			Vehicle *u, *w;

   422

			uint dir;

   423

   424

			v->spritenum = img;

   425

   426

			u = NULL;

   427

   428

			FOR_ALL_VEHICLES(w) {

   429

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

   430

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

   431

					u = GetLastVehicleInChain(w);

   432

					break;

   433

				}

   434

			}

   435

   436

			v->engine_type = engine;

   437

   438

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

   439

   440

			v->direction = dir * 2 + 1;

   441

			v->tile = tile;

   442

   443

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

   444

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

   445

   446

			v->x_pos = x;

   447

			v->y_pos = y;

   448

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

   449

			v->owner = _current_player;

   450

			v->z_height = 6;

   451

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

   452

			v->vehstatus = VS_HIDDEN | VS_DEFPAL;

   453

   454

			v->subtype = TS_Free_Car;

   455

			if (u != NULL) {

   456

				u->next = v;

   457

				v->subtype = TS_Not_First;

   458

			}

   459

   460

			v->cargo_type = rvi->cargo_type;

   461

			v->cargo_cap = rvi->capacity;

   462

			v->value = value;

   463

//			v->day_counter = 0;

   464

   465

			e = GetEngine(engine);

   466

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

   467

   468

			v->build_year = _cur_year;

   469

			v->type = VEH_Train;

   470

			v->cur_image = 0xAC2;

   471

   472

			_new_wagon_id = v->index;

   473

   474

			VehiclePositionChanged(v);

   475

			TrainConsistChanged(GetFirstVehicleInChain(v));

   476

   477

			InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   478

		}

   479

	}

   480

   481

	return value;

   482

}

   483

   484

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

   485

static void NormalizeTrainVehInDepot(Vehicle *u)

   486

{

   487

	Vehicle *v;

   488

   489

	FOR_ALL_VEHICLES(v) {

   490

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

   491

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

   492

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

   493

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

   494

					CMD_MOVE_RAIL_VEHICLE) == CMD_ERROR)