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

    27

    28

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

    29

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

    30

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

    31

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

    32

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

    33

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

    34

static void CrashAirplane(Vehicle *v);

    35

    36

static void AircraftNextAirportPos_and_Order(Vehicle *v);

    37

static byte GetAircraftFlyingAltitude(const Vehicle *v);

    38

    39

static const SpriteID _aircraft_sprite[] = {

    40

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

    41

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

    42

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

    43

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

    44

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

    45

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

    46

	0x0EBD, 0x0EC5

    47

};

    48

    49

/* Helicopter rotor animation states */

    50

enum HelicopterRotorStates {

    51

	HRS_ROTOR_STOPPED,

    52

	HRS_ROTOR_MOVING_1,

    53

	HRS_ROTOR_MOVING_2,

    54

	HRS_ROTOR_MOVING_3,

    55

};

    56

    57

/* Find the nearest hangar to v

    58

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

    59

 * airports (like helipads only)

    60

 */

    61

static StationID FindNearestHangar(const Vehicle *v)

    62

{

    63

	const Station *st;

    64

	uint best = 0;

    65

	StationID index = INVALID_STATION;

    66

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

    67

    68

	FOR_ALL_STATIONS(st) {

    69

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

    70

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

    71

			uint distance;

    72

    73

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

    74

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

    75

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

    76

					!_cheats.no_jetcrash.value)

    77

				continue;

    78

    79

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

    80

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

    81

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

    82

				best = distance;

    83

				index = st->index;

    84

			}

    85

		}

    86

	}

    87

	return index;

    88

}

    89

    90

#if 0

    91

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

    92

static bool HaveHangarInOrderList(Vehicle *v)

    93

{

    94

	const Order *order;

    95

    96

	FOR_VEHICLE_ORDERS(v, order) {

    97

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

    98

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

    99

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

   100

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

   101

				return true;

   102

		}

   103

	}

   104

   105

	return false;

   106

}

   107

#endif

   108

   109

int GetAircraftImage(const Vehicle* v, Direction direction)

   110

{

   111

	int spritenum = v->spritenum;

   112

   113

	if (is_custom_sprite(spritenum)) {

   114

		int sprite = GetCustomVehicleSprite(v, direction);

   115

   116

		if (sprite != 0) return sprite;

   117

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

   118

	}

   119

	return direction + _aircraft_sprite[spritenum];

   120

}

   121

   122

SpriteID GetRotorImage(const Vehicle *v)

   123

{

   124

	const Vehicle *w;

   125

   126

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

   127

   128

	w = v->next->next;

   129

	if (is_custom_sprite(v->spritenum)) {

   130

		SpriteID spritenum = GetCustomRotorSprite(v, false);

   131

		if (spritenum != 0) return spritenum;

   132

	}

   133

   134

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

   135

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

   136

}

   137

   138

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

   139

{

   140

	const AircraftVehicleInfo* avi = AircraftVehInfo(engine);

   141

	int spritenum = avi->image_index;

   142

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

   143

   144

	if (is_custom_sprite(spritenum)) {

   145

		sprite = GetCustomVehicleIcon(engine, DIR_W);

   146

		if (!sprite)

   147

			spritenum = orig_aircraft_vehicle_info[engine - AIRCRAFT_ENGINES_INDEX].image_index;

   148

	}

   149

   150

	DrawSprite(sprite | image_ormod, x, y);

   151

   152

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

   153

		SpriteID rotor_sprite = GetCustomRotorIcon(engine);

   154

		if (rotor_sprite == 0) rotor_sprite = SPR_ROTOR_STOPPED;

   155

		DrawSprite(rotor_sprite, x, y - 5);

   156

	}

   157

}

   158

   159

static int32 EstimateAircraftCost(EngineID engine_type)

   160

{

   161

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

   162

}

   163

   164

   165

/**

   166

 * Calculates cargo capacity based on an aircraft's passenger

   167

 * and mail capacities.

   168

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

   169

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

   170

 * @return New cargo capacity value.

   171

 */

   172

uint16 AircraftDefaultCargoCapacity(CargoID cid, EngineID engine_type)

   173

{

   174

	const AircraftVehicleInfo *avi = AircraftVehInfo(engine_type);

   175

   176

	assert(cid != CT_INVALID);

   177

   178

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

   179

	 * and four times as many passengers. */

   180

	switch (cid) {

   181

		case CT_PASSENGERS:

   182

			return avi->passenger_capacity;

   183

		case CT_MAIL:

   184

			return avi->passenger_capacity + avi->mail_capacity;

   185

		case CT_GOODS:

   186

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

   187

		default:

   188

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

   189

	}

   190

}

   191

   192

   193

