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

    21

#include "airport.h"

    22

#include "vehicle_gui.h"

    23

#include "table/sprites.h"

    24

#include "newgrf_engine.h"

    25

#include "newgrf_callbacks.h"

    26

#include "newgrf_text.h"

    27

#include "newgrf_sound.h"

    28

#include "date.h"

    29

#include "spritecache.h"

    30

    31

// this maps the terminal to its corresponding state and block flag

    32

// currently set for 10 terms, 4 helipads

    33

static const byte _airport_terminal_state[] = {2, 3, 4, 5, 6, 7, 19, 20, 0, 0, 8, 9, 21, 22};

    34

static const byte _airport_terminal_flag[] =  {0, 1, 2, 3, 4, 5, 22, 23, 0, 0, 6, 7, 24, 25};

    35

    36

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

    37

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

    38

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

    39

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

    40

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

    41

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

    42

static void CrashAirplane(Vehicle *v);

    43

    44

static void AircraftNextAirportPos_and_Order(Vehicle *v);

    45

static byte GetAircraftFlyingAltitude(const Vehicle *v);

    46

    47

static const SpriteID _aircraft_sprite[] = {

    48

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

    49

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

    50

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

    51

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

    52

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

    53

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

    54

	0x0EBD, 0x0EC5

    55

};

    56

    57

/* Helicopter rotor animation states */

    58

enum HelicopterRotorStates {

    59

	HRS_ROTOR_STOPPED,

    60

	HRS_ROTOR_MOVING_1,

    61

	HRS_ROTOR_MOVING_2,

    62

	HRS_ROTOR_MOVING_3,

    63

};

    64

    65

/* Find the nearest hangar to v

    66

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

    67

 * airports (like helipads only)

    68

 */

    69

static StationID FindNearestHangar(const Vehicle *v)

    70

{

    71

	const Station *st;

    72

	uint best = 0;

    73

	StationID index = INVALID_STATION;

    74

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

    75

    76

	FOR_ALL_STATIONS(st) {

    77

		if (st->owner != v->owner || !(st->facilities & FACIL_AIRPORT)) continue;

    78

    79

		const AirportFTAClass *afc = st->Airport();

    80

		if (afc->nof_depots == 0 || (

    81

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

    82

					afc->flags & AirportFTAClass::SHORT_STRIP &&

    83

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

    84

					!_cheats.no_jetcrash.value

    85

				)) {

    86

			continue;

    87

		}

    88

    89

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

    90

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

    91

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

    92

			best = distance;

    93

			index = st->index;

    94

		}

    95

	}

    96

	return index;

    97

}

    98

    99

#if 0

   100

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

   101

static bool HaveHangarInOrderList(Vehicle *v)

   102

{

   103

	const Order *order;

   104

   105

	FOR_VEHICLE_ORDERS(v, order) {

   106

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

   107

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

   108

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

   109

			if (st->Airport()->nof_depots != 0)

   110

				return true;

   111

		}

   112

	}

   113

   114

	return false;

   115

}

   116

#endif

   117

   118

int GetAircraftImage(const Vehicle* v, Direction direction)

   119

{

   120

	int spritenum = v->spritenum;

   121

   122

	if (is_custom_sprite(spritenum)) {

   123

		int sprite = GetCustomVehicleSprite(v, direction);

   124

   125

		if (sprite != 0) return sprite;

   126

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

   127

	}

   128

	return direction + _aircraft_sprite[spritenum];

   129

}

   130

   131

SpriteID GetRotorImage(const Vehicle *v)

   132

{

   133

	const Vehicle *w;

   134

   135

	assert(v->subtype == AIR_HELICOPTER);

   136

   137

	w = v->next->next;

   138

	if (is_custom_sprite(v->spritenum)) {

   139

		SpriteID spritenum = GetCustomRotorSprite(v, false);

   140

		if (spritenum != 0) return spritenum;

   141

	}

   142

   143

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

   144

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

   145

}

   146

   147

void DrawAircraftEngine(int x, int y, EngineID engine, SpriteID pal)

   148

{

   149

	const AircraftVehicleInfo* avi = AircraftVehInfo(engine);

   150

	int spritenum = avi->image_index;

   151

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

   152

   153

	if (is_custom_sprite(spritenum)) {

   154

		sprite = GetCustomVehicleIcon(engine, DIR_W);

   155

		if (sprite == 0) {

   156

			spritenum = orig_aircraft_vehicle_info[engine - AIRCRAFT_ENGINES_INDEX].image_index;

   157

			sprite = (6 + _aircraft_sprite[spritenum]);

   158

		}

   159

	}

   160

   161

	DrawSprite(sprite, pal, x, y);

   162

   163

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

   164

		SpriteID rotor_sprite = GetCustomRotorIcon(engine);

   165

		if (rotor_sprite == 0) rotor_sprite = SPR_ROTOR_STOPPED;

   166

		DrawSprite(rotor_sprite, PAL_NONE, x, y - 5);

   167

	}

   168

}

   169

   170

/** Get the size of the sprite of an aircraft sprite heading west (used for lists)

   171

 * @param engine The engine to get the sprite from

   172

 * @param &width The width of the sprite

   173

 * @param &height The height of the sprite

   174

 */

   175

