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

    30

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

    31

// currently set for 10 terms, 4 helipads

    32

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

    33

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

    34

    35

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

    36

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

    37

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

    38

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

    39

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

    40

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

    41

static void CrashAirplane(Vehicle *v);

    42

    43

static void AircraftNextAirportPos_and_Order(Vehicle *v);

    44

static byte GetAircraftFlyingAltitude(const Vehicle *v);

    45

    46

static const SpriteID _aircraft_sprite[] = {

    47

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

    48

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

    49

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

    50

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

    51

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

    52

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

    53

	0x0EBD, 0x0EC5

    54

};

    55

    56

/* Helicopter rotor animation states */

    57

enum HelicopterRotorStates {

    58

	HRS_ROTOR_STOPPED,

    59

	HRS_ROTOR_MOVING_1,

    60

	HRS_ROTOR_MOVING_2,

    61

	HRS_ROTOR_MOVING_3,

    62

};

    63

    64

/* Find the nearest hangar to v

    65

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

    66

 * airports (like helipads only)

    67

 */

    68

static StationID FindNearestHangar(const Vehicle *v)

    69

{

    70

	const Station *st;

    71

	uint best = 0;

    72

	StationID index = INVALID_STATION;

    73

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

    74

    75

	FOR_ALL_STATIONS(st) {

    76

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

    77

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

    78

			uint distance;

    79

    80

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

    81

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

    82

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

    83

					!_cheats.no_jetcrash.value)

    84

				continue;

    85

    86

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

    87

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

    88

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

    89

				best = distance;

    90

				index = st->index;

    91

			}

    92

		}

    93

	}

    94

	return index;

    95

}

    96

    97

#if 0

    98

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

    99

static bool HaveHangarInOrderList(Vehicle *v)

   100

{

   101

	const Order *order;

   102

   103

	FOR_VEHICLE_ORDERS(v, order) {

   104

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

   105

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

   106

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

   107

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

   108

				return true;

   109

		}

   110

	}

   111

   112

	return false;

   113

}

   114

#endif

   115

   116

int GetAircraftImage(const Vehicle* v, Direction direction)

   117

{

   118

	int spritenum = v->spritenum;

   119

   120

	if (is_custom_sprite(spritenum)) {

   121

		int sprite = GetCustomVehicleSprite(v, direction);

   122

   123

		if (sprite != 0) return sprite;

   124

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

   125

	}

   126

	return direction + _aircraft_sprite[spritenum];

   127

}

   128

   129

SpriteID GetRotorImage(const Vehicle *v)

   130

{

   131

	const Vehicle *w;

   132

   133

	assert(v->subtype == AIR_HELICOPTER);

   134

   135

	w = v->next->next;

   136

	if (is_custom_sprite(v->spritenum)) {

   137

		SpriteID spritenum = GetCustomRotorSprite(v, false);

   138

		if (spritenum != 0) return spritenum;

   139

	}

   140

   141

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

   142

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

   143

}

   144

   145

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

   146

{

   147

	const AircraftVehicleInfo* avi = AircraftVehInfo(engine);

   148

	int spritenum = avi->image_index;

   149

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

   150

   151

	if (is_custom_sprite(spritenum)) {

   152

		sprite = GetCustomVehicleIcon(engine, DIR_W);

   153

		if (sprite == 0) {

   154

			spritenum = orig_aircraft_vehicle_info[engine - AIRCRAFT_ENGINES_INDEX].image_index;

   155

			sprite = (6 + _aircraft_sprite[spritenum]);

   156

		}

   157

	}

   158

   159

	DrawSprite(sprite, pal, x, y);

   160

   161

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

   162

		SpriteID rotor_sprite = GetCustomRotorIcon(engine);

   163

		if (rotor_sprite == 0) rotor_sprite = SPR_ROTOR_STOPPED;

   164

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

   165

	}

   166

}

   167

   168

static int32 EstimateAircraftCost(const AircraftVehicleInfo *avi)

   169

{

   170

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

   171

}

   172

   173

   174

/**

   175

 * Calculates cargo capacity based on an aircraft's passenger

   176

 * and mail capacities.

   177

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

   178

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

   179

 * @return New cargo capacity value.

   180

 */

   181

uint16 AircraftDefaultCargoCapacity(CargoID cid, EngineID engine_type)

   182

{

   183

	const AircraftVehicleInfo *avi = AircraftVehInfo(engine_type);

   184

   185

	assert(cid != CT_INVALID);

   186

   187

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

   188

	 * and four times as many passengers. */

   189

	switch (cid) {

   190

		case CT_PASSENGERS:

   191

			return avi->passenger_capacity;

   192

		case CT_MAIL:

   193

			return avi->passenger_capacity + avi->mail_capacity;

   194

		case CT_GOODS:

   195

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

   196

		default:

   197

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

   198

	}

   199

}

   200

   201

   202

