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

    27

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

    28

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

    29

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

    30

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

    31

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

    32

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

    33

static void CrashAirplane(Vehicle *v);

    34

    35

static void AircraftNextAirportPos_and_Order(Vehicle *v);

    36

static byte GetAircraftFlyingAltitude(const Vehicle *v);

    37

    38

static const SpriteID _aircraft_sprite[] = {

    39

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

    40

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

    41

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

    42

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

    43

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

    44

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

    45

	0x0EBD, 0x0EC5

    46

};

    47

    48

/* Helicopter rotor animation states */

    49

enum HelicopterRotorStates {

    50

	HRS_ROTOR_STOPPED,

    51

	HRS_ROTOR_MOVING_1,

    52

	HRS_ROTOR_MOVING_2,

    53

	HRS_ROTOR_MOVING_3,

    54

};

    55

    56

/* Find the nearest hangar to v

    57

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

    58

 * airports (like helipads only)

    59

 */

    60

static StationID FindNearestHangar(const Vehicle *v)

    61

{

    62

	const Station *st;

    63

	uint best = 0;

    64

	StationID index = INVALID_STATION;

    65

    66

	FOR_ALL_STATIONS(st) {

    67

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

    68

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

    69

			uint distance;

    70

    71

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

    72

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

    73

					!_cheats.no_jetcrash.value)

    74

				continue;

    75

    76

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

    77

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

    78

				best = distance;

    79

				index = st->index;

    80

			}

    81

		}

    82

	}

    83

	return index;

    84

}

    85

    86

#if 0

    87

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

    88

static bool HaveHangarInOrderList(Vehicle *v)

    89

{

    90

	const Order *order;

    91

    92

	FOR_VEHICLE_ORDERS(v, order) {

    93

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

    94

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

    95

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

    96

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

    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, false);

   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

	const AircraftVehicleInfo* avi = AircraftVehInfo(engine);

   137

	int spritenum = avi->image_index;

   138

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

   139

   140

	if (is_custom_sprite(spritenum)) {

   141

		sprite = GetCustomVehicleIcon(engine, DIR_W);

   142

		if (!sprite)

   143

			spritenum = orig_aircraft_vehicle_info[engine - AIRCRAFT_ENGINES_INDEX].image_index;

   144

	}

   145

   146

	DrawSprite(sprite | image_ormod, x, y);

   147

   148

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

   149

		SpriteID rotor_sprite = GetCustomRotorIcon(engine);

   150

		if (rotor_sprite == 0) rotor_sprite = SPR_ROTOR_STOPPED;

   151

		DrawSprite(rotor_sprite, x, y - 5);

   152

	}

   153

}

   154

   155

static int32 EstimateAircraftCost(EngineID engine_type)

   156

{

   157

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

   158

}

   159

   160

   161

/**

   162

 * Calculates cargo capacity based on an aircraft's passenger

   163

 * and mail capacities.

   164

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

   165

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

   166

 * @return New cargo capacity value.

   167

 */

   168

uint16 AircraftDefaultCargoCapacity(CargoID cid, EngineID engine_type)

   169

{

   170

	const AircraftVehicleInfo *avi = AircraftVehInfo(engine_type);

   171

   172

	assert(cid != CT_INVALID);

   173

   174

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

   175

	 * and four times as many passengers. */

   176

	switch (cid) {

   177

		case CT_PASSENGERS:

   178

			return avi->passenger_capacity;

   179

		case CT_MAIL:

   180

			return avi->passenger_capacity + avi->mail_capacity;

   181

		case CT_GOODS:

   182

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

   183

		default:

   184

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

   185

	}

   186

}

   187

   188

   189

/** Build an aircraft.

   190

 * @param tile tile of depot where aircraft is built

   191

 * @param p1 aircraft type being built (engine)

   192

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

   193

 */

   194

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

   195

