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 a hangar, skip it

    95

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

    96

				return true;

    97

		}

    98

	}

    99

   100

	return false;

   101

}

   102

#endif

   103

   104

int GetAircraftImage(const Vehicle* v, Direction direction)

   105

{

   106

	int spritenum = v->spritenum;

   107

   108

	if (is_custom_sprite(spritenum)) {

   109

		int sprite = GetCustomVehicleSprite(v, direction);

   110

   111

		if (sprite != 0) return sprite;

   112

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

   113

	}

   114

	return direction + _aircraft_sprite[spritenum];

   115

}

   116

   117

SpriteID GetRotorImage(const Vehicle *v)

   118

{

   119

	const Vehicle *w;

   120

   121

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

   122

   123

	w = v->next->next;

   124

	if (is_custom_sprite(v->spritenum)) {

   125

		SpriteID spritenum = GetCustomRotorSprite(v, false);

   126

		if (spritenum != 0) return spritenum;

   127

	}

   128

   129

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

   130

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

   131

}

   132

   133

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

   134

{

   135

	const AircraftVehicleInfo* avi = AircraftVehInfo(engine);

   136

	int spritenum = avi->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 (!(avi->subtype & AIR_CTOL)) {

   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

	const AirportFTAClass* ap;

   200

	Engine *e;

   201

   202

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

   203

   204

	value = EstimateAircraftCost(p1);

   205

   206

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

   207

	if (flags & DC_QUERY_COST) return value;

   208

   209

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

   210

   211

	SET_EXPENSES_TYPE(EXPENSES_NEW_VEHICLES);

   212

   213

	avi = AircraftVehInfo(p1);

   214

   215

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

   216

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

   217

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

   218

		return CMD_ERROR;

   219

	}

   220

   221

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

   222

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

   223

			IsOrderPoolFull()) {

   224

		return_cmd_error(STR_00E1_TOO_MANY_VEHICLES_IN_GAME);

   225

	}

   226

   227

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

   228

	if (unit_num > _patches.max_aircraft)

   229

		return_cmd_error(STR_00E1_TOO_MANY_VEHICLES_IN_GAME);

   230

   231

	if (flags & DC_EXEC) {

   232

		CargoID cargo;

   233

		uint x;

   234

		uint y;

   235

   236

		v = vl[0];

   237

		u = vl[1];

   238

   239

		v->unitnumber = unit_num;

   240

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

   241

		v->direction = 3;

   242

   243

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

   244

   245

		v->tile = tile;

   246

//		u->tile = 0;

   247

   248

		x = TileX(tile) * TILE_SIZE + 5;

   249

		y = TileY(tile) * TILE_SIZE + 3;

   250

   251

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

   252

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

   253

   254

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

   255

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

   256

   257

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

   258

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

   259

   260

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

   261

		v->z_height = 5;

   262

   263

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

   264

		u->z_height = 1;

   265

   266

		v->vehstatus = VS_HIDDEN | VS_STOPPED | VS_DEFPAL;

   268

   269

		v->spritenum = avi->image_index;

   270

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

   271

   272

		v->cargo_cap = avi->passenger_capacity;

   273

		u->cargo_cap = avi->mail_capacity;

   274

   275

		v->cargo_type = CT_PASSENGERS;

   276

		u->cargo_type = CT_MAIL;

   277

   278

		v->cargo_subtype = 0;

   279

   280

		v->string_id = STR_SV_AIRCRAFT_NAME;

   281

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

   282

   283

//		v->load_unload_time_rem = 0;

   284

//		v->progress = 0;

   285

		v->last_station_visited = INVALID_STATION;

   286

//		v->destination_coords = 0;

   287

   288

		v->max_speed = avi->max_speed;

   289

		v->acceleration = avi->acceleration;

   290

		v->engine_type = p1;

   291

   292

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

   293

		v->value = value;

   294

   295

		u->subtype = 4;

   296

   297

		/* Danger, Will Robinson!

   298

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

   299

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

   300

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

   301

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

   302

		cargo = FindFirstRefittableCargo(p1);

   303

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

   304

			uint16 callback = CALLBACK_FAILED;

   305

   306

			v->cargo_type = cargo;

   307

   308

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

   309

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

   310

			}

   311

   312

			if (callback == CALLBACK_FAILED) {

   313

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

   314

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

   315

			} else {

   316

				v->cargo_cap = callback;

   317

			}

   318

   319

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

   320

			u->cargo_cap = 0;

   321

		}

   322

   323

		e = GetEngine(p1);

   324

		v->reliability = e->reliability;

   325

		v->reliability_spd_dec = e->reliability_spd_dec;

   326

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

   327

   328

		_new_vehicle_id = v->index;

   329

   330

		v->u.air.pos = MAX_ELEMENTS;

   331

   332

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

   333

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

   334

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

   335

		 * of all depots, it is simple */

   336

		{

   337

			const Station* st = GetStationByTile(tile);

   338

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

   339

			uint i;

   340

   341

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

   342

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

   343

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

   344

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

   345

					break;

   346

				}

   347

			}

   348

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

   349

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

   350

		}

   351

   352

		v->u.air.state = HANGAR;

   353

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

   354

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

   355

		v->next = u;

   356

   357

		v->service_interval = _patches.servint_aircraft;

   358

   359

		v->date_of_last_service = _date;

   360

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

   361

   362

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

   363

   364

		v->random_bits = VehicleRandomBits();

   365

		u->random_bits = VehicleRandomBits();

   366

   367

		VehiclePositionChanged(v);

   368

		VehiclePositionChanged(u);

   369

   370

		// Aircraft with 3 vehicles (chopper)?

   371

		if (v->subtype == 0) {

   372

			w = vl[2];

   373

   374

			u->next = w;

   375

   376

			w->type = VEH_Aircraft;

   377

			w->direction = 0;

   378

			w->owner = _current_player;

   379

			w->x_pos = v->x_pos;

   380

			w->y_pos = v->y_pos;

   381

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

   382

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

   383

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

   384

			w->z_height = 1;

   385

			w->vehstatus = VS_HIDDEN | VS_UNCLICKABLE;

   386

			w->spritenum = 0xFF;

   387

			w->subtype = 6;

   388

			w->cur_image = SPR_ROTOR_STOPPED;

   389

			w->random_bits = VehicleRandomBits();

   390

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

   391

			w->u.air.state = HRS_ROTOR_STOPPED;

   392

			VehiclePositionChanged(w);

   393

		}

   394

   395

		InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   396

		RebuildVehicleLists();

   397

		InvalidateWindow(WC_COMPANY, v->owner);

   398

		if (IsLocalPlayer())

   399

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

   400

	}

   401

   402

	return value;

   403

}

   404

   405

   406

