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

    26

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

    27

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

    28

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

    29

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

    30

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

    31

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

    32

static void CrashAirplane(Vehicle *v);

    33

    34

static void AircraftNextAirportPos_and_Order(Vehicle *v);

    35

static byte GetAircraftFlyingAltitude(const Vehicle *v);

    36

    37

static const SpriteID _aircraft_sprite[] = {

    38

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

    39

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

    40

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

    41

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

    42

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

    43

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

    44

	0x0EBD, 0x0EC5

    45

};

    46

    47

/* Helicopter rotor animation states */

    48

enum HelicopterRotorStates {

    49

	HRS_ROTOR_STOPPED,

    50

	HRS_ROTOR_MOVING_1,

    51

	HRS_ROTOR_MOVING_2,

    52

	HRS_ROTOR_MOVING_3,

    53

};

    54

    55

/* Find the nearest hangar to v

    56

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

    57

 * airports (like helipads only)

    58

 */

    59

static StationID FindNearestHangar(const Vehicle *v)

    60

{

    61

	const Station *st;

    62

	uint best = 0;

    63

	StationID index = INVALID_STATION;

    64

    65

	FOR_ALL_STATIONS(st) {

    66

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

    67

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

    68

			uint distance;

    69

    70

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

    71

			if (HASBIT(v->subtype, 1) && st->airport_type == AT_SMALL &&

    72

					!_cheats.no_jetcrash.value)

    73

				continue;

    74

    75

			distance = DistanceSquare(v->tile, st->airport_tile);

    76

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

    77

				best = distance;

    78

				index = st->index;

    79

			}

    80

		}

    81

	}

    82

	return index;

    83

}

    84

    85

#if 0

    86

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

    87

static bool HaveHangarInOrderList(Vehicle *v)

    88

{

    89

	const Order *order;

    90

    91

	FOR_VEHICLE_ORDERS(v, order) {

    92

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

    93

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

    94

			// If an airport doesn't have terminals (so no landing space for airports),

    95

			// it surely doesn't have any hangars

    96

			if (GetAirport(st->airport_type)->terminals != NULL)

    97

				return true;

    98

		}

    99

	}

   100

   101

	return false;

   102

}

   103

#endif

   104

   105

int GetAircraftImage(const Vehicle* v, Direction direction)

   106

{

   107

	int spritenum = v->spritenum;

   108

   109

	if (is_custom_sprite(spritenum)) {

   110

		int sprite = GetCustomVehicleSprite(v, direction);

   111

   112

		if (sprite != 0) return sprite;

   113

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

   114

	}

   115

	return direction + _aircraft_sprite[spritenum];

   116

}

   117

   118

SpriteID GetRotorImage(const Vehicle *v)

   119

{

   120

	const Vehicle *w;

   121

   122

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

   123

   124

	w = v->next->next;

   125

	if (is_custom_sprite(v->spritenum)) {

   126

		SpriteID spritenum = GetCustomRotorSprite(v);

   127

		if (spritenum != 0) return spritenum;

   128

	}

   129

   130

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

   131

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

   132

}

   133

   134

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

   135

{

   136

	int spritenum = AircraftVehInfo(engine)->image_index;

   137

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

   138

   139

	if (is_custom_sprite(spritenum)) {

   140

		sprite = GetCustomVehicleIcon(engine, DIR_W);

   141

		if (!sprite)

   142

			spritenum = orig_aircraft_vehicle_info[engine - AIRCRAFT_ENGINES_INDEX].image_index;

   143

	}

   144

   145

	DrawSprite(sprite | image_ormod, x, y);

   146

   147

	if ((AircraftVehInfo(engine)->subtype & 1) == 0) {

   148

		SpriteID rotor_sprite = GetCustomRotorIcon(engine);

   149

		if (rotor_sprite == 0) rotor_sprite = SPR_ROTOR_STOPPED;

   150

		DrawSprite(rotor_sprite, x, y - 5);

   151

	}

   152

}

   153

   154

static int32 EstimateAircraftCost(EngineID engine_type)

   155

{

   156

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

   157

}

   158

   159

   160

/**

   161

 * Calculates cargo capacity based on an aircraft's passenger

   162

 * and mail capacities.

   163

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

   164

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

   165

 * @return New cargo capacity value.

   166

 */

   167

uint16 AircraftDefaultCargoCapacity(CargoID cid, EngineID engine_type)

   168

{

   169

	const AircraftVehicleInfo *avi = AircraftVehInfo(engine_type);

   170

   171

	assert(cid != CT_INVALID);

   172

   173

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

   174

	 * and four times as many passengers. */

   175

	switch (cid) {

   176

		case CT_PASSENGERS:

   177

			return avi->passenger_capacity;

   178

		case CT_MAIL:

   179

			return avi->passenger_capacity + avi->mail_capacity;

   180

		case CT_GOODS:

   181

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

   182

		default:

   183

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

   184

	}

   185

}

   186

   187

   188

