1

/* $Id$ */

     2

     3

#include "stdafx.h"

     4

#include "openttd.h"

     5

#include "aircraft.h"

     6

#include "debug.h"

     7

#include "functions.h"

     8

#include "station_map.h"

     9

#include "table/strings.h"

    10

#include "map.h"

    11

#include "tile.h"

    12

#include "vehicle.h"

    13

#include "depot.h"

    14

#include "engine.h"

    15

#include "command.h"

    16

#include "station.h"

    17

#include "news.h"

    18

#include "sound.h"

    19

#include "player.h"

    20

#include "aircraft.h"

    21

#include "airport.h"

    22

#include "vehicle_gui.h"

    23

#include "table/sprites.h"

    24

#include "newgrf_engine.h"

    25

#include "newgrf_callbacks.h"

    26

#include "newgrf_text.h"

    27

#include "newgrf_sound.h"

    28

#include "date.h"

    29

#include "spritecache.h"

    30

    31

// this maps the terminal to its corresponding state and block flag

    32

// currently set for 10 terms, 4 helipads

    33

static const byte _airport_terminal_state[] = {2, 3, 4, 5, 6, 7, 19, 20, 0, 0, 8, 9, 21, 22};

    34

static const byte _airport_terminal_flag[] =  {0, 1, 2, 3, 4, 5, 22, 23, 0, 0, 6, 7, 24, 25};

    35

    36

static bool AirportMove(Vehicle *v, const AirportFTAClass *apc);

    37

static bool AirportSetBlocks(Vehicle *v, AirportFTA *current_pos, const AirportFTAClass *apc);

    38

static bool AirportHasBlock(Vehicle *v, const AirportFTA *current_pos, const AirportFTAClass *apc);

    39

static bool AirportFindFreeTerminal(Vehicle *v, const AirportFTAClass *apc);

    40

static bool AirportFindFreeHelipad(Vehicle *v, const AirportFTAClass *apc);

    41

static void AirportGoToNextPosition(Vehicle *v, const AirportFTAClass *apc);

    42

static void CrashAirplane(Vehicle *v);

    43

    44

static void AircraftNextAirportPos_and_Order(Vehicle *v);

    45

static byte GetAircraftFlyingAltitude(const Vehicle *v);

    46

    47

static const SpriteID _aircraft_sprite[] = {

    48

	0x0EB5, 0x0EBD, 0x0EC5, 0x0ECD,

    49

	0x0ED5, 0x0EDD, 0x0E9D, 0x0EA5,

    50

	0x0EAD, 0x0EE5, 0x0F05, 0x0F0D,

    51

	0x0F15, 0x0F1D, 0x0F25, 0x0F2D,

    52

	0x0EED, 0x0EF5, 0x0EFD, 0x0F35,

    53

	0x0E9D, 0x0EA5, 0x0EAD, 0x0EB5,

    54

	0x0EBD, 0x0EC5

    55

};

    56

    57

/* Helicopter rotor animation states */

    58

enum HelicopterRotorStates {

    59

	HRS_ROTOR_STOPPED,

    60

	HRS_ROTOR_MOVING_1,

    61

	HRS_ROTOR_MOVING_2,

    62

	HRS_ROTOR_MOVING_3,

    63

};

    64

    65

/* Find the nearest hangar to v

    66

 * INVALID_STATION is returned, if the player does not have any suitable

    67

 * airports (like helipads only)

    68

 */

    69

static StationID FindNearestHangar(const Vehicle *v)

    70

{

    71

	const Station *st;

    72

	uint best = 0;

    73

	StationID index = INVALID_STATION;

    74

	TileIndex vtile = TileVirtXY(v->x_pos, v->y_pos);

    75

    76

	FOR_ALL_STATIONS(st) {

    77

		if (st->owner == v->owner && st->facilities & FACIL_AIRPORT &&

    78

				GetAirport(st->airport_type)->nof_depots > 0) {

    79

			uint distance;

    80

    81

			// don't crash the plane if we know it can't land at the airport

    82

			if ((AircraftVehInfo(v->engine_type)->subtype & AIR_FAST) &&

    83

					(st->airport_type == AT_SMALL || st->airport_type == AT_COMMUTER) &&

    84

					!_cheats.no_jetcrash.value)

    85

				continue;

    86

    87

			// v->tile can't be used here, when aircraft is flying v->tile is set to 0

    88

			distance = DistanceSquare(vtile, st->airport_tile);

    89

			if (distance < best || index == INVALID_STATION) {

    90

				best = distance;

    91

				index = st->index;

    92

			}

    93

		}

    94

	}

    95

	return index;

    96

}

    97

    98