{

   196

	int32 value;

   197

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

   198

	UnitID unit_num;

   199

	const AircraftVehicleInfo *avi;

   200

	const AirportFTAClass* ap;

   201

	Engine *e;

   202

   203

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

   204

   205

	value = EstimateAircraftCost(p1);

   206

   207

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

   208

	if (flags & DC_QUERY_COST) return value;

   209

   210

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

   211

   212

	SET_EXPENSES_TYPE(EXPENSES_NEW_VEHICLES);

   213

   214

	avi = AircraftVehInfo(p1);

   215

   216

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

   217

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

   218

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

   219

		return CMD_ERROR;

   220

	}

   221

   222

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

   223

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

   224

			IsOrderPoolFull()) {

   225

		return_cmd_error(STR_00E1_TOO_MANY_VEHICLES_IN_GAME);

   226

	}

   227

   228

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

   229

	if (unit_num > _patches.max_aircraft)

   230

		return_cmd_error(STR_00E1_TOO_MANY_VEHICLES_IN_GAME);

   231

   232

	if (flags & DC_EXEC) {

   233

		CargoID cargo;

   234

		uint x;

   235

		uint y;

   236

   237

		v = vl[0];

   238

		u = vl[1];

   239

   240

		v->unitnumber = unit_num;

   241

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

   242

		v->direction = 3;

   243

   244

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

   245

   246

		v->tile = tile;

   247

//		u->tile = 0;

   248

   249

		x = TileX(tile) * TILE_SIZE + 5;

   250

		y = TileY(tile) * TILE_SIZE + 3;

   251

   252

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

   253

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

   254

   255

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

   256

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

   257

   258

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

   259

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

   260

   261

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

   262

		v->z_height = 5;

   263

   264

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

   265

		u->z_height = 1;

   266

   267

		v->vehstatus = VS_HIDDEN | VS_STOPPED | VS_DEFPAL;

   268

		u->vehstatus = VS_HIDDEN | VS_UNCLICKABLE | VS_SHADOW;

   269

   270

		v->spritenum = avi->image_index;

   271

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

   272

   273

		v->cargo_cap = avi->passenger_capacity;

   274

		u->cargo_cap = avi->mail_capacity;

   275

   276

		v->cargo_type = CT_PASSENGERS;

   277

		u->cargo_type = CT_MAIL;

   278

   279

		v->cargo_subtype = 0;

   280

   281

		v->string_id = STR_SV_AIRCRAFT_NAME;

   282

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

   283

   284

//		v->load_unload_time_rem = 0;

   285

//		v->progress = 0;

   286

		v->last_station_visited = INVALID_STATION;

   287

//		v->destination_coords = 0;

   288

   289

		v->max_speed = avi->max_speed;

   290

		v->acceleration = avi->acceleration;

   291

		v->engine_type = p1;

   292

   293

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

   294

		v->value = value;

   295

   296

		u->subtype = 4;

   297

   298

		/* Danger, Will Robinson!

   299

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

   300

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

   301

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

   302

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

   303

		cargo = FindFirstRefittableCargo(p1);

   304

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

   305

			uint16 callback = CALLBACK_FAILED;

   306

   307

			v->cargo_type = cargo;

   308

   309

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

   310

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

   311

			}

   312

   313

			if (callback == CALLBACK_FAILED) {

   314

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

   315

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

   316

			} else {

   317

				v->cargo_cap = callback;

   318

			}

   319

   320

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

   321

			u->cargo_cap = 0;

   322

		}

   323

   324

		e = GetEngine(p1);

   325

		v->reliability = e->reliability;

   326

		v->reliability_spd_dec = e->reliability_spd_dec;

   327

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

   328

   329

		_new_vehicle_id = v->index;

   330

   331

		v->u.air.pos = MAX_ELEMENTS;

   332

   333

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

   334

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

   335

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

   336

		 * of all depots, it is simple */

   337

		{

   338

			const Station* st = GetStationByTile(tile);

   339

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

   340

			uint i;

   341

   342

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

   343

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

   344

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

   345

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

   346

					break;

   347

				}

   348

			}

   349

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

   350

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

   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 == 0) {

   373

			w = vl[2];

   374

   375

			u->next = w;

   376

   377

			w->type = VEH_Aircraft;

   378

			w->direction = 0;

   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 = 6;

   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

   396

		InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   397

		RebuildVehicleLists();

   398

		InvalidateWindow(WC_COMPANY, v->owner);

   399

		if (IsLocalPlayer())

   400

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

   401

	}

   402

   403

	return value;

   404

}

   405

   406

   407

static void DoDeleteAircraft(Vehicle *v)

   408

{

   409

	DeleteWindowById(WC_VEHICLE_VIEW, v->index);

   410

	RebuildVehicleLists();

   411

	InvalidateWindow(WC_COMPANY, v->owner);

   412

	DeleteVehicleChain(v);

   413

	InvalidateWindowClasses(WC_AIRCRAFT_LIST);

   414

}

   415

   416

/** Sell an aircraft.

   417

 * @param tile unused

   418

 * @param p1 vehicle ID to be sold

   419

 * @param p2 unused

   420

 */

   421

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

   422

{

   423

	Vehicle *v;

   424

	uint16 callback;

   425

   426

	if (!IsVehicleIndex(p1)) return CMD_ERROR;

   427

   428

	v = GetVehicle(p1);

   429

   430

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

   431

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

   432

   433

	SET_EXPENSES_TYPE(EXPENSES_NEW_VEHICLES);

   434

   435

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

   436

	 * return 0xFF if it can. */

   437

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

   438

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

   439

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

   440

		return_cmd_error(error);

   441

	}

   442

   443

	if (flags & DC_EXEC) {

   444

		// Invalidate depot

   445

		InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   446

		DoDeleteAircraft(v);

   447

		if (IsLocalPlayer())

   448

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

   449

	}

   450

   451

	return -(int32)v->value;

   452

}

   453

   454

/** Start/Stop an aircraft.

   455

 * @param tile unused

   456

 * @param p1 aircraft ID to start/stop

   457

 * @param p2 unused

   458

 */

   459

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

   460

{

   461

	Vehicle *v;

   462

   463

	if (!IsVehicleIndex(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

	if (flags & DC_EXEC) {

   474

		if (IsAircraftInHangarStopped(v)) {

   475

			DeleteVehicleNews(p1, STR_A014_AIRCRAFT_IS_WAITING_IN);

   476

		}

   477

   478

		v->vehstatus ^= VS_STOPPED;

   479

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

   480

		InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   481

		InvalidateWindowClasses(WC_AIRCRAFT_LIST);

   482

	}

   483

   484

	return 0;

   485

}

   486

   487

/** Send an aircraft to the hangar.

   488

 * @param tile unused

   489

 * @param p1 vehicle ID to send to the hangar

   490

 * @param p2 various bitmasked elements

   491

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

   492

 * - p2 (bit 16) - aircraft will try to goto a depot, but not stop there (eg autorenew or autoreplace)

   493

 * - p2 (bit 17) - aircraft will try to goto a depot at the airport specified by low word of p2 XXX - Not Used

   494

 */

   495

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

   496

{