1

/* $Id$ */

     2

     3

#include "stdafx.h"

     4

#include "openttd.h"

     5

#include "debug.h"

     6

#include "functions.h"

     7

#include "gui.h"

     8

#include "table/strings.h"

     9

#include "map.h"

    10

#include "tile.h"

    11

#include "vehicle.h"

    12

#include "command.h"

    13

#include "pathfind.h"

    14

#include "npf.h"

    15

#include "station.h"

    16

#include "table/train_cmd.h"

    17

#include "news.h"

    18

#include "engine.h"

    19

#include "player.h"

    20

#include "sound.h"

    21

#include "depot.h"

    22

#include "debug.h"

    23

#include "waypoint.h"

    24

#include "vehicle_gui.h"

    25

    26

#define IS_FIRSTHEAD_SPRITE(spritenum) \

    27

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

    28

    29

static bool TrainCheckIfLineEnds(Vehicle *v);

    30

static void TrainController(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

	v->u.rail.cached_total_length = 0;

    87

    88

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

    89

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

    90

		uint16 veh_len;

    91

    92

		// update the 'first engine'

    93

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

    94

    95

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

    96

		power += rvi_u->power;

    97

    98

		if (rvi_u->visual_effect != 0) {

    99

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

   100

		} else {

   101

			if (rvi_u->flags & RVI_WAGON) {

   102

				// Wagons have no effect by default

   103

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

   104

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

   105

				// Steam is offset by -4 units

   106

				u->u.rail.cached_vis_effect = 4;

   107

			} else {

   108

				// Diesel fumes and sparks come from the centre

   109

				u->u.rail.cached_vis_effect = 8;

   110

			}

   111

		}

   112

   113

		// check if its a powered wagon

   114

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

   115

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

   116

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

   117

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

   118

   119

				if (callback != CALLBACK_FAILED)

   120

					u->u.rail.cached_vis_effect = callback;

   121

			}

   122

   123

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

   124

				/* wagon is powered */

   125

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

   126

				power += rvi_v->pow_wag_power;

   127

			}

   128

		}

   129

   130

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

   131

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

   132

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

   133

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

   134

   135

		// check the vehicle length (callback)

   136

		veh_len = CALLBACK_FAILED;

   137

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

   138

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

   139

		if (veh_len == CALLBACK_FAILED)

   140

			veh_len = rvi_u->shorten_factor;

   141

		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

   142

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

   143

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

   144

   145

	};

   146

   147

	// store consist weight/max speed in cache

   148

	v->u.rail.cached_max_speed = max_speed;

   149

	v->u.rail.cached_power = power;

   150

   151

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

   152

	TrainCargoChanged(v);

   153

}

   154

   155

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

   156

 * be interpreted? */

   157

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

   158

	{7, 1},

   159

	{0, 2},

   160

	{1, 3},

   161

	{2, 4},

   162

	{3, 5},

   163

	{4, 6},

   164

	{5, 7},

   165

	{6, 0},

   166

};

   167

   168

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

   169

	{6, 2},

   170

	{7, 3},

   171

	{0, 4},

   172

	{1, 5},

   173

	{2, 6},

   174

	{3, 7},

   175

	{4, 0},

   176

	{5, 1},

   177

};

   178

   179

enum AccelType {

   180

	AM_ACCEL,

   181

	AM_BRAKE

   182

};

   183

   184

static bool TrainShouldStop(Vehicle *v, TileIndex tile)

   185

{

   186

	Order *o = &v->current_order;

   187

	assert(v->type == VEH_Train);

   188

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

   189

	//When does a train drive through a station

   190

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

   191

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

   192

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

   193

		return false;

   194

   195

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

   196

		return false;

   197

   198

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

   199

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

   200

		return false;

   201

   202

	return true;

   203

}

   204

   205

//new acceleration

   206

static int GetTrainAcceleration(Vehicle *v, bool mode)

   207

{

   208

	const Vehicle *u;

   209

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

   210

	int power = 0;

   211

	int mass = 0;

   212

	int max_speed = 2000;

   213

	int area = 120;

   214

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

   215

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

   216

	int incl = 0;

   217

	int resistance;

   218

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

   219

	int force = 0x3FFFFFFF;

   220

	int pos = 0;

   221

	int lastpos = -1;

   222

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

   223

	int sum = 0;

   224

	int numcurve = 0;

   225

   226

	speed *= 10;

   227

	speed /= 16;

   228

   229

	//first find the curve speed limit

   230

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

   231

		int dir = u->direction;

   232

		int ndir = u->next->direction;

   233

		int i;

   234

   235

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

   236

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

   237

				curvecount[i]++;

   238

				if (lastpos != -1) {

   239

					numcurve++;

   240

					sum += pos - lastpos;

   241

					if (pos - lastpos == 1) {

   242

						max_speed = 88;

   243

					}

   244

				}

   245

				lastpos = pos;

   246

			}

   247

		}

   248

   249

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

   250

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

   251

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

   252

			max_speed = 61;

   253

		}

   254

	}

   255

   256

	if (numcurve > 0) sum /= numcurve;

   257

   258

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

   259

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

   260

   261

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

   262

			max_speed = 0xFFFF;

   263

		} else if (total > 1) {

   264

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

   265

		}

   266

	}

   267

   268

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

   269

   270

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

   271

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

   272

			int station_length = 0;

   273

			TileIndex tile = v->tile;

   274

			int delta_v;

   275

   276

			max_speed = 120;

   277

			do {

   278

				station_length++;

   279

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

   280

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

   281

   282

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

   283

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

   284

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

   285

   286

			max_speed = max(max_speed, 25 * station_length);

   287

		}

   288

	}

   289

   290

	mass = v->u.rail.cached_weight;

   291

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

   292

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

   293

   294

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

   295

		num++;

   296

		drag_coeff += 3;

   297

   298

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

   299

			max_speed = min(61, max_speed);

   300

   301

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

   302

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

   303

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

   304

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

   305

		}

   306

	}

   307

   308

	v->max_speed = max_speed;

   309

   310

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

   311

		resistance = 13 * mass / 10;

   312

		resistance += 60 * num;

   313

		resistance += friction * mass * speed / 1000;

   314

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

   315

	} else

   316

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

   317

	resistance += incl;

   318

	resistance *= 4; //[N]

   319

   320

	if (speed > 0) {

   321

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

   322

			case RAILTYPE_RAIL:

   323

			case RAILTYPE_MONO:

   324

				force = power / speed; //[N]

   325

				force *= 22;

   326

				force /= 10;

   327

				break;

   328

   329

			case RAILTYPE_MAGLEV:

   330

				force = power / 25;

   331

				break;

   332

		}

   333

	} else {

   334

		//"kickoff" acceleration

   335

		force = (mass * 8) + resistance;

   336

	}

   337

   338

	if (force <= 0) force = 10000;

   339

   340

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

   341

   342

	if (mode == AM_ACCEL) {

   343

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

   344

	} else {

   345

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

   346

	}

   347

}

   348

   349