/** Build an aircraft.

   203

 * @param tile tile of depot where aircraft is built

   204

 * @param p1 aircraft type being built (engine)

   205

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

   206

 */

   207

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

   208

{

   209

	Vehicle *vl[3];

   210

	UnitID unit_num;

   211

   212

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

   213

   214

	const AircraftVehicleInfo *avi = AircraftVehInfo(p1);

   215

	int32 value = EstimateAircraftCost(avi);

   216

   217

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

   218

	if (flags & DC_QUERY_COST) return value;

   219

   220

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

   221

   222

	SET_EXPENSES_TYPE(EXPENSES_NEW_VEHICLES);

   223

   224

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

   225

	const Station* st = GetStationByTile(tile);

   226

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

   227

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

   228

		return CMD_ERROR;

   229

	}

   230

   231

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

   232

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

   233

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

   234

		return_cmd_error(STR_00E1_TOO_MANY_VEHICLES_IN_GAME);

   235

	}

   236

   237

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

   238

	if (unit_num > _patches.max_aircraft)

   239

		return_cmd_error(STR_00E1_TOO_MANY_VEHICLES_IN_GAME);

   240

   241

	if (flags & DC_EXEC) {

   242

		CargoID cargo;

   243

		uint x;

   244

		uint y;

   245

   246

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

   247

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

   248

   249

		v->unitnumber = unit_num;

   250

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

   251

		v->direction = DIR_SE;

   252

   253

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

   254

   255

		v->tile = tile;

   256

//		u->tile = 0;

   257

   258

		x = TileX(tile) * TILE_SIZE + 5;

   259

		y = TileY(tile) * TILE_SIZE + 3;

   260

   261

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

   262

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

   263

   264

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

   265

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

   266

   267

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

   268

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

   269

   270

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

   271

		v->z_height = 5;

   272

   273

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

   274

		u->z_height = 1;

   275

   276

		v->vehstatus = VS_HIDDEN | VS_STOPPED | VS_DEFPAL;

   277

		u->vehstatus = VS_HIDDEN | VS_UNCLICKABLE | VS_SHADOW;

   278

   279

		v->spritenum = avi->image_index;

   280

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

   281

   282

		v->cargo_cap = avi->passenger_capacity;

   283

		u->cargo_cap = avi->mail_capacity;

   284

   285

		v->cargo_type = CT_PASSENGERS;

   286

		u->cargo_type = CT_MAIL;

   287

   288

		v->cargo_subtype = 0;

   289

   290

		v->string_id = STR_SV_AIRCRAFT_NAME;

   291

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

   292

   293

//		v->load_unload_time_rem = 0;

   294

//		v->progress = 0;

   295

		v->last_station_visited = INVALID_STATION;

   296

//		v->destination_coords = 0;

   297

   298

		v->max_speed = avi->max_speed;

   299

		v->acceleration = avi->acceleration;

   300

		v->engine_type = p1;

   301

   302

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

   303

		v->value = value;

   304

   305

		u->subtype = AIR_SHADOW;

   306

   307

		/* Danger, Will Robinson!

   308

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

   309

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

   310

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

   311

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

   312

		cargo = FindFirstRefittableCargo(p1);

   313

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

   314

			uint16 callback = CALLBACK_FAILED;

   315

   316

			v->cargo_type = cargo;

   317

   318

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

   319

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

   320

			}

   321

   322

			if (callback == CALLBACK_FAILED) {

   323

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

   324

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

   325

			} else {

   326

				v->cargo_cap = callback;

   327

			}

   328

   329

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

   330

			u->cargo_cap = 0;

   331

		}

   332

   333

		const Engine *e = GetEngine(p1);

   334

		v->reliability = e->reliability;

   335

		v->reliability_spd_dec = e->reliability_spd_dec;

   336

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

   337

   338

		_new_vehicle_id = v->index;

   339

   340

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

   341

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

   342

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

   343

		 * of all depots, it is simple */

   344

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

   345

			assert(i != apc->nof_depots);

   346

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

   347

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

   348

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

   349

				break;

   350

			}

   351

		}

   352

   353

		v->u.air.state = HANGAR;

   354

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

   355

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

   356

		v->next = u;

   357

   358

		v->service_interval = _patches.servint_aircraft;

   359

   360

		v->date_of_last_service = _date;

   361

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

   362

   363

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

   364

   365

		v->random_bits = VehicleRandomBits();

   366

		u->random_bits = VehicleRandomBits();

   367

   368

		VehiclePositionChanged(v);

   369

		VehiclePositionChanged(u);

   370

   371

		// Aircraft with 3 vehicles (chopper)?

   372

		if (v->subtype == AIR_HELICOPTER) {

   373

			Vehicle *w = vl[2];

   374

   375

			u->next = w;

   376

   377

			w->type = VEH_Aircraft;

   378

			w->direction = DIR_N;

   379

			w->owner = _current_player;

   380

			w->x_pos = v->x_pos;

   381

			w->y_pos = v->y_pos;

   382

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

   383

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

   384

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

   385

			w->z_height = 1;

   386

			w->vehstatus = VS_HIDDEN | VS_UNCLICKABLE;

   387

			w->spritenum = 0xFF;

   388

			w->subtype = AIR_ROTOR;

   389

			w->cur_image = SPR_ROTOR_STOPPED;

   390

			w->random_bits = VehicleRandomBits();

   391

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

   392

			w->u.air.state = HRS_ROTOR_STOPPED;

   393

			VehiclePositionChanged(w);

   394

		}

   395

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

   396

   397

		InvalidateWindowData(WC_VEHICLE_DEPOT, v->tile);

   398

		RebuildVehicleLists();

   399

		InvalidateWindow(WC_COMPANY, v->owner);

   400

		if (IsLocalPlayer())

   401

			InvalidateWindow(WC_REPLACE_VEHICLE, VEH_Aircraft); //updates the replace Aircraft window

   402

	}

   403

   404

	return value;

   405

}

   406

   407

   408