void GetAircraftSpriteSize(EngineID engine, uint &width, uint &height)

   176

{

   177

	const AircraftVehicleInfo* avi = AircraftVehInfo(engine);

   178

	int spritenum = avi->image_index;

   179

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

   180

   181

	if (is_custom_sprite(spritenum)) {

   182

		sprite = GetCustomVehicleIcon(engine, DIR_W);

   183

		if (sprite == 0) {

   184

			spritenum = orig_aircraft_vehicle_info[engine - AIRCRAFT_ENGINES_INDEX].image_index;

   185

			sprite = (6 + _aircraft_sprite[spritenum]);

   186

		}

   187

	}

   188

   189

	const Sprite *spr = GetSprite(sprite);

   190

   191

	width  = spr->width ;

   192

	height = spr->height;

   193

}

   194

   195

static int32 EstimateAircraftCost(const AircraftVehicleInfo *avi)

   196

{

   197

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

   198

}

   199

   200

   201

/**

   202

 * Calculates cargo capacity based on an aircraft's passenger

   203

 * and mail capacities.

   204

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

   205

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

   206

 * @return New cargo capacity value.

   207

 */

   208

uint16 AircraftDefaultCargoCapacity(CargoID cid, EngineID engine_type)

   209

{

   210

	const AircraftVehicleInfo *avi = AircraftVehInfo(engine_type);

   211

   212

	assert(cid != CT_INVALID);

   213

   214

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

   215

	 * and four times as many passengers. */

   216

	switch (cid) {

   217

		case CT_PASSENGERS:

   218

			return avi->passenger_capacity;

   219

		case CT_MAIL:

   220

			return avi->passenger_capacity + avi->mail_capacity;

   221

		case CT_GOODS:

   222

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

   223

		default:

   224

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

   225

	}

   226

}

   227

   228

   229

/** Build an aircraft.

   230

 * @param tile tile of depot where aircraft is built

   231

 * @param p1 aircraft type being built (engine)

   232

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

   233

 */

   234

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

   235