#if 0

    99

// returns true if vehicle v have an airport in the schedule, that has a hangar

   100

static bool HaveHangarInOrderList(Vehicle *v)

   101

{

   102

	const Order *order;

   103

   104

	FOR_VEHICLE_ORDERS(v, order) {

   105

		const Station *st = GetStation(order->station);

   106

		if (st->owner == v->owner && st->facilities & FACIL_AIRPORT) {

   107

			// If an airport doesn't have a hangar, skip it

   108

			if (GetAirport(st->airport_type)->nof_depots != 0)

   109

				return true;

   110

		}

   111

	}

   112

   113

	return false;

   114

}

   115

#endif

   116

   117

int GetAircraftImage(const Vehicle* v, Direction direction)

   118

{

   119

	int spritenum = v->spritenum;

   120

   121

	if (is_custom_sprite(spritenum)) {

   122

		int sprite = GetCustomVehicleSprite(v, direction);

   123

   124

		if (sprite != 0) return sprite;

   125

		spritenum = orig_aircraft_vehicle_info[v->engine_type - AIRCRAFT_ENGINES_INDEX].image_index;

   126

	}

   127

	return direction + _aircraft_sprite[spritenum];

   128

}

   129

   130

SpriteID GetRotorImage(const Vehicle *v)

   131

{

   132

	const Vehicle *w;

   133

   134

	assert(v->subtype == AIR_HELICOPTER);

   135

   136

	w = v->next->next;

   137

	if (is_custom_sprite(v->spritenum)) {

   138

		SpriteID spritenum = GetCustomRotorSprite(v, false);

   139

		if (spritenum != 0) return spritenum;

   140

	}

   141

   142

	/* Return standard rotor sprites if there are no custom sprites for this helicopter */

   143

	return SPR_ROTOR_STOPPED + w->u.air.state;

   144

}

   145

   146

void DrawAircraftEngine(int x, int y, EngineID engine, SpriteID pal)

   147

{

   148

	const AircraftVehicleInfo* avi = AircraftVehInfo(engine);

   149

	int spritenum = avi->image_index;

   150

	SpriteID sprite = (6 + _aircraft_sprite[spritenum]);

   151

   152

	if (is_custom_sprite(spritenum)) {

   153

		sprite = GetCustomVehicleIcon(engine, DIR_W);

   154

		if (sprite == 0) {

   155

			spritenum = orig_aircraft_vehicle_info[engine - AIRCRAFT_ENGINES_INDEX].image_index;

   156

			sprite = (6 + _aircraft_sprite[spritenum]);

   157

		}

   158

	}

   159

   160

	DrawSprite(sprite, pal, x, y);

   161

   162

	if (!(avi->subtype & AIR_CTOL)) {

   163

		SpriteID rotor_sprite = GetCustomRotorIcon(engine);

   164

		if (rotor_sprite == 0) rotor_sprite = SPR_ROTOR_STOPPED;

   165

		DrawSprite(rotor_sprite, PAL_NONE, x, y - 5);

   166

	}

   167

}

   168

   169

/** Get the size of the sprite of an aircraft sprite heading west (used for lists)

   170

 * @param engine The engine to get the sprite from

   171

 * @param &width The width of the sprite

   172

 * @param &height The height of the sprite

   173

 */

   174

void GetAircraftSpriteSize(EngineID engine, uint &width, uint &height)

   175

{

   176

	const AircraftVehicleInfo* avi = AircraftVehInfo(engine);

   177

	int spritenum = avi->image_index;

   178

	SpriteID sprite = (6 + _aircraft_sprite[spritenum]);

   179

   180

	if (is_custom_sprite(spritenum)) {

   181

		sprite = GetCustomVehicleIcon(engine, DIR_W);

   182

		if (sprite == 0) {

   183

			spritenum = orig_aircraft_vehicle_info[engine - AIRCRAFT_ENGINES_INDEX].image_index;

   184

			sprite = (6 + _aircraft_sprite[spritenum]);

   185

		}

   186

	}

   187

   188

	const Sprite *spr = GetSprite(sprite);

   189

   190

	width  = spr->width ;

   191

	height = spr->height;

   192

}

   193

   194

