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 "airport.h"

    21

#include "vehicle_gui.h"

    22

#include "table/sprites.h"

    23

#include "newgrf_engine.h"

    24

#include "newgrf_callbacks.h"

    25

#include "newgrf_text.h"

    26

#include "newgrf_sound.h"

    27

#include "date.h"

    28

    34

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

    35

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

    36

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

    37

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

    38

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

    39

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

    40

static void CrashAirplane(Vehicle *v);

    41

    42

static void AircraftNextAirportPos_and_Order(Vehicle *v);

    43

static byte GetAircraftFlyingAltitude(const Vehicle *v);

    44

    45

static const SpriteID _aircraft_sprite[] = {

    46

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

    47

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

    48

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

    49

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

    50

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

    51

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

    52

	0x0EBD, 0x0EC5

    53

};

    54

    55

/* Helicopter rotor animation states */

    56

enum HelicopterRotorStates {

    57

	HRS_ROTOR_STOPPED,

    58

	HRS_ROTOR_MOVING_1,

    59

	HRS_ROTOR_MOVING_2,

    60

	HRS_ROTOR_MOVING_3,

    61

};

    62

    63

/* Find the nearest hangar to v

    64

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

    65

 * airports (like helipads only)

    66

 */

    67

static StationID FindNearestHangar(const Vehicle *v)

    68

{

    69

	const Station *st;

    70

	uint best = 0;

    71

	StationID index = INVALID_STATION;

    72

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

    73

    74

	FOR_ALL_STATIONS(st) {

    75

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

    76

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

    77

			uint distance;

    78

    79

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

    80

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

    81

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

    82

					!_cheats.no_jetcrash.value)

    83

				continue;

    84

    85

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

    86

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

    87

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

    88

				best = distance;

    89

				index = st->index;

    90

			}

    91

		}

    92

	}

    93

	return index;

    94

}

    95

    96

#if 0

    97

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

    98

static bool HaveHangarInOrderList(Vehicle *v)

    99

{

   100

	const Order *order;

   101

   102

	FOR_VEHICLE_ORDERS(v, order) {

   103

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

   104

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

   105

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

   106

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

   107

				return true;

   108

		}

   109

	}

   110

   111

	return false;

   112

}

   113

#endif

   114

   115

int GetAircraftImage(const Vehicle* v, Direction direction)

   116

{

   117

	int spritenum = v->spritenum;

   118

   119

	if (is_custom_sprite(spritenum)) {

   120

		int sprite = GetCustomVehicleSprite(v, direction);

   121

   122

		if (sprite != 0) return sprite;

   123

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

   124

	}

   125

	return direction + _aircraft_sprite[spritenum];

   126

}

   127

   128

SpriteID GetRotorImage(const Vehicle *v)

   129

{

   130

	const Vehicle *w;

   131

   132

	assert((v->subtype & 1) == 0);

   133

   134

	w = v->next->next;

   135

	if (is_custom_sprite(v->spritenum)) {

   136

		SpriteID spritenum = GetCustomRotorSprite(v, false);

   137

		if (spritenum != 0) return spritenum;

   138

	}

   139

   140

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

   141

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

   142

}

   143

   144

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

   145

{

   146

	const AircraftVehicleInfo* avi = AircraftVehInfo(engine);

   147

	int spritenum = avi->image_index;

   148

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

   149

   150

	if (is_custom_sprite(spritenum)) {

   151

		sprite = GetCustomVehicleIcon(engine, DIR_W);

   152

		if (sprite == 0) {

   153

			spritenum = orig_aircraft_vehicle_info[engine - AIRCRAFT_ENGINES_INDEX].image_index;

   154

			sprite = (6 + _aircraft_sprite[spritenum]);

   155

		}

   156

	}

   157

   158

	DrawSprite(sprite, pal, x, y);

   159

   160

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

   161

		SpriteID rotor_sprite = GetCustomRotorIcon(engine);

   162

		if (rotor_sprite == 0) rotor_sprite = SPR_ROTOR_STOPPED;

   163

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

   164

	}

   165

}

   166

   167

static int32 EstimateAircraftCost(EngineID engine_type)

   168

{

   169

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

   170

}

   171

   172

   173

/**

   174

 * Calculates cargo capacity based on an aircraft's passenger

   175

 * and mail capacities.

   176

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

   177

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

   178

 * @return New cargo capacity value.

   179

 */

   180

uint16 AircraftDefaultCargoCapacity(CargoID cid, EngineID engine_type)

   181

{

   182

	const AircraftVehicleInfo *avi = AircraftVehInfo(engine_type);

   183

   184

	assert(cid != CT_INVALID);

   185

   186

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

   187

	 * and four times as many passengers. */

   188

	switch (cid) {

   189

		case CT_PASSENGERS:

   190

			return avi->passenger_capacity;

   191

		case CT_MAIL:

   192

			return avi->passenger_capacity + avi->mail_capacity;

   193

		case CT_GOODS:

   194

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

   195

		default:

   196

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

   197

	}

   198

}

   199

   200

   201

/** Build an aircraft.

   202

 * @param tile tile of depot where aircraft is built

   203

 * @param p1 aircraft type being built (engine)

   204

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

   205

 */

   206

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

   207

{

   208

	int32 value;

   209

	Vehicle *vl[3], *v, *u, *w;

   210

	UnitID unit_num;

   211

	const AircraftVehicleInfo *avi;

   212

	const AirportFTAClass* ap;

   213

	Engine *e;

   214

   215

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

   216

   217

	value = EstimateAircraftCost(p1);

   218

   219

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

   220

	if (flags & DC_QUERY_COST) return value;

   221

   222

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

   223

   224

	SET_EXPENSES_TYPE(EXPENSES_NEW_VEHICLES);

   225

   226

	avi = AircraftVehInfo(p1);

   227

   228

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

   229

	ap = GetAirport(GetStationByTile(tile)->airport_type);

   230

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

   231

		return CMD_ERROR;

   232

	}

   233

   234

	// allocate 2 or 3 vehicle structs, depending on type

   235

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

   236

			IsOrderPoolFull()) {

   237

		return_cmd_error(STR_00E1_TOO_MANY_VEHICLES_IN_GAME);

   238

	}

   239

   240

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

   241

	if (unit_num > _patches.max_aircraft)

   242

		return_cmd_error(STR_00E1_TOO_MANY_VEHICLES_IN_GAME);

   243

   244

	if (flags & DC_EXEC) {

   245

		CargoID cargo;

   246

		uint x;

   247

		uint y;

   248

   249

		v = vl[0];

   250

		u = vl[1];

   251

   252

		v->unitnumber = unit_num;

   253

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

   254

		v->direction = DIR_SE;

   255

   256

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

   257

   258

		v->tile = tile;

   259

//		u->tile = 0;

   260

   261

		x = TileX(tile) * TILE_SIZE + 5;

   262

		y = TileY(tile) * TILE_SIZE + 3;

   263

   264

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

   265

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

   266

   267

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

   268

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

   269

   270

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

   271

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

   272

   273

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

   274

		v->z_height = 5;

   275

   276

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

   277

		u->z_height = 1;

   278

   279

		v->vehstatus = VS_HIDDEN | VS_STOPPED | VS_DEFPAL;

   280

		u->vehstatus = VS_HIDDEN | VS_UNCLICKABLE | VS_SHADOW;

   281

   282

		v->spritenum = avi->image_index;

   283

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

   284

   285

		v->cargo_cap = avi->passenger_capacity;

   286

		u->cargo_cap = avi->mail_capacity;

   287

   288

		v->cargo_type = CT_PASSENGERS;

   289

		u->cargo_type = CT_MAIL;

   290

   291

		v->cargo_subtype = 0;

   292

   293

		v->string_id = STR_SV_AIRCRAFT_NAME;

   294

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

   295

   296

//		v->load_unload_time_rem = 0;

   297

//		v->progress = 0;

   298

		v->last_station_visited = INVALID_STATION;

   299

//		v->destination_coords = 0;

   300

   301

		v->max_speed = avi->max_speed;

   302

		v->acceleration = avi->acceleration;

   303

		v->engine_type = p1;

   304

   305

		v->subtype = (avi->subtype & AIR_CTOL ? 2 : 0);

   306

		v->value = value;

   307

   308

		u->subtype = 4;

   309

   310

		/* Danger, Will Robinson!

   311

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

   312

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

   313

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

   314

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

   315

		cargo = FindFirstRefittableCargo(p1);

   316

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

   317

			uint16 callback = CALLBACK_FAILED;

   318

   319

			v->cargo_type = cargo;

   320

   321

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

   322

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

   323

			}

   324

   325

			if (callback == CALLBACK_FAILED) {

   326

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

   327

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

   328

			} else {

   329

				v->cargo_cap = callback;

   330

			}

   331

   332

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

   333

			u->cargo_cap = 0;

   334

		}

   335

   336

		e = GetEngine(p1);

   337

		v->reliability = e->reliability;

   338

		v->reliability_spd_dec = e->reliability_spd_dec;

   339

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

   340

   341

		_new_vehicle_id = v->index;

   342

   343

		v->u.air.pos = MAX_ELEMENTS;

   344

   345

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

   346

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

   347

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

   348

		 * of all depots, it is simple */

   349

		{

   350

			const Station* st = GetStationByTile(tile);

   351

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

   352

			uint i;

   353

   354

			for (i = 0; i < apc->nof_depots; i++) {

   355

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

   356

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

   357

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

   358

					break;

   359

				}

   360

			}

   361

			// to ensure v->u.air.pos has been given a value

   362

			assert(v->u.air.pos != MAX_ELEMENTS);

   363

		}

   364

   365

		v->u.air.state = HANGAR;

   366

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

   367

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

   368

		v->next = u;

   369

   370

		v->service_interval = _patches.servint_aircraft;

   371

   372

		v->date_of_last_service = _date;

   373

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

   374

   375

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

   376

   377

		v->random_bits = VehicleRandomBits();

   378

		u->random_bits = VehicleRandomBits();

   379

   380

		VehiclePositionChanged(v);

   381

		VehiclePositionChanged(u);

   382

   383

		// Aircraft with 3 vehicles (chopper)?

   384

		if (v->subtype == 0) {

   385

			w = vl[2];

   386

   387

			u->next = w;

   388

   389

			w->type = VEH_Aircraft;

   390

			w->direction = DIR_N;

   391

			w->owner = _current_player;

   392

			w->x_pos = v->x_pos;

   393

			w->y_pos = v->y_pos;

   394

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

   395

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

   396

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

   397

			w->z_height = 1;

   398

			w->vehstatus = VS_HIDDEN | VS_UNCLICKABLE;

   399

			w->spritenum = 0xFF;

   400

			w->subtype = 6;

   401

			w->cur_image = SPR_ROTOR_STOPPED;

   402

			w->random_bits = VehicleRandomBits();

   403

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

   404

			w->u.air.state = HRS_ROTOR_STOPPED;

   405

			VehiclePositionChanged(w);

   406

		}

   407

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

   408

   409

		InvalidateWindowData(WC_VEHICLE_DEPOT, v->tile);

   410

		RebuildVehicleLists();

   411

		InvalidateWindow(WC_COMPANY, v->owner);

   412

		if (IsLocalPlayer())

   413

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

   414

	}

   415

   416

	return value;

   417

}

   418

   419

   420

static void DoDeleteAircraft(Vehicle *v)

   421

{

   422

	DeleteWindowById(WC_VEHICLE_VIEW, v->index);

   423

	RebuildVehicleLists();

   424

	InvalidateWindow(WC_COMPANY, v->owner);

   425

	DeleteDepotHighlightOfVehicle(v);

   426

	DeleteVehicleChain(v);

   427

	InvalidateWindowClasses(WC_AIRCRAFT_LIST);

   428

}

   429

   430

/** Sell an aircraft.

   431

 * @param tile unused

   432

 * @param p1 vehicle ID to be sold

   433

 * @param p2 unused

   434

 */

   435

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

   436

{

   437

	Vehicle *v;

   438

   439

	if (!IsValidVehicleID(p1)) return CMD_ERROR;

   440

   441

	v = GetVehicle(p1);

   442

   443

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

   444

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

   445

   446

	SET_EXPENSES_TYPE(EXPENSES_NEW_VEHICLES);

   447

   448

	if (flags & DC_EXEC) {

   449

		// Invalidate depot

   450

		InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   451

		DoDeleteAircraft(v);

   452

		if (IsLocalPlayer())

   453

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

   454

	}

   455

   456

	return -(int32)v->value;

   457

}

   458

   459

/** Start/Stop an aircraft.

   460

 * @param tile unused

   461

 * @param p1 aircraft ID to start/stop

   462

 * @param p2 unused

   463

 */

   464

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

   465

{

   466

	Vehicle *v;

   467

	uint16 callback;

   468

   469

	if (!IsValidVehicleID(p1)) return CMD_ERROR;

   470

   471

	v = GetVehicle(p1);

   472

   473

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

   474

   475

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

   476

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

   477

		return_cmd_error(STR_A017_AIRCRAFT_IS_IN_FLIGHT);

   478

   479

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

   480

	 * return 0xFF if it can. */

   481

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

   482

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

   483

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

   484

		return_cmd_error(error);

   485

	}

   486

   487

	if (flags & DC_EXEC) {

   488

		if (IsAircraftInHangarStopped(v)) {

   489

			DeleteVehicleNews(p1, STR_A014_AIRCRAFT_IS_WAITING_IN);

   490

		}

   491

   492

		v->vehstatus ^= VS_STOPPED;

   493

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

   494

		InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);