{

   236

	Vehicle *vl[3];

   237

	UnitID unit_num;

   238

   239

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

   240

   241

	const AircraftVehicleInfo *avi = AircraftVehInfo(p1);

   242

	int32 value = EstimateAircraftCost(avi);

   243

   244

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

   245

	if (flags & DC_QUERY_COST) return value;

   246

   247

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

   248

   249

	SET_EXPENSES_TYPE(EXPENSES_NEW_VEHICLES);

   250

   251

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

   252

	const Station* st = GetStationByTile(tile);

   253

	const AirportFTAClass* apc = st->Airport();

   254

	if (!(apc->flags & (avi->subtype & AIR_CTOL ? AirportFTAClass::AIRPLANES : AirportFTAClass::HELICOPTERS))) {

   255

		return CMD_ERROR;

   256

	}

   257

   258

	/* Allocate 2 or 3 vehicle structs, depending on type

   259

	 * vl[0] = aircraft, vl[1] = shadow, [vl[2] = rotor] */

   260

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

   261

		return_cmd_error(STR_00E1_TOO_MANY_VEHICLES_IN_GAME);

   262

	}

   263

   264

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

   265

	if (unit_num > _patches.max_aircraft)

   266

		return_cmd_error(STR_00E1_TOO_MANY_VEHICLES_IN_GAME);

   267

   268

	if (flags & DC_EXEC) {

   269

		CargoID cargo;

   270

		uint x;

   271

		uint y;

   272

   273

		Vehicle *v = vl[0]; // aircraft

   274

		Vehicle *u = vl[1]; // shadow

   275

   276

		v->unitnumber = unit_num;

   277

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

   278

		v->direction = DIR_SE;

   279

   280

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

   281

   282

		v->tile = tile;

   283

//		u->tile = 0;

   284

   285

		x = TileX(tile) * TILE_SIZE + 5;

   286

		y = TileY(tile) * TILE_SIZE + 3;

   287

   288

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

   289

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

   290

   291

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

   292

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

   293

   294

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

   295

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

   296

   297

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

   298

		v->z_height = 5;

   299

   300

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

   301

		u->z_height = 1;

   302

   303

		v->vehstatus = VS_HIDDEN | VS_STOPPED | VS_DEFPAL;

   304

		u->vehstatus = VS_HIDDEN | VS_UNCLICKABLE | VS_SHADOW;

   305

   306

		v->spritenum = avi->image_index;

   307

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

   308

   309

		v->cargo_cap = avi->passenger_capacity;

   310

		u->cargo_cap = avi->mail_capacity;

   311

   312

		v->cargo_type = CT_PASSENGERS;

   313

		u->cargo_type = CT_MAIL;

   314

   315

		v->cargo_subtype = 0;

   316

   317

		v->string_id = STR_SV_AIRCRAFT_NAME;

   318

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

   319

   320

//		v->load_unload_time_rem = 0;

   321

//		v->progress = 0;

   322

		v->last_station_visited = INVALID_STATION;

   323

//		v->destination_coords = 0;

   324

   325

		v->max_speed = avi->max_speed;

   326

		v->acceleration = avi->acceleration;

   327

		v->engine_type = p1;

   328

   329

		v->subtype = (avi->subtype & AIR_CTOL ? AIR_AIRCRAFT : AIR_HELICOPTER);

   330

		v->value = value;

   331

   332

		u->subtype = AIR_SHADOW;

   333

   334

		/* Danger, Will Robinson!

   335

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

   336

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

   337

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

   338

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

   339

		cargo = FindFirstRefittableCargo(p1);

   340

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

   341

			uint16 callback = CALLBACK_FAILED;

   342

   343

			v->cargo_type = cargo;

   344

   345

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

   346

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

   347

			}

   348

   349

			if (callback == CALLBACK_FAILED) {

   350

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

   351

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

   352

			} else {

   353

				v->cargo_cap = callback;

   354

			}

   355

   356

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

   357

			u->cargo_cap = 0;

   358

		}

   359

   360

		const Engine *e = GetEngine(p1);

   361

		v->reliability = e->reliability;

   362

		v->reliability_spd_dec = e->reliability_spd_dec;

   363

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

   364

   365

		_new_vehicle_id = v->index;

   366

   367

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

   368

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

   369

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

   370

		 * of all depots, it is simple */

   371

		for (uint i = 0;; i++) {

   372

			assert(i != apc->nof_depots);

   373

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

   374

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

   375

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

   376

				break;

   377

			}

   378

		}

   379

   380

		v->u.air.state = HANGAR;

   381

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

   382

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

   383

		v->next = u;

   384

   385

		v->service_interval = _patches.servint_aircraft;

   386

   387

		v->date_of_last_service = _date;

   388

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

   389

   390

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

   391

   392

		v->random_bits = VehicleRandomBits();

   393

		u->random_bits = VehicleRandomBits();

   394

   395

		VehiclePositionChanged(v);

   396

		VehiclePositionChanged(u);

   397

   398

		// Aircraft with 3 vehicles (chopper)?

   399

		if (v->subtype == AIR_HELICOPTER) {

   400

			Vehicle *w = vl[2];

   401

   402

			u->next = w;

   403

   404

			w->type = VEH_Aircraft;

   405

			w->direction = DIR_N;

   406

			w->owner = _current_player;

   407

			w->x_pos = v->x_pos;

   408

			w->y_pos = v->y_pos;

   409

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

   410

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

   411

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

   412

			w->z_height = 1;

   413

			w->vehstatus = VS_HIDDEN | VS_UNCLICKABLE;

   414

			w->spritenum = 0xFF;

   415

			w->subtype = AIR_ROTOR;

   416

			w->cur_image = SPR_ROTOR_STOPPED;

   417

			w->random_bits = VehicleRandomBits();

   418

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

   419

			w->u.air.state = HRS_ROTOR_STOPPED;

   420

			VehiclePositionChanged(w);

   421

		}

   422

   423

		InvalidateWindowData(WC_VEHICLE_DEPOT, v->tile);

   424

		RebuildVehicleLists();

   425

		InvalidateWindow(WC_COMPANY, v->owner);

   426

		if (IsLocalPlayer())

   427

			InvalidateAutoreplaceWindow(VEH_Aircraft); //updates the replace Aircraft window

   428

   429

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

   430

	}

   431

   432

	return value;

   433

}

   434

   435

   436

static void DoDeleteAircraft(Vehicle *v)

   437

{

   438

	DeleteWindowById(WC_VEHICLE_VIEW, v->index);

   439

	RebuildVehicleLists();

   440

	InvalidateWindow(WC_COMPANY, v->owner);

   441

	DeleteDepotHighlightOfVehicle(v);

   442

	DeleteVehicleChain(v);

   443

	InvalidateWindowClasses(WC_AIRCRAFT_LIST);

   444

}

   445

   446

/** Sell an aircraft.

   447

 * @param tile unused

   448

 * @param p1 vehicle ID to be sold

   449

 * @param p2 unused

   450

 */

   451

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

   452

{

   453

	Vehicle *v;

   454

   455

	if (!IsValidVehicleID(p1)) return CMD_ERROR;

   456

   457

	v = GetVehicle(p1);

   458

   459

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

   460

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

   461

   462

	SET_EXPENSES_TYPE(EXPENSES_NEW_VEHICLES);

   463

   464

	if (flags & DC_EXEC) {

   465

		// Invalidate depot

   466

		InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   467

		DoDeleteAircraft(v);

   468

	}

   469

   470

	return -(int32)v->value;

   471

}

   472

   473

/** Start/Stop an aircraft.

   474

 * @param tile unused

   475

 * @param p1 aircraft ID to start/stop

   476

 * @param p2 unused

   477

 */

   478

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

   479

{

   480

	Vehicle *v;

   481

	uint16 callback;

   482

   483

	if (!IsValidVehicleID(p1)) return CMD_ERROR;

   484

   485

	v = GetVehicle(p1);

   486

   487

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

   488

   489

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

   490

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

   491

		return_cmd_error(STR_A017_AIRCRAFT_IS_IN_FLIGHT);

   492

   493

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