1

/* $Id$ */

     2

     3

/** @file aircraft_cmd.cpp

     4

 * This file deals with aircraft and airport movements functionalities */

     5

     6

#include "stdafx.h"

     7

#include "openttd.h"

     8

#include "aircraft.h"

     9

#include "debug.h"

    10

#include "functions.h"

    11

#include "station_map.h"

    12

#include "table/strings.h"

    13

#include "map.h"

    14

#include "tile.h"

    15

#include "vehicle.h"

    16

#include "depot.h"

    17

#include "engine.h"

    18

#include "command.h"

    19

#include "station.h"

    20

#include "news.h"

    21

#include "sound.h"

    22

#include "player.h"

    23

#include "aircraft.h"

    24

#include "airport.h"

    25

#include "vehicle_gui.h"

    26

#include "table/sprites.h"

    27

#include "newgrf_engine.h"

    28

#include "newgrf_callbacks.h"

    29

#include "newgrf_text.h"

    30

#include "newgrf_sound.h"

    31

#include "date.h"

    32

#include "spritecache.h"

    33

    34

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

    35

 *  currently set for 10 terms, 4 helipads */

    36

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

    37

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

    38

    39

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

    40

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

    41

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

    42

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

    43

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

    44

static void CrashAirplane(Vehicle *v);

    45

    46

static void AircraftNextAirportPos_and_Order(Vehicle *v);

    47

static byte GetAircraftFlyingAltitude(const Vehicle *v);

    48

    49

static const SpriteID _aircraft_sprite[] = {

    50

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

    51

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

    52

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

    53

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

    54

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

    55

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

    56

	0x0EBD, 0x0EC5

    57

};

    58

    59

/** Helicopter rotor animation states */

    60

enum HelicopterRotorStates {

    61

	HRS_ROTOR_STOPPED,

    62

	HRS_ROTOR_MOVING_1,

    63

	HRS_ROTOR_MOVING_2,

    64

	HRS_ROTOR_MOVING_3,

    65

};

    66

    67

/** Find the nearest hangar to v

    68

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

    69

 * airports (like helipads only)

    70

 * @param v vehicle looking for a hangar

    71

 * @return the StationID if one is found, otherwise, INVALID_STATION

    72

 */

    73

static StationID FindNearestHangar(const Vehicle *v)

    74

{

    75

	const Station *st;

    76

	uint best = 0;

    77

	StationID index = INVALID_STATION;

    78

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

    79

    80

	FOR_ALL_STATIONS(st) {

    81

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

    82

    83

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

    84

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

    85

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

    86

					afc->flags & AirportFTAClass::SHORT_STRIP &&

    87

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

    88

					!_cheats.no_jetcrash.value

    89

				)) {

    90

			continue;

    91

		}

    92

    93

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

    94

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

    95

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

    96

			best = distance;

    97

			index = st->index;

    98

		}

    99

	}

   100

	return index;

   101

}

   102

   103

#if 0

   104

/** Check if given vehicle has a goto hangar in his orders

   105

 * @param v vehicle to inquiry

   106

 * @return true if vehicle v has an airport in the schedule, that has a hangar */

   107

static bool HaveHangarInOrderList(Vehicle *v)

   108

{

   109

	const Order *order;

   110

   111

	FOR_VEHICLE_ORDERS(v, order) {

   112

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

   113

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

   114

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

   115

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

   116

				return true;

   117

		}

   118

	}

   119

   120

	return false;

   121

}

   122

#endif

   123

   124

int GetAircraftImage(const Vehicle* v, Direction direction)

   125

{

   126

	int spritenum = v->spritenum;

   127

   128

	if (is_custom_sprite(spritenum)) {

   129

		int sprite = GetCustomVehicleSprite(v, direction);

   130

   131

		if (sprite != 0) return sprite;

   132

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

   133

	}

   134

	return direction + _aircraft_sprite[spritenum];

   135

}

   136

   137

SpriteID GetRotorImage(const Vehicle *v)

   138

{

   139

	assert(v->subtype == AIR_HELICOPTER);

   140

   141

	const Vehicle *w = v->next->next;

   142

	if (is_custom_sprite(v->spritenum)) {

   143

		SpriteID spritenum = GetCustomRotorSprite(v, false);

   144

		if (spritenum != 0) return spritenum;

   145

	}

   146

   147

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

   148

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

   149

}

   150

   151

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

   152

{

   153

	const AircraftVehicleInfo* avi = AircraftVehInfo(engine);

   154

	int spritenum = avi->image_index;

   155

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

   156

   157

	if (is_custom_sprite(spritenum)) {

   158

		sprite = GetCustomVehicleIcon(engine, DIR_W);

   159

		if (sprite == 0) {

   160

			spritenum = orig_aircraft_vehicle_info[engine - AIRCRAFT_ENGINES_INDEX].image_index;

   161

			sprite = (6 + _aircraft_sprite[spritenum]);

   162

		}

   163

	}

   164

   165

	DrawSprite(sprite, pal, x, y);

   166

   167

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

   168

		SpriteID rotor_sprite = GetCustomRotorIcon(engine);

   169

		if (rotor_sprite == 0) rotor_sprite = SPR_ROTOR_STOPPED;

   170

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

   171

	}

   172

}

   173

   174

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

   175

 * @param engine The engine to get the sprite from

   176

 * @param &width The width of the sprite

   177

 * @param &height The height of the sprite

   178

 */

   179

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

   180