static void DoDeleteAircraft(Vehicle *v)

   409

{

   410

	DeleteWindowById(WC_VEHICLE_VIEW, v->index);

   411

	RebuildVehicleLists();

   412

	InvalidateWindow(WC_COMPANY, v->owner);

   413

	DeleteDepotHighlightOfVehicle(v);

   414

	DeleteVehicleChain(v);

   415

	InvalidateWindowClasses(WC_AIRCRAFT_LIST);

   416

}

   417

   418

/** Sell an aircraft.

   419

 * @param tile unused

   420

 * @param p1 vehicle ID to be sold

   421

 * @param p2 unused

   422

 */

   423

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

   424

{

   425

	Vehicle *v;

   426

   427

	if (!IsValidVehicleID(p1)) return CMD_ERROR;

   428

   429

	v = GetVehicle(p1);

   430

   431

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

   432

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

   433

   434

	SET_EXPENSES_TYPE(EXPENSES_NEW_VEHICLES);

   435

   436

	if (flags & DC_EXEC) {

   437

		// Invalidate depot

   438

		InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   439

		DoDeleteAircraft(v);

   440

		if (IsLocalPlayer())

   441

			InvalidateWindow(WC_REPLACE_VEHICLE, VEH_Aircraft); // updates the replace Aircraft window

   442

	}

   443

   444

	return -(int32)v->value;

   445

}

   446

   447

/** Start/Stop an aircraft.

   448

 * @param tile unused

   449

 * @param p1 aircraft ID to start/stop

   450

 * @param p2 unused

   451

 */

   452

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

   453

{

   454

	Vehicle *v;

   455

	uint16 callback;

   456

   457

	if (!IsValidVehicleID(p1)) return CMD_ERROR;

   458

   459

	v = GetVehicle(p1);

   460

   461

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

   462

   463

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

   464

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

   465

		return_cmd_error(STR_A017_AIRCRAFT_IS_IN_FLIGHT);

   466

   467

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

   468

	 * return 0xFF if it can. */

   469

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

   470

	if (callback != CALLBACK_FAILED && callback != 0xFF) {

   471

		StringID error = GetGRFStringID(GetEngineGRFID(v->engine_type), 0xD000 + callback);

   472

		return_cmd_error(error);

   473

	}

   474

   475

	if (flags & DC_EXEC) {

   476

		if (IsAircraftInHangarStopped(v)) {

   477

			DeleteVehicleNews(p1, STR_A014_AIRCRAFT_IS_WAITING_IN);

   478

		}

   479

   480

		v->vehstatus ^= VS_STOPPED;

   481

		InvalidateWindowWidget(WC_VEHICLE_VIEW, v->index, STATUS_BAR);

   482

		InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   483

		InvalidateWindowClasses(WC_AIRCRAFT_LIST);

   484

	}

   485

   486

	return 0;

   487

}

   488

   489

/** Send an aircraft to the hangar.

   490

 * @param tile unused

   491

 * @param p1 vehicle ID to send to the hangar

   492

 * @param p2 various bitmasked elements

   493

 * - p2 bit 0-3 - DEPOT_ flags (see vehicle.h)