void UpdateTrainAcceleration(Vehicle *v)

   350

{

   351

	uint power = 0;

   352

	uint weight = 0;

   353

   354

	assert(v->subtype == TS_Front_Engine);

   355

   356

	weight = v->u.rail.cached_weight;

   357

	power = v->u.rail.cached_power;

   358

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

   359

   360

	assert(weight != 0);

   361

   362

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

   363

}

   364

   365

int GetTrainImage(const Vehicle *v, byte direction)

   366

{

   367

	int img = v->spritenum;

   368

	int base;

   369

   370

	if (is_custom_sprite(img)) {

   371

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

   372

		if (base != 0) return base;

   373

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

   374

	}

   375

   376

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

   377

   378

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

   379

		base += _wagon_full_adder[img];

   380

	return base;

   381

}

   382

   383

extern int _traininfo_vehicle_pitch;

   384

   385

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

   386

{

   387

	const RailVehicleInfo *rvi = RailVehInfo(engine);

   388

   389

	int img = rvi->image_index;

   390

	uint32 image = 0;

   391

   392

	if (is_custom_sprite(img)) {

   393

		image = GetCustomVehicleIcon(engine, 6);

   394

		if (image == 0) {

   395

			img = orig_rail_vehicle_info[engine].image_index;

   396

		} else {

   397

			y += _traininfo_vehicle_pitch;

   398

		}

   399

	}

   400

	if (image == 0) {

   401

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

   402

	}

   403

   404

	if (rvi->flags & RVI_MULTIHEAD) {

   405

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

   406

		x += 15;

   407

		image = 0;

   408

		if (is_custom_sprite(img)) {

   409

			image = GetCustomVehicleIcon(engine, 2);

   410

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

   411

		}

   412

		if (image == 0) {

   413

			image =

   414

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

   415

				_engine_sprite_base[img + 1];

   416

		}

   417

	}

   418

	DrawSprite(image | image_ormod, x, y);

   419

}

   420

   421

   422

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

   423

{

   424

	int32 value;

   425

	Vehicle *v;

   426

	const RailVehicleInfo *rvi;

   427

	const Engine *e;

   428

	int x,y;

   429

   430

	SET_EXPENSES_TYPE(EXPENSES_NEW_VEHICLES);

   431

   432

	rvi = RailVehInfo(engine);

   433

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

   434

   435

	if (!(flags & DC_QUERY_COST)) {

   436

		_error_message = STR_00E1_TOO_MANY_VEHICLES_IN_GAME;

   437

   438

		v = AllocateVehicle();

   439

		if (v == NULL)

   440

			return CMD_ERROR;

   441

   442

		if (flags & DC_EXEC) {

   443

			byte img = rvi->image_index;

   444

			Vehicle *u, *w;

   445

			uint dir;

   446

   447

			v->spritenum = img;

   448

   449

			u = NULL;

   450

   451

			FOR_ALL_VEHICLES(w) {

   452

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

   453

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

   454

					u = GetLastVehicleInChain(w);

   455

					break;

   456

				}

   457

			}

   458

   459

			v->engine_type = engine;

   460

   461

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

   462

   463

			v->direction = dir * 2 + 1;

   464

			v->tile = tile;

   465

   466

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

   467

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

   468

   469

			v->x_pos = x;

   470

			v->y_pos = y;

   471

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

   472

			v->owner = _current_player;

   473

			v->z_height = 6;

   474

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

   475

			v->vehstatus = VS_HIDDEN | VS_DEFPAL;

   476

   477

			v->subtype = TS_Free_Car;

   478

			if (u != NULL) {

   479

				u->next = v;

   480

				v->subtype = TS_Not_First;

   481

			}

   482

   483

			v->cargo_type = rvi->cargo_type;

   484

			v->cargo_cap = rvi->capacity;

   485

			v->value = value;

   486

//			v->day_counter = 0;

   487

   488

			e = GetEngine(engine);

   489

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

   490

   491

			v->build_year = _cur_year;

   492

			v->type = VEH_Train;