/** Build an aircraft.

   194

 * @param tile tile of depot where aircraft is built

   195

 * @param p1 aircraft type being built (engine)

   196

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

   197

 */

   198

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

   199

{

   200

	int32 value;

   201

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

   202

	UnitID unit_num;

   203

	const AircraftVehicleInfo *avi;

   204

	const AirportFTAClass* ap;

   205

	Engine *e;

   206

   207

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

   208

   209

	value = EstimateAircraftCost(p1);

   210

   211

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

   212

	if (flags & DC_QUERY_COST) return value;

   213

   214

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

   215

   216

	SET_EXPENSES_TYPE(EXPENSES_NEW_VEHICLES);

   217

   218

	avi = AircraftVehInfo(p1);

   219

   220

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

   221

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

   222

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

   223

		return CMD_ERROR;

   224

	}

   225

   226

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

   227

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

   228

			IsOrderPoolFull()) {

   229

		return_cmd_error(STR_00E1_TOO_MANY_VEHICLES_IN_GAME);

   230

	}

   231

   232

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

   233

	if (unit_num > _patches.max_aircraft)

   234

		return_cmd_error(STR_00E1_TOO_MANY_VEHICLES_IN_GAME);

   235

   236

	if (flags & DC_EXEC) {

   237

		CargoID cargo;

   238

		uint x;

   239

		uint y;

   240

   241

		v = vl[0];

   242

		u = vl[1];

   243

   244

		v->unitnumber = unit_num;

   245

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

   246

		v->direction = 3;

   247

   248

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

   249

   250

		v->tile = tile;

   251

//		u->tile = 0;

   252

   253

		x = TileX(tile) * TILE_SIZE + 5;

   254

		y = TileY(tile) * TILE_SIZE + 3;

   255

   256

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

   257

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

   258

   259

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

   260

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

   261

   262

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

   263

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

   264

   265

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

   266

		v->z_height = 5;

   267

   268

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

   269

		u->z_height = 1;

   270

   271

		v->vehstatus = VS_HIDDEN | VS_STOPPED | VS_DEFPAL;

   272

		u->vehstatus = VS_HIDDEN | VS_UNCLICKABLE | VS_SHADOW;

   273

   274

		v->spritenum = avi->image_index;

   275

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

   276

   277

		v->cargo_cap = avi->passenger_capacity;

   278

		u->cargo_cap = avi->mail_capacity;

   279

   280

		v->cargo_type = CT_PASSENGERS;

   281

		u->cargo_type = CT_MAIL;

   282

   283

		v->cargo_subtype = 0;

   284

   285

		v->string_id = STR_SV_AIRCRAFT_NAME;

   286

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

   287

   288

//		v->load_unload_time_rem = 0;

   289

//		v->progress = 0;

   290

		v->last_station_visited = INVALID_STATION;

   291

//		v->destination_coords = 0;

   292

   293

		v->max_speed = avi->max_speed;

   294

		v->acceleration = avi->acceleration;

   295

		v->engine_type = p1;

   296

   297

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

   298

		v->value = value;

   299

   300

		u->subtype = 4;

   301

   302

		/* Danger, Will Robinson!

   303

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

   304

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

   305

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

   306

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

   307

		cargo = FindFirstRefittableCargo(p1);

   308

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

   309

			uint16 callback = CALLBACK_FAILED;

   310

   311

			v->cargo_type = cargo;

   312

   313

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

   314

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

   315

			}

   316

   317

			if (callback == CALLBACK_FAILED) {

   318

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

   319

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

   320

			} else {

   321

				v->cargo_cap = callback;

   322

			}

   323

   324

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

   325

			u->cargo_cap = 0;

   326

		}

   327

   328

		e = GetEngine(p1);

   329

		v->reliability = e->reliability;

   330

		v->reliability_spd_dec = e->reliability_spd_dec;

   331

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

   332

   333

		_new_vehicle_id = v->index;

   334

   335

		v->u.air.pos = MAX_ELEMENTS;

   336

   337

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

   338

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

   339

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

   340

		 * of all depots, it is simple */

   341

		{

   342

			const Station* st = GetStationByTile(tile);

   343

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

   344

			uint i;

   345

   346

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

   347

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

   348

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

   349

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

   350

					break;

   351

				}

   352

			}

   353

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

   354

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

   355

		}

   356

   357

		v->u.air.state = HANGAR;

   358

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

   359

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

   360

		v->next = u;

   361

   362

		v->service_interval = _patches.servint_aircraft;

   363

   364

		v->date_of_last_service = _date;

   366

   367

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

   368

   369

		v->random_bits = VehicleRandomBits();

   370

		u->random_bits = VehicleRandomBits();

   371

   372

		VehiclePositionChanged(v);

   373

		VehiclePositionChanged(u);

   374

   375

		// Aircraft with 3 vehicles (chopper)?

   376

		if (v->subtype == 0) {

   377

			w = vl[2];

   378

   379

			u->next = w;

   380

   381

			w->type = VEH_Aircraft;

   382

			w->direction = 0;

   383

			w->owner = _current_player;

   384

			w->x_pos = v->x_pos;

   385

			w->y_pos = v->y_pos;

   386

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

   387

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

   388

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

   389

			w->z_height = 1;

   390

			w->vehstatus = VS_HIDDEN | VS_UNCLICKABLE;

   391

			w->spritenum = 0xFF;

   392

			w->subtype = 6;

   393

			w->cur_image = SPR_ROTOR_STOPPED;

   394

			w->random_bits = VehicleRandomBits();

   395

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

   396

			w->u.air.state = HRS_ROTOR_STOPPED;

   397

			VehiclePositionChanged(w);

   398

		}

   399

   400

		InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   401

		RebuildVehicleLists();

   402

		InvalidateWindow(WC_COMPANY, v->owner);

   403

		if (IsLocalPlayer())

   404

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

   405

	}

   406

   407

	return value;

   408

}

   409

   410

   411