{

   181

	const AircraftVehicleInfo* avi = AircraftVehInfo(engine);

   182

	int spritenum = avi->image_index;

   183

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

   184

   185

	if (is_custom_sprite(spritenum)) {

   186

		sprite = GetCustomVehicleIcon(engine, DIR_W);

   187

		if (sprite == 0) {

   188

			spritenum = orig_aircraft_vehicle_info[engine - AIRCRAFT_ENGINES_INDEX].image_index;

   189

			sprite = (6 + _aircraft_sprite[spritenum]);

   190

		}

   191

	}

   192

   193

	const Sprite *spr = GetSprite(sprite);

   194

   195

	width  = spr->width ;

   196

	height = spr->height;

   197

}

   198

   199

static int32 EstimateAircraftCost(const AircraftVehicleInfo *avi)

   200

{

   201

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

   202

}

   203

   204

   205

/**

   206

 * Calculates cargo capacity based on an aircraft's passenger

   207

 * and mail capacities.

   208

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

   209

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

   210

 * @return New cargo capacity value.

   211

 */

   212

uint16 AircraftDefaultCargoCapacity(CargoID cid, const AircraftVehicleInfo *avi)

   213

{

   214

	assert(cid != CT_INVALID);

   215

   216

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

   217

	 * and four times as many passengers. */

   218

	switch (cid) {

   219

		case CT_PASSENGERS:

   220

			return avi->passenger_capacity;

   221

		case CT_MAIL:

   222

			return avi->passenger_capacity + avi->mail_capacity;

   223

		case CT_GOODS:

   224

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

   225

		default:

   226

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

   227

	}

   228

}

   229

   230

   231

/** Build an aircraft.

   232

 * @param tile tile of depot where aircraft is built

   233

 * @param flags for command

   234

 * @param p1 aircraft type being built (engine)

   235

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

   236

 * return result of operation.  Could be cost, error

   237

 */

   238

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

   239