static int32 EstimateAircraftCost(const AircraftVehicleInfo *avi)

   195

{

   196

	return avi->base_cost * (_price.aircraft_base >> 3) >> 5;

   197

}

   198

   199

   200

/**

   201

 * Calculates cargo capacity based on an aircraft's passenger

   202

 * and mail capacities.

   203

 * @param cid Which cargo type to calculate a capacity for.

   204

 * @param engine Which engine to find a cargo capacity for.

   205

 * @return New cargo capacity value.

   206

 */

   207

uint16 AircraftDefaultCargoCapacity(CargoID cid, EngineID engine_type)

   208

{

   209

	const AircraftVehicleInfo *avi = AircraftVehInfo(engine_type);

   210

   211

	assert(cid != CT_INVALID);

   212

   213

	/* An aircraft can carry twice as much goods as normal cargo,

   214

	 * and four times as many passengers. */

   215

	switch (cid) {

   216

		case CT_PASSENGERS:

   217

			return avi->passenger_capacity;

   218

		case CT_MAIL:

   219

			return avi->passenger_capacity + avi->mail_capacity;

   220

		case CT_GOODS:

   221

			return (avi->passenger_capacity + avi->mail_capacity) / 2;

   222

		default:

   223

			return (avi->passenger_capacity + avi->mail_capacity) / 4;

   224

	}

   225

}

   226

   227

   228

/** Build an aircraft.

   229

 * @param tile tile of depot where aircraft is built

   230

 * @param p1 aircraft type being built (engine)

   231

 * @param p2 bit 0 when set, the unitnumber will be 0, otherwise it will be a free number

   232

 */

   233

int32 CmdBuildAircraft(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)

   234