/** Build an aircraft.

   189

 * @param tile tile of depot where aircraft is built

   190

 * @param p1 aircraft type being built (engine)

   191

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

   192

 */

   193

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

   194

{

   195

	int32 value;

   196

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

   197

	UnitID unit_num;

   198

	const AircraftVehicleInfo *avi;

   199

	Engine *e;

   200

   201

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

   202

   203

	value = EstimateAircraftCost(p1);

   204

   205

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

   206

	if (flags & DC_QUERY_COST) return value;

   207

   208

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

   209

   210

	SET_EXPENSES_TYPE(EXPENSES_NEW_VEHICLES);

   211

   212

	avi = AircraftVehInfo(p1);

   213

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

   214

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

   215

			IsOrderPoolFull()) {

   216

		return_cmd_error(STR_00E1_TOO_MANY_VEHICLES_IN_GAME);

   217

	}

   218

   219

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

   220

	if (unit_num > _patches.max_aircraft)

   221

		return_cmd_error(STR_00E1_TOO_MANY_VEHICLES_IN_GAME);

   222

   223

	if (flags & DC_EXEC) {

   224

		CargoID cargo;

   225

		uint x;

   226

		uint y;

   227

   228

		v = vl[0];

   229

		u = vl[1];

   230

   231

		v->unitnumber = unit_num;

   232

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

   233

		v->direction = 3;

   234

   235

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

   236

   237

		v->tile = tile;

   238

//		u->tile = 0;

   239

   240

		x = TileX(tile) * TILE_SIZE + 5;

   241

		y = TileY(tile) * TILE_SIZE + 3;

   242

   243

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

   244

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

   245

   246

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

   247

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

   248

   249

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

   250

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

   251

   252

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

   253

		v->z_height = 5;

   254

   255

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

   256

		u->z_height = 1;

   257

   258

		v->vehstatus = VS_HIDDEN | VS_STOPPED | VS_DEFPAL;

   259

		u->vehstatus = VS_HIDDEN | VS_UNCLICKABLE | VS_DISASTER;

   260

   261

		v->spritenum = avi->image_index;

   262

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

   263

   264

		v->cargo_cap = avi->passenger_capacity;

   265

		u->cargo_cap = avi->mail_capacity;

   266

   267

		v->cargo_type = CT_PASSENGERS;

   268

		u->cargo_type = CT_MAIL;

   269

   270

		v->cargo_subtype = 0;

   271

   272

		v->string_id = STR_SV_AIRCRAFT_NAME;

   273

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

   274

   275

//		v->load_unload_time_rem = 0;

   276

//		v->progress = 0;

   277

		v->last_station_visited = INVALID_STATION;

   278

//		v->destination_coords = 0;

   279

   280

		v->max_speed = avi->max_speed;

   281

		v->acceleration = avi->acceleration;

   282

		v->engine_type = p1;

   283

   284

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

   285

		v->value = value;

   286

   287

		u->subtype = 4;

   288

   289

		/* Danger, Will Robinson!

   290

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

   291

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

   292

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

   293

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

   294

		cargo = FindFirstRefittableCargo(p1);

   295

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

   296

			uint16 callback = CALLBACK_FAILED;

   297

   298

			v->cargo_type = cargo;

   299

   300

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

   301

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

   302

			}

   303

   304

			if (callback == CALLBACK_FAILED) {

   305

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

   306

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

   307

			} else {

   308

				v->cargo_cap = callback;

   309

			}

   310

   311

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

   312

			u->cargo_cap = 0;

   313

		}

   314

   315

		e = GetEngine(p1);

   316

		v->reliability = e->reliability;

   317

		v->reliability_spd_dec = e->reliability_spd_dec;

   318

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

   319

   320

		_new_vehicle_id = v->index;

   321

   322

		v->u.air.pos = MAX_ELEMENTS;

   323

   324

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

   325

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

   326

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

   327

		 * of all depots, it is simple */

   328

		{

   329

			const Station* st = GetStationByTile(tile);

   330

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

   331

			uint i;

   332

   333

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

   334

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

   335

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

   336

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

   337

					break;

   338

				}

   339

			}

   340

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

   341

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

   342

		}

   343

   344

		v->u.air.state = HANGAR;

   345

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

   346

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

   347

		v->next = u;

   348

   349

		v->service_interval = _patches.servint_aircraft;

   350

   351

		v->date_of_last_service = _date;

   352

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

   353

   354

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

   355

   356

		v->random_bits = VehicleRandomBits();

   357

		u->random_bits = VehicleRandomBits();

   358

   359

		VehiclePositionChanged(v);

   360

		VehiclePositionChanged(u);

   361

   362

		// Aircraft with 3 vehicles (chopper)?

   363

		if (v->subtype == 0) {

   364

			w = vl[2];

   365

   366

			u->next = w;

   367

   368

			w->type = VEH_Aircraft;

   369

			w->direction = 0;

   370

			w->owner = _current_player;

   371

			w->x_pos = v->x_pos;

   372

			w->y_pos = v->y_pos;

   373

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

   374

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

   375

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

   376

			w->z_height = 1;

   377

			w->vehstatus = VS_HIDDEN | VS_UNCLICKABLE;

   378

			w->spritenum = 0xFF;

   379

			w->subtype = 6;

   380

			w->cur_image = SPR_ROTOR_STOPPED;

   381

			w->random_bits = VehicleRandomBits();

   382

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

   383

			w->u.air.state = HRS_ROTOR_STOPPED;

   384

			VehiclePositionChanged(w);

   385

		}

   386

   387

		InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   388

		RebuildVehicleLists();

   389

		InvalidateWindow(WC_COMPANY, v->owner);

   390

		if (IsLocalPlayer())

   391

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

   392

	}

   393

   394

	return value;

   395

}

   396

   397

   398