static void DoDeleteAircraft(Vehicle *v)

   407

{

   408

	DeleteWindowById(WC_VEHICLE_VIEW, v->index);

   409

	RebuildVehicleLists();

   410

	InvalidateWindow(WC_COMPANY, v->owner);

   411

	DeleteVehicleChain(v);

   412

	InvalidateWindowClasses(WC_AIRCRAFT_LIST);

   413

}

   414

   415

/** Sell an aircraft.

   416

 * @param tile unused

   417

 * @param p1 vehicle ID to be sold

   418

 * @param p2 unused

   419

 */

   420

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

   421

{

   422

	Vehicle *v;

   423

   424

	if (!IsVehicleIndex(p1)) return CMD_ERROR;

   425

   426

	v = GetVehicle(p1);

   427

   428

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

   429

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

   430

   431

	SET_EXPENSES_TYPE(EXPENSES_NEW_VEHICLES);

   432

   433

	if (flags & DC_EXEC) {

   434

		// Invalidate depot

   435

		InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   436

		DoDeleteAircraft(v);

   437

		if (IsLocalPlayer())

   438

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

   439

	}

   440

   441

	return -(int32)v->value;

   442

}

   443

   444

/** Start/Stop an aircraft.

   445

 * @param tile unused

   446

 * @param p1 aircraft ID to start/stop

   447

 * @param p2 unused

   448

 */

   449

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

   450

{

   451

	Vehicle *v;

   452

   453

	if (!IsVehicleIndex(p1)) return CMD_ERROR;

   454

   455

	v = GetVehicle(p1);

   456

   457

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

   458

   459

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

   460

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

   461

		return_cmd_error(STR_A017_AIRCRAFT_IS_IN_FLIGHT);

   462

   463

	if (flags & DC_EXEC) {

   464

		if (IsAircraftInHangarStopped(v)) {

   465

			DeleteVehicleNews(p1, STR_A014_AIRCRAFT_IS_WAITING_IN);

   466

		}

   467

   468

		v->vehstatus ^= VS_STOPPED;

   469

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

   470

		InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   471

		InvalidateWindowClasses(WC_AIRCRAFT_LIST);

   472

	}

   473

   474

	return 0;

   475

}

   476

   477

/** Send an aircraft to the hangar.

   478

 * @param tile unused

   479

 * @param p1 vehicle ID to send to the hangar

   480

 * @param p2 various bitmasked elements

   481

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

   482

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

   483

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

   484

 */

   485

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

   486

{

   487

	Vehicle *v;

   488

   489

	if (!IsVehicleIndex(p1)) return CMD_ERROR;

   490

   491

	v = GetVehicle(p1);

   492

   493

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

   494

   495

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

   496

		if (flags & DC_EXEC) {