{

   240

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

   241

   242

	const AircraftVehicleInfo *avi = AircraftVehInfo(p1);

   243

	int32 value = EstimateAircraftCost(avi);

   244

   245

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

   246

	if (flags & DC_QUERY_COST) return value;

   247

   248

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

   249

   250

	SET_EXPENSES_TYPE(EXPENSES_NEW_VEHICLES);

   251

   252

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

   253

	const Station* st = GetStationByTile(tile);

   254

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

   255

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

   256

		return CMD_ERROR;

   257

	}

   258

   259

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

   260

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

   261

	Vehicle *vl[3];

   262

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

   263

		return_cmd_error(STR_00E1_TOO_MANY_VEHICLES_IN_GAME);

   264

	}

   265

   266

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

   267

	if (unit_num > _patches.max_aircraft)

   268

		return_cmd_error(STR_00E1_TOO_MANY_VEHICLES_IN_GAME);

   269

   270

	if (flags & DC_EXEC) {

   271

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

   272

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

   273

   274

		v->unitnumber = unit_num;

   275

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

   276

		v->direction = DIR_SE;

   277

   278

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

   279

   280

		v->tile = tile;

   281

//		u->tile = 0;

   282

   283

		uint x = TileX(tile) * TILE_SIZE + 5;

   284

		uint y = TileY(tile) * TILE_SIZE + 3;

   285

   286

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

   287

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

   288

   289

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

   290

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

   291

   292

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

   293

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

   294

   295

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

   296

		v->z_height = 5;

   297

   298

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

   299

		u->z_height = 1;

   300

   301

		v->vehstatus = VS_HIDDEN | VS_STOPPED | VS_DEFPAL;

   302

		u->vehstatus = VS_HIDDEN | VS_UNCLICKABLE | VS_SHADOW;

   303

   304

		v->spritenum = avi->image_index;

   305

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

   306

   307

		v->cargo_cap = avi->passenger_capacity;

   308

		u->cargo_cap = avi->mail_capacity;

   309

   310

		v->cargo_type = CT_PASSENGERS;

   311

		u->cargo_type = CT_MAIL;

   312

   313

		v->cargo_subtype = 0;

   314

   315

		v->string_id = STR_SV_AIRCRAFT_NAME;

   316

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

   317

   318

//		v->load_unload_time_rem = 0;

   319

//		v->progress = 0;

   320

		v->last_station_visited = INVALID_STATION;

   321

//		v->destination_coords = 0;

   322

   323

		v->max_speed = avi->max_speed;

   324

		v->acceleration = avi->acceleration;

   325

		v->engine_type = p1;

   326

   327

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

   328

		v->value = value;

   329

   330

		u->subtype = AIR_SHADOW;

   331

   332

		/* Danger, Will Robinson!

   333

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

   334

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

   335

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

   336

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

   337

		CargoID cargo = FindFirstRefittableCargo(p1);

   338

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

   339

			uint16 callback = CALLBACK_FAILED;

   340

   341

			v->cargo_type = cargo;

   342

   343

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

   344

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

   345

			}

   346

   347

			if (callback == CALLBACK_FAILED) {

   348

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

   349

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

   350

			} else {

   351

				v->cargo_cap = callback;

   352

			}

   353

   354

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

   355

			u->cargo_cap = 0;

   356

		}

   357

   358

		const Engine *e = GetEngine(p1);

   359

		v->reliability = e->reliability;

   360

		v->reliability_spd_dec = e->reliability_spd_dec;

   361

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

   362

   363

		_new_vehicle_id = v->index;

   364

   365

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

   366

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

   367

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

   368

		 * of all depots, it is simple */

   369

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

   370

			assert(i != apc->nof_depots);

   371

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

   372

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

   373

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

   374

				break;

   375

			}

   376

		}

   377

   378

		v->u.air.state = HANGAR;

   379

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

   380

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

   381

		v->next = u;

   382

   383

		v->service_interval = _patches.servint_aircraft;

   384

   385

		v->date_of_last_service = _date;

   386

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

   387

   388

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

   389

   390

		v->random_bits = VehicleRandomBits();

   391

		u->random_bits = VehicleRandomBits();

   392

   393

		v->vehicle_flags = 0;

   394

		if (e->flags & ENGINE_EXCLUSIVE_PREVIEW) SETBIT(v->vehicle_flags, VF_BUILT_AS_PROTOTYPE);

   395

   396

		VehiclePositionChanged(v);

   397

		VehiclePositionChanged(u);

   398

   399

		/* Aircraft with 3 vehicles (chopper)? */

   400

		if (v->subtype == AIR_HELICOPTER) {

   401

			Vehicle *w = vl[2];

   402

   403

			u->next = w;

   404

   405

			w->type = VEH_Aircraft;

   406

			w->direction = DIR_N;

   407

			w->owner = _current_player;

   408

			w->x_pos = v->x_pos;

   409

			w->y_pos = v->y_pos;

   410

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

   411

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

   412

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

   413

			w->z_height = 1;

   414

			w->vehstatus = VS_HIDDEN | VS_UNCLICKABLE;

   415

			w->spritenum = 0xFF;

   416

			w->subtype = AIR_ROTOR;

   417

			w->cur_image = SPR_ROTOR_STOPPED;

   418

			w->random_bits = VehicleRandomBits();

   419

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

   420

			w->u.air.state = HRS_ROTOR_STOPPED;

   421

			VehiclePositionChanged(w);

   422

		}

   423

   424

		InvalidateWindowData(WC_VEHICLE_DEPOT, v->tile);

   425

		RebuildVehicleLists();

   426

		InvalidateWindow(WC_COMPANY, v->owner);

   427

		if (IsLocalPlayer())

   428

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

   429

   430

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

   431

	}

   432

   433

	return value;

   434

}

   435

   436

   437

static void DoDeleteAircraft(Vehicle *v)

   438

{

   439

	DeleteWindowById(WC_VEHICLE_VIEW, v->index);

   440

	RebuildVehicleLists();

   441

	InvalidateWindow(WC_COMPANY, v->owner);

   442

	DeleteDepotHighlightOfVehicle(v);

   443

	DeleteVehicleChain(v);

   444

	InvalidateWindowClasses(WC_AIRCRAFT_LIST);

   445

}

   446

   447

/** Sell an aircraft.

   448

 * @param tile unused

   449

 * @param flags for command type

   450

 * @param p1 vehicle ID to be sold

   451

 * @param p2 unused

   452

 * @return result of operation.  Error or sold value

   453

 */

   454

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

   455

{

   456

	if (!IsValidVehicleID(p1)) return CMD_ERROR;

   457

   458

	Vehicle *v = GetVehicle(p1);

   459

   460

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

   461

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

   462

   463

	SET_EXPENSES_TYPE(EXPENSES_NEW_VEHICLES);

   464

   465

	if (flags & DC_EXEC) {

   466

		// Invalidate depot

   467

		InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   468

		DoDeleteAircraft(v);

   469

	}

   470

   471

	return -(int32)v->value;

   472

}

   473

   474

/** Start/Stop an aircraft.

   475

 * @param tile unused

   476

 * @param flags for command type

   477

 * @param p1 aircraft ID to start/stop

   478

 * @param p2 unused

   479

 * @return result of operation.  Nothing if everything went well

   480

 */

   481

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

   482

{

   483

	if (!IsValidVehicleID(p1)) return CMD_ERROR;

   484

   485

	Vehicle *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