static void DoDeleteAircraft(Vehicle *v)

   399

{

   400

	DeleteWindowById(WC_VEHICLE_VIEW, v->index);

   401

	RebuildVehicleLists();

   402

	InvalidateWindow(WC_COMPANY, v->owner);

   403

	DeleteVehicleChain(v);

   404

	InvalidateWindowClasses(WC_AIRCRAFT_LIST);

   405

}

   406

   407

/** Sell an aircraft.

   408

 * @param tile unused

   409

 * @param p1 vehicle ID to be sold

   410

 * @param p2 unused

   411

 */

   412

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

   413

{

   414

	Vehicle *v;

   415

   416

	if (!IsVehicleIndex(p1)) return CMD_ERROR;

   417

   418

	v = GetVehicle(p1);

   419

   420

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

   421

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

   422

   423

	SET_EXPENSES_TYPE(EXPENSES_NEW_VEHICLES);

   424

   425

	if (flags & DC_EXEC) {

   426

		// Invalidate depot

   427

		InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   428

		DoDeleteAircraft(v);

   429

		if (IsLocalPlayer())

   430

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

   431

	}

   432

   433

	return -(int32)v->value;

   434

}

   435

   436

/** Start/Stop an aircraft.

   437

 * @param tile unused

   438

 * @param p1 aircraft ID to start/stop

   439

 * @param p2 unused

   440

 */

   441

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

   442

{

   443

	Vehicle *v;

   444

   445

	if (!IsVehicleIndex(p1)) return CMD_ERROR;

   446

   447

	v = GetVehicle(p1);

   448

   449

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

   450

   451

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

   452

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

   453

		return_cmd_error(STR_A017_AIRCRAFT_IS_IN_FLIGHT);

   454

   455

	if (flags & DC_EXEC) {

   456

		if (IsAircraftInHangarStopped(v)) {

   457

			DeleteVehicleNews(p1, STR_A014_AIRCRAFT_IS_WAITING_IN);

   458

		}

   459

   460

		v->vehstatus ^= VS_STOPPED;

   461

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

   462

		InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   463

		InvalidateWindowClasses(WC_AIRCRAFT_LIST);

   464

	}

   465

   466

	return 0;

   467

}

   468

   469

/** Send an aircraft to the hangar.

   470

 * @param tile unused

   471

 * @param p1 vehicle ID to send to the hangar

   472

 * @param p2 various bitmasked elements

   473

 * - p2 = 0      - aircraft goes to the depot and stays there (user command)

   474

 * - p2 non-zero - aircraft will try to goto a depot, but not stop there (eg forced servicing)

   475

 * - p2 (bit 17) - aircraft will try to goto a depot at the next airport

   476

 */

   477

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

   478

{

   479

	Vehicle *v;

   480

   481

	if (!IsVehicleIndex(p1)) return CMD_ERROR;

   482

   483

	v = GetVehicle(p1);

   484

   485

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

   486

   487

	if (v->current_order.type == OT_GOTO_DEPOT && p2 == 0) {

   488

		if (flags & DC_EXEC) {

   489

			if (v->current_order.flags & OF_UNLOAD) v->cur_order_index++;

   490

			v->current_order.type = OT_DUMMY;

   491

			v->current_order.flags = 0;

   492

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

   493

		}

   494

	} else {

   495

		bool next_airport_has_hangar = true;

   496

		/* XXX - I don't think p2 is any valid station cause all calls use either 0, 1, or 1<<16!!!!!!!!! */

   497

		StationID next_airport_index = (HASBIT(p2, 17)) ? (StationID)p2 : v->u.air.targetairport;