static void DoDeleteAircraft(Vehicle *v)

   412

{

   413

	DeleteWindowById(WC_VEHICLE_VIEW, v->index);

   414

	RebuildVehicleLists();

   415

	InvalidateWindow(WC_COMPANY, v->owner);

   416

	DeleteVehicleChain(v);

   417

	InvalidateWindowClasses(WC_AIRCRAFT_LIST);

   418

}

   419

   420

/** Sell an aircraft.

   421

 * @param tile unused

   422

 * @param p1 vehicle ID to be sold

   423

 * @param p2 unused

   424

 */

   425

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

   426

{

   427

	Vehicle *v;

   428

	uint16 callback;

   429

   430

	if (!IsVehicleIndex(p1)) return CMD_ERROR;

   431

   432

	v = GetVehicle(p1);

   433

   434

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

   435

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

   436

   437

	SET_EXPENSES_TYPE(EXPENSES_NEW_VEHICLES);

   438

   439

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

   440

	 * return 0xFF if it can. */

   441

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

   442

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

   443

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

   444

		return_cmd_error(error);

   445

	}

   446

   447

	if (flags & DC_EXEC) {

   448

		// Invalidate depot

   449

		InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   450

		DoDeleteAircraft(v);

   451

		if (IsLocalPlayer())

   452

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

   453

	}

   454

   455

	return -(int32)v->value;

   456

}

   457

   458

/** Start/Stop an aircraft.

   459

 * @param tile unused

   460

 * @param p1 aircraft ID to start/stop

   461

 * @param p2 unused

   462

 */

   463

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

   464

{

   465

	Vehicle *v;

   466

   467

	if (!IsVehicleIndex(p1)) return CMD_ERROR;

   468

   469

	v = GetVehicle(p1);

   470

   471

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

   472

   473

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

   474

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

   475

		return_cmd_error(STR_A017_AIRCRAFT_IS_IN_FLIGHT);

   476

   477

	if (flags & DC_EXEC) {

   478

		if (IsAircraftInHangarStopped(v)) {

   479

			DeleteVehicleNews(p1, STR_A014_AIRCRAFT_IS_WAITING_IN);

   480

		}

   481

   482

		v->vehstatus ^= VS_STOPPED;

   483

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

   484

		InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   485

		InvalidateWindowClasses(WC_AIRCRAFT_LIST);

   486

	}

   487

   488

	return 0;

   489

}

   490

   491

/** Send an aircraft to the hangar.

   492

 * @param tile unused

   493

 * @param p1 vehicle ID to send to the hangar

   494

 * @param p2 various bitmasked elements

   495

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

   496

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