{

   235

	Vehicle *vl[3];

   236

	UnitID unit_num;

   237

   238

	if (!IsEngineBuildable(p1, VEH_Aircraft, _current_player)) return_cmd_error(STR_ENGINE_NOT_BUILDABLE);

   239

   240

	const AircraftVehicleInfo *avi = AircraftVehInfo(p1);

   241

	int32 value = EstimateAircraftCost(avi);

   242

   243

	// to just query the cost, it is not neccessary to have a valid tile (automation/AI)

   244

	if (flags & DC_QUERY_COST) return value;

   245

   246

	if (!IsHangarTile(tile) || !IsTileOwner(tile, _current_player)) return CMD_ERROR;

   247

   248

	SET_EXPENSES_TYPE(EXPENSES_NEW_VEHICLES);

   249

   250

	// Prevent building aircraft types at places which can't handle them

   251

	const Station* st = GetStationByTile(tile);

   252

	const AirportFTAClass* apc = GetAirport(st->airport_type);

   253

	if ((avi->subtype & AIR_CTOL ? HELICOPTERS_ONLY : AIRCRAFT_ONLY) == apc->acc_planes) {

   254

		return CMD_ERROR;

   255

	}

   256

   257

	/* Allocate 2 or 3 vehicle structs, depending on type

   258

	 * vl[0] = aircraft, vl[1] = shadow, [vl[2] = rotor] */

   259

	if (!AllocateVehicles(vl, avi->subtype & AIR_CTOL ? 2 : 3)) {

   260

		return_cmd_error(STR_00E1_TOO_MANY_VEHICLES_IN_GAME);

   261

	}

   262

   263

	unit_num = HASBIT(p2, 0) ? 0 : GetFreeUnitNumber(VEH_Aircraft);

   264

	if (unit_num > _patches.max_aircraft)

   265

		return_cmd_error(STR_00E1_TOO_MANY_VEHICLES_IN_GAME);

   266

   267

	if (flags & DC_EXEC) {

   268

		CargoID cargo;

   269

		uint x;

   270

		uint y;

   271

   272

		Vehicle *v = vl[0]; // aircraft

   273

		Vehicle *u = vl[1]; // shadow

   274

   275

		v->unitnumber = unit_num;

   276

		v->type = u->type = VEH_Aircraft;

   277

		v->direction = DIR_SE;

   278

   279

		v->owner = u->owner = _current_player;

   280

   281

		v->tile = tile;

   282

//		u->tile = 0;

   283

   284

		x = TileX(tile) * TILE_SIZE + 5;

   285

		y = TileY(tile) * TILE_SIZE + 3;

   286

   287

		v->x_pos = u->x_pos = x;

   288

		v->y_pos = u->y_pos = y;

   289

   290

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

   291

		v->z_pos = u->z_pos + 1;

   292

   293

		v->x_offs = v->y_offs = -1;

   294

//		u->delta_x = u->delta_y = 0;

   295

   296

		v->sprite_width = v->sprite_height = 2;

   297

		v->z_height = 5;

   298

   299

		u->sprite_width = u->sprite_height = 2;

   300

		u->z_height = 1;

   301

   302

		v->vehstatus = VS_HIDDEN | VS_STOPPED | VS_DEFPAL;

   303

		u->vehstatus = VS_HIDDEN | VS_UNCLICKABLE | VS_SHADOW;

   304

   305

		v->spritenum = avi->image_index;

   306

//		v->cargo_count = u->number_of_pieces = 0;

   307

   308

		v->cargo_cap = avi->passenger_capacity;

   309

		u->cargo_cap = avi->mail_capacity;

   310

   311

		v->cargo_type = CT_PASSENGERS;

   312

		u->cargo_type = CT_MAIL;

   313

   314

		v->cargo_subtype = 0;

   315

   316

		v->string_id = STR_SV_AIRCRAFT_NAME;

   317

//		v->next_order_param = v->next_order = 0;

   318

   319

//		v->load_unload_time_rem = 0;

   320

//		v->progress = 0;

   321

		v->last_station_visited = INVALID_STATION;

   322

//		v->destination_coords = 0;

   323

   324

		v->max_speed = avi->max_speed;

   325

		v->acceleration = avi->acceleration;

   326

		v->engine_type = p1;

   327

   328

		v->subtype = (avi->subtype & AIR_CTOL ? AIR_AIRCRAFT : AIR_HELICOPTER);

   329

		v->value = value;

   330

   331

		u->subtype = AIR_SHADOW;

   332

   333

		/* Danger, Will Robinson!

   334

		 * If the aircraft is refittable, but cannot be refitted to

   335

		 * passengers, we select the cargo type from the refit mask.

   336

		 * This is a fairly nasty hack to get around the fact that TTD

   337

		 * has no default cargo type specifier for planes... */

   338

		cargo = FindFirstRefittableCargo(p1);

   339

		if (cargo != CT_INVALID && cargo != CT_PASSENGERS) {

   340

			uint16 callback = CALLBACK_FAILED;

   341

   342

			v->cargo_type = cargo;

   343

   344

			if (HASBIT(EngInfo(p1)->callbackmask, CBM_REFIT_CAPACITY)) {

   345

				callback = GetVehicleCallback(CBID_VEHICLE_REFIT_CAPACITY, 0, 0, v->engine_type, v);

   346

			}

   347

   348

			if (callback == CALLBACK_FAILED) {

   349

				/* Callback failed, or not executed; use the default cargo capacity */

   350

				v->cargo_cap = AircraftDefaultCargoCapacity(v->cargo_type, v->engine_type);

   351

			} else {

   352

				v->cargo_cap = callback;

   353

			}

   354

   355

			/* Set the 'second compartent' capacity to none */

   356

			u->cargo_cap = 0;

   357

		}

   358

   359

		const Engine *e = GetEngine(p1);

   360

		v->reliability = e->reliability;

   361

		v->reliability_spd_dec = e->reliability_spd_dec;

   362

		v->max_age = e->lifelength * 366;

   363

   364

		_new_vehicle_id = v->index;

   365

   366

		/* When we click on hangar we know the tile it is on. By that we know

   367

		 * its position in the array of depots the airport has.....we can search

   368

		 * layout for #th position of depot. Since layout must start with a listing

   369

		 * of all depots, it is simple */

   370

		for (uint i = 0;; i++) {

   371

			assert(i != apc->nof_depots);

   372

			if (st->airport_tile + ToTileIndexDiff(apc->airport_depots[i]) == tile) {

   373

				assert(apc->layout[i].heading == HANGAR);

   374

				v->u.air.pos = apc->layout[i].position;

   375

				break;

   376

			}

   377

		}

   378

   379

		v->u.air.state = HANGAR;

   380

		v->u.air.previous_pos = v->u.air.pos;

   381

		v->u.air.targetairport = GetStationIndex(tile);

   382

		v->next = u;

   383

   384

		v->service_interval = _patches.servint_aircraft;

   385

   386

		v->date_of_last_service = _date;

   387

		v->build_year = u->build_year = _cur_year;

   388

   389

		v->cur_image = u->cur_image = 0xEA0;

   390

   391

		v->random_bits = VehicleRandomBits();

   392

		u->random_bits = VehicleRandomBits();

   393

   394

		VehiclePositionChanged(v);

   395

		VehiclePositionChanged(u);

   396

   397

		// Aircraft with 3 vehicles (chopper)?

   398

		if (v->subtype == AIR_HELICOPTER) {

   399

			Vehicle *w = vl[2];

   400

   401

			u->next = w;

   402

   403

			w->type = VEH_Aircraft;

   404

			w->direction = DIR_N;

   405

			w->owner = _current_player;

   406

			w->x_pos = v->x_pos;

   407

			w->y_pos = v->y_pos;

   408

			w->z_pos = v->z_pos + 5;

   409

			w->x_offs = w->y_offs = -1;

   410

			w->sprite_width = w->sprite_height = 2;

   411

			w->z_height = 1;

   412

			w->vehstatus = VS_HIDDEN | VS_UNCLICKABLE;

   413

			w->spritenum = 0xFF;

   414

			w->subtype = AIR_ROTOR;

   415

			w->cur_image = SPR_ROTOR_STOPPED;

   416

			w->random_bits = VehicleRandomBits();

   417

			/* Use rotor's air.state to store the rotor animation frame */

   418

			w->u.air.state = HRS_ROTOR_STOPPED;

   419

			VehiclePositionChanged(w);

   420

		}

   421

   422

		InvalidateWindowData(WC_VEHICLE_DEPOT, v->tile);

   423

		RebuildVehicleLists();

   424

		InvalidateWindow(WC_COMPANY, v->owner);

   425

		if (IsLocalPlayer())

   426

			InvalidateAutoreplaceWindow(VEH_Aircraft); //updates the replace Aircraft window

   427

   428

		GetPlayer(_current_player)->num_engines[p1]++;

   429

	}

   430

   431

	return value;

   432

}

   433

   434

   435

static void DoDeleteAircraft(Vehicle *v)

   436

{

   437

	DeleteWindowById(WC_VEHICLE_VIEW, v->index);

   438

	RebuildVehicleLists();

   439

	InvalidateWindow(WC_COMPANY, v->owner);

   440

	DeleteDepotHighlightOfVehicle(v);

   441

	DeleteVehicleChain(v);

   442

	InvalidateWindowClasses(WC_AIRCRAFT_LIST);

   443

}

   444

   445

/** Sell an aircraft.

   446

 * @param tile unused

   447

 * @param p1 vehicle ID to be sold

   448

 * @param p2 unused

   449

 */

   450

int32 CmdSellAircraft(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)

   451

{

   452

	Vehicle *v;

   453

   454

	if (!IsValidVehicleID(p1)) return CMD_ERROR;

   455

   456

	v = GetVehicle(p1);

   457

   458

	if (v->type != VEH_Aircraft || !CheckOwnership(v->owner)) return CMD_ERROR;

   459

	if (!IsAircraftInHangarStopped(v)) return_cmd_error(STR_A01B_AIRCRAFT_MUST_BE_STOPPED);

   460

   461

	SET_EXPENSES_TYPE(EXPENSES_NEW_VEHICLES);

   462

   463

	if (flags & DC_EXEC) {

   464

		// Invalidate depot

   465

		InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   466

		DoDeleteAircraft(v);

   467

	}

   468

   469

	return -(int32)v->value;

   470

}

   471

   472

/** Start/Stop an aircraft.

   473

 * @param tile unused

   474

 * @param p1 aircraft ID to start/stop

   475

 * @param p2 unused

   476

 */

   477

int32 CmdStartStopAircraft(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)

   478

{

   479

	Vehicle *v;

   480

	uint16 callback;

   481

   482

	if (!IsValidVehicleID(p1)) return CMD_ERROR;

   483

   484

	v = GetVehicle(p1);

   485

   486

	if (v->type != VEH_Aircraft || !CheckOwnership(v->owner)) return CMD_ERROR;

   487

   488

	// cannot stop airplane when in flight, or when taking off / landing

   489

	if (v->u.air.state >= STARTTAKEOFF && v->u.air.state < TERM7)

   490

		return_cmd_error(STR_A017_AIRCRAFT_IS_IN_FLIGHT);

   491

   492

	/* Check if this aircraft can be started/stopped. The callback will fail or

   493

	 * return 0xFF if it can. */