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

    29

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

    30

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

    31

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

    32

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

    33

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

    34

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

    35

static void CrashAirplane(Vehicle *v);

    36

    37

static void AircraftNextAirportPos_and_Order(Vehicle *v);

    38

static byte GetAircraftFlyingAltitude(const Vehicle *v);

    39

    40

static const SpriteID _aircraft_sprite[] = {

    41

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

    42

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

    43

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

    44

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

    45

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

    46

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

    47

	0x0EBD, 0x0EC5

    48

};

    49

    50

/* Helicopter rotor animation states */

    51

enum HelicopterRotorStates {

    52

	HRS_ROTOR_STOPPED,

    53

	HRS_ROTOR_MOVING_1,

    54

	HRS_ROTOR_MOVING_2,

    55

	HRS_ROTOR_MOVING_3,

    56

};

    57

    58

/* Find the nearest hangar to v

    59

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

    60

 * airports (like helipads only)

    61

 */

    62

static StationID FindNearestHangar(const Vehicle *v)

    63

{

    64

	const Station *st;

    65

	uint best = 0;

    66

	StationID index = INVALID_STATION;

    67

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

    68

    69

	FOR_ALL_STATIONS(st) {

    70

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

    71

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

    72

			uint distance;

    73

    74

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

    75

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

    76

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

    77

					!_cheats.no_jetcrash.value)

    78

				continue;

    79

    80

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

    81

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

    82

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

    83

				best = distance;

    84

				index = st->index;

    85

			}

    86

		}

    87

	}

    88

	return index;

    89

}

    90

    91

#if 0

    92

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

    93

static bool HaveHangarInOrderList(Vehicle *v)

    94

{

    95

	const Order *order;

    96

    97

	FOR_VEHICLE_ORDERS(v, order) {

    98

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

    99

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

   100

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

   101

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

   102

				return true;

   103

		}

   104

	}

   105

   106

	return false;

   107

}

   108

#endif

   109

   110

int GetAircraftImage(const Vehicle* v, Direction direction)

   111

{

   112

	int spritenum = v->spritenum;

   113

   114

	if (is_custom_sprite(spritenum)) {

   115

		int sprite = GetCustomVehicleSprite(v, direction);

   116

   117

		if (sprite != 0) return sprite;

   118

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

   119

	}

   120

	return direction + _aircraft_sprite[spritenum];

   121

}

   122

   123

SpriteID GetRotorImage(const Vehicle *v)

   124

{

   125

	const Vehicle *w;

   126

   127

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

   128

   129

	w = v->next->next;

   130

	if (is_custom_sprite(v->spritenum)) {

   131

		SpriteID spritenum = GetCustomRotorSprite(v, false);

   132

		if (spritenum != 0) return spritenum;

   133

	}

   134

   135

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

   136

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

   137

}

   138

   139

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

   140

{

   141

	const AircraftVehicleInfo* avi = AircraftVehInfo(engine);

   142

	int spritenum = avi->image_index;

   143

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

   144

   145

	if (is_custom_sprite(spritenum)) {

   146

		sprite = GetCustomVehicleIcon(engine, DIR_W);

   147

		if (sprite == 0) {

   148

			spritenum = orig_aircraft_vehicle_info[engine - AIRCRAFT_ENGINES_INDEX].image_index;

   149

			sprite = (6 + _aircraft_sprite[spritenum]);

   150

		}

   151

	}

   152

   153

	DrawSprite(sprite | image_ormod, x, y);

   154

   155

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

   156

		SpriteID rotor_sprite = GetCustomRotorIcon(engine);

   157

		if (rotor_sprite == 0) rotor_sprite = SPR_ROTOR_STOPPED;

   158

		DrawSprite(rotor_sprite, x, y - 5);

   159

	}

   160

}

   161

   162

static int32 EstimateAircraftCost(EngineID engine_type)

   163

{

   164

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

   165

}

   166

   167

   168

/**

   169

 * Calculates cargo capacity based on an aircraft's passenger

   170

 * and mail capacities.

   171

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

   172

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

   173

 * @return New cargo capacity value.

   174

 */

   175

uint16 AircraftDefaultCargoCapacity(CargoID cid, EngineID engine_type)

   176

{

   177

	const AircraftVehicleInfo *avi = AircraftVehInfo(engine_type);

   178

   179

	assert(cid != CT_INVALID);

   180

   181

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

   182

	 * and four times as many passengers. */

   183

	switch (cid) {

   184

		case CT_PASSENGERS:

   185

			return avi->passenger_capacity;

   186

		case CT_MAIL:

   187

			return avi->passenger_capacity + avi->mail_capacity;

   188

		case CT_GOODS:

   189

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

   190

		default:

   191

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

   192

	}

   193

}

   194

   195

   196

/** Build an aircraft.

   197

 * @param tile tile of depot where aircraft is built

   198

 * @param p1 aircraft type being built (engine)

   199

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

   200

 */

   201

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

   202

{

   203

	int32 value;

   204

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

   205

	UnitID unit_num;

   206

	const AircraftVehicleInfo *avi;

   207

	const AirportFTAClass* ap;

   208

	Engine *e;

   209

   210

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

   211

   212

	value = EstimateAircraftCost(p1);

   213

   214

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

   215

	if (flags & DC_QUERY_COST) return value;

   216

   217

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

   218

   219

	SET_EXPENSES_TYPE(EXPENSES_NEW_VEHICLES);

   220

   221

	avi = AircraftVehInfo(p1);

   222

   223

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

   224

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

   225

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

   226

		return CMD_ERROR;

   227

	}

   228

   229

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

   230

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

   231

			IsOrderPoolFull()) {

   232

		return_cmd_error(STR_00E1_TOO_MANY_VEHICLES_IN_GAME);

   233

	}

   234

   235

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

   236

	if (unit_num > _patches.max_aircraft)

   237

		return_cmd_error(STR_00E1_TOO_MANY_VEHICLES_IN_GAME);

   238

   239

	if (flags & DC_EXEC) {

   240

		CargoID cargo;

   241

		uint x;

   242

		uint y;

   243

   244

		v = vl[0];

   245

		u = vl[1];

   246

   247

		v->unitnumber = unit_num;

   248

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

   249

		v->direction = 3;

   250

   251

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

   252

   253

		v->tile = tile;

   254

//		u->tile = 0;

   255

   256

		x = TileX(tile) * TILE_SIZE + 5;

   257

		y = TileY(tile) * TILE_SIZE + 3;

   258

   259

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

   260

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

   261

   262

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

   263

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

   264

   265

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

   266

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

   267

   268

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

   269

		v->z_height = 5;

   270

   271

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

   272

		u->z_height = 1;

   273

   274

		v->vehstatus = VS_HIDDEN | VS_STOPPED | VS_DEFPAL;

   275

		u->vehstatus = VS_HIDDEN | VS_UNCLICKABLE | VS_SHADOW;

   276

   277

		v->spritenum = avi->image_index;

   278

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

   279

   280

		v->cargo_cap = avi->passenger_capacity;

   281

		u->cargo_cap = avi->mail_capacity;

   282

   283

		v->cargo_type = CT_PASSENGERS;

   284

		u->cargo_type = CT_MAIL;

   285

   286

		v->cargo_subtype = 0;

   287

   288

		v->string_id = STR_SV_AIRCRAFT_NAME;

   289

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

   290

   291

//		v->load_unload_time_rem = 0;

   292

//		v->progress = 0;

   293

		v->last_station_visited = INVALID_STATION;

   294

//		v->destination_coords = 0;

   295

   296

		v->max_speed = avi->max_speed;

   297

		v->acceleration = avi->acceleration;

   298

		v->engine_type = p1;

   299

   300

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

   301

		v->value = value;

   302

   303

		u->subtype = 4;

   304

   305

		/* Danger, Will Robinson!

   306

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

   307

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

   308

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

   309

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

   310

		cargo = FindFirstRefittableCargo(p1);

   311

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

   312

			uint16 callback = CALLBACK_FAILED;

   313

   314

			v->cargo_type = cargo;

   315

   316

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

   317

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

   318

			}

   319

   320

			if (callback == CALLBACK_FAILED) {

   321

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

   322

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

   323

			} else {

   324

				v->cargo_cap = callback;

   325

			}

   326

   327

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

   328

			u->cargo_cap = 0;

   329

		}

   330

   331

		e = GetEngine(p1);

   332

		v->reliability = e->reliability;

   333

		v->reliability_spd_dec = e->reliability_spd_dec;

   334

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

   335

   336

		_new_vehicle_id = v->index;

   337

   338

		v->u.air.pos = MAX_ELEMENTS;

   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

		{

   345

			const Station* st = GetStationByTile(tile);

   346

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

   347

			uint i;

   348

   349

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

   350

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

   351

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

   352

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

   353

					break;

   354

				}

   355

			}

   356

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

   357

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

   358

		}

   359

   360

		v->u.air.state = HANGAR;

   361

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

   362

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

   363

		v->next = u;

   364

   365

		v->service_interval = _patches.servint_aircraft;

   366

   367

		v->date_of_last_service = _date;

   368

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

   369

   370

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

   371

   372

		v->random_bits = VehicleRandomBits();

   373

		u->random_bits = VehicleRandomBits();

   374

   375

		VehiclePositionChanged(v);

   376

		VehiclePositionChanged(u);

   377

   378

		// Aircraft with 3 vehicles (chopper)?

   379

		if (v->subtype == 0) {

   380

			w = vl[2];

   381

   382

			u->next = w;

   383

   384

			w->type = VEH_Aircraft;

   385

			w->direction = 0;

   386

			w->owner = _current_player;

   387

			w->x_pos = v->x_pos;

   388

			w->y_pos = v->y_pos;

   389

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

   390

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

   391

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

   392

			w->z_height = 1;

   393

			w->vehstatus = VS_HIDDEN | VS_UNCLICKABLE;

   394

			w->spritenum = 0xFF;

   395

			w->subtype = 6;

   396

			w->cur_image = SPR_ROTOR_STOPPED;

   397

			w->random_bits = VehicleRandomBits();

   398

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

   399

			w->u.air.state = HRS_ROTOR_STOPPED;

   400

			VehiclePositionChanged(w);

   401

		}

   402

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

   403

   404

		InvalidateWindowData(WC_VEHICLE_DEPOT, v->tile);

   405

		RebuildVehicleLists();

   406

		InvalidateWindow(WC_COMPANY, v->owner);

   407

		if (IsLocalPlayer())

   408

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

   409

	}

   410

   411

	return value;

   412

}

   413

   414

   415

static void DoDeleteAircraft(Vehicle *v)

   416

{

   417

	DeleteWindowById(WC_VEHICLE_VIEW, v->index);

   418

	RebuildVehicleLists();

   419

	InvalidateWindow(WC_COMPANY, v->owner);

   420

	DeleteVehicleChain(v);

   421

	InvalidateWindowClasses(WC_AIRCRAFT_LIST);

   422

}

   423

   424

/** Sell an aircraft.

   425

 * @param tile unused

   426

 * @param p1 vehicle ID to be sold

   427

 * @param p2 unused

   428

 */

   429

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

   430

{

   431

	Vehicle *v;

   432

   433

	if (!IsValidVehicleID(p1)) return CMD_ERROR;

   434

   435

	v = GetVehicle(p1);

   436

   437

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

   438

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

   439

   440

	SET_EXPENSES_TYPE(EXPENSES_NEW_VEHICLES);

   441

   442

	if (flags & DC_EXEC) {

   443

		// Invalidate depot

   444

		InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   445

		DoDeleteAircraft(v);

   446

		if (IsLocalPlayer())

   447

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

   448

	}

   449

   450

	return -(int32)v->value;

   451

}

   452

   453

/** Start/Stop an aircraft.

   454

 * @param tile unused

   455

 * @param p1 aircraft ID to start/stop

   456

 * @param p2 unused

   457

 */

   458

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

   459

{

   460

	Vehicle *v;

   461

	uint16 callback;

   462

   463

	if (!IsValidVehicleID(p1)) return CMD_ERROR;

   464

   465

	v = GetVehicle(p1);

   466

   467

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

   468

   469

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

   470

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

   471

		return_cmd_error(STR_A017_AIRCRAFT_IS_IN_FLIGHT);

   472

   473

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

   474

	 * return 0xFF if it can. */

   475

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

   476

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

   477

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

   478

		return_cmd_error(error);

   479

	}

   480

   481

	if (flags & DC_EXEC) {

   482

		if (IsAircraftInHangarStopped(v)) {

   483

			DeleteVehicleNews(p1, STR_A014_AIRCRAFT_IS_WAITING_IN);

   484

		}

   485

   486

		v->vehstatus ^= VS_STOPPED;

   487

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

   488

		InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   489

		InvalidateWindowClasses(WC_AIRCRAFT_LIST);

   490

	}

   491

   492

	return 0;

   493

}

   494

   495

/** Send an aircraft to the hangar.