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

#include "cargotype.h"

    34

    35

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

    36

 *  currently set for 10 terms, 4 helipads */

    37

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

    38

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

    39

    40

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

    41

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

    42

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

    43

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

    44

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

    45

static void CrashAirplane(Vehicle *v);

    46

    47

static void AircraftNextAirportPos_and_Order(Vehicle *v);

    48

static byte GetAircraftFlyingAltitude(const Vehicle *v);

    49

    50

static const SpriteID _aircraft_sprite[] = {

    51

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

    52

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

    53

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

    54

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

    55

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

    56

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

    57

	0x0EBD, 0x0EC5

    58

};

    59

    60

/** Helicopter rotor animation states */

    61

enum HelicopterRotorStates {

    62

	HRS_ROTOR_STOPPED,

    63

	HRS_ROTOR_MOVING_1,

    64

	HRS_ROTOR_MOVING_2,

    65

	HRS_ROTOR_MOVING_3,

    66

};

    67

    68

/** Find the nearest hangar to v

    69

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

    70

 * airports (like helipads only)

    71

 * @param v vehicle looking for a hangar

    72

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

    73

 */

    74

static StationID FindNearestHangar(const Vehicle *v)

    75

{

    76

	const Station *st;

    77

	uint best = 0;

    78

	StationID index = INVALID_STATION;

    79

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

    80

    81

	FOR_ALL_STATIONS(st) {

    82

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

    83

    84

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

    85

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

    86

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

    87

					afc->flags & AirportFTAClass::SHORT_STRIP &&

    88

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

    89

					!_cheats.no_jetcrash.value

    90

				)) {

    91

			continue;

    92

		}

    93

    94

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

    95

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

    96

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

    97

			best = distance;

    98

			index = st->index;

    99

		}

   100

	}

   101

	return index;

   102

}

   103

   104

#if 0

   105

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

   106

 * @param v vehicle to inquiry

   107

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

   108

static bool HaveHangarInOrderList(Vehicle *v)

   109

{

   110

	const Order *order;

   111

   112

	FOR_VEHICLE_ORDERS(v, order) {

   113

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

   114

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

   115

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

   116

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

   117

				return true;

   118

		}

   119

	}

   120

   121

	return false;

   122

}

   123

#endif

   124

   125

int GetAircraftImage(const Vehicle* v, Direction direction)

   126

{

   127

	int spritenum = v->spritenum;

   128

   129

	if (is_custom_sprite(spritenum)) {

   130

		int sprite = GetCustomVehicleSprite(v, direction);

   131

   132

		if (sprite != 0) return sprite;

   133

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

   134

	}

   135

	return direction + _aircraft_sprite[spritenum];

   136

}

   137

   138

SpriteID GetRotorImage(const Vehicle *v)

   139

{

   140

	assert(v->subtype == AIR_HELICOPTER);

   141

   142

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

   143

	if (is_custom_sprite(v->spritenum)) {

   144

		SpriteID spritenum = GetCustomRotorSprite(v, false);

   145

		if (spritenum != 0) return spritenum;

   146

	}

   147

   148

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

   149

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

   150

}

   151

   152

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

   153

{

   154

	const AircraftVehicleInfo* avi = AircraftVehInfo(engine);

   155

	int spritenum = avi->image_index;

   156

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

   157

   158

	if (is_custom_sprite(spritenum)) {

   159

		sprite = GetCustomVehicleIcon(engine, DIR_W);

   160

		if (sprite == 0) {

   161

			spritenum = orig_aircraft_vehicle_info[engine - AIRCRAFT_ENGINES_INDEX].image_index;

   162

			sprite = (6 + _aircraft_sprite[spritenum]);

   163

		}

   164

	}

   165

   166

	DrawSprite(sprite, pal, x, y);

   167

   168

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

   169

		SpriteID rotor_sprite = GetCustomRotorIcon(engine);

   170

		if (rotor_sprite == 0) rotor_sprite = SPR_ROTOR_STOPPED;

   171

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

   172

	}

   173

}

   174

   175

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

   176

 * @param engine The engine to get the sprite from

   177

 * @param &width The width of the sprite

   178

 * @param &height The height of the sprite

   179

 */

   180

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

   181

{

   182

	const AircraftVehicleInfo* avi = AircraftVehInfo(engine);

   183

	int spritenum = avi->image_index;

   184

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

   185

   186

	if (is_custom_sprite(spritenum)) {

   187

		sprite = GetCustomVehicleIcon(engine, DIR_W);

   188

		if (sprite == 0) {

   189

			spritenum = orig_aircraft_vehicle_info[engine - AIRCRAFT_ENGINES_INDEX].image_index;

   190

			sprite = (6 + _aircraft_sprite[spritenum]);

   191

		}

   192

	}

   193

   194

	const Sprite *spr = GetSprite(sprite);

   195

   196

	width  = spr->width ;

   197

	height = spr->height;

   198

}

   199

   200

static int32 EstimateAircraftCost(const AircraftVehicleInfo *avi)

   201

{

   202

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

   203

}

   204

   205

   206

/**

   207

 * Calculates cargo capacity based on an aircraft's passenger

   208

 * and mail capacities.

   209

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

   210

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

   211

 * @return New cargo capacity value.

   212

 */

   213

uint16 AircraftDefaultCargoCapacity(CargoID cid, const AircraftVehicleInfo *avi)

   214

{

   215

	assert(cid != CT_INVALID);

   216

   217

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

   218

	 * and four times as many passengers. */

   219

	switch (cid) {

   220

		case CT_PASSENGERS:

   221

			return avi->passenger_capacity;

   222

		case CT_MAIL:

   223

			return avi->passenger_capacity + avi->mail_capacity;

   224

		case CT_GOODS:

   225

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

   226

		default:

   227

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

   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

	if (!IsAircraftBuildableAtStation(p1, tile)) return CMD_ERROR;

   254

   255

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

   256

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

   257

	Vehicle *vl[3];

   258

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

   259

		return_cmd_error(STR_00E1_TOO_MANY_VEHICLES_IN_GAME);

   260

	}

   261

   262

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

   263

	if (unit_num > _patches.max_aircraft)

   264

		return_cmd_error(STR_00E1_TOO_MANY_VEHICLES_IN_GAME);

   265

   266

	if (flags & DC_EXEC) {

   267

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

   268

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

   269

   270

		v->unitnumber = unit_num;

   271

		v->type = u->type = VEH_AIRCRAFT;

   272

		v->direction = DIR_SE;

   273

   274

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

   275

   276

		v->tile = tile;

   277

//		u->tile = 0;

   278

   279

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

   280

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

   281

   282

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

   283

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

   284

   285

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

   286

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

   287

   288

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

   289

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

   290

   291

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

   292

		v->z_height = 5;

   293

   294

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

   295

		u->z_height = 1;

   296

   297

		v->vehstatus = VS_HIDDEN | VS_STOPPED | VS_DEFPAL;

   298

		u->vehstatus = VS_HIDDEN | VS_UNCLICKABLE | VS_SHADOW;

   299

   300

		v->spritenum = avi->image_index;

   301

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

   302

   303

		v->cargo_cap = avi->passenger_capacity;

   304

		u->cargo_cap = avi->mail_capacity;

   305

   306

		v->cargo_type = CT_PASSENGERS;

   307

		u->cargo_type = CT_MAIL;

   308

   309

		v->cargo_subtype = 0;

   310

   311

		v->string_id = STR_SV_AIRCRAFT_NAME;

   312

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

   313

   314

//		v->load_unload_time_rem = 0;

   315

//		v->progress = 0;

   316

		v->last_station_visited = INVALID_STATION;

   317

//		v->destination_coords = 0;

   318

   319

		v->max_speed = avi->max_speed;

   320

		v->acceleration = avi->acceleration;

   321

		v->engine_type = p1;

   322

   323

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

   324

		v->value = value;

   325

   326

		u->subtype = AIR_SHADOW;

   327

   328

		/* Danger, Will Robinson!

   329

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

   330

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

   331

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

   332

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

   333

		CargoID cargo = FindFirstRefittableCargo(p1);

   334

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

   335

			uint16 callback = CALLBACK_FAILED;

   336

   337

			v->cargo_type = cargo;

   338

   339

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

   340

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

   341

			}

   342

   343

			if (callback == CALLBACK_FAILED) {

   344

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

   345

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

   346

			} else {

   347

				v->cargo_cap = callback;

   348

			}

   349

   350

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

   351

			u->cargo_cap = 0;

   352

		}

   353

   354

		const Engine *e = GetEngine(p1);

   355

		v->reliability = e->reliability;

   356

		v->reliability_spd_dec = e->reliability_spd_dec;

   357

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

   358

   359

		_new_vehicle_id = v->index;

   360

   361

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

   362

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

   363

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

   364

		 * of all depots, it is simple */

   365

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

   366

			const Station *st = GetStationByTile(tile);

   367

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

   368

   369

			assert(i != apc->nof_depots);

   370

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

   371

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

   372

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

   373

				break;

   374

			}

   375

		}

   376

   377

		v->u.air.state = HANGAR;

   378

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

   379

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

   380

		v->next = u;

   381

   382

		v->service_interval = _patches.servint_aircraft;

   383

   384

		v->date_of_last_service = _date;

   385

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

   386

   387

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

   388

   389

		v->random_bits = VehicleRandomBits();

   390

		u->random_bits = VehicleRandomBits();

   391

   392

		v->vehicle_flags = 0;

   393

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

   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 flags for command type

   449

 * @param p1 vehicle ID to be sold

   450

 * @param p2 unused

   451

 * @return result of operation.  Error or sold value

   452

 */

   453

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

   454

{

   455

	if (!IsValidVehicleID(p1)) return CMD_ERROR;

   456

   457

	Vehicle *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 flags for command type

   476

 * @param p1 aircraft ID to start/stop

   477

 * @param p2 unused

   478

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

   479

 */

   480

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

   481

{

   482

	if (!IsValidVehicleID(p1)) return CMD_ERROR;

   483

   484

	Vehicle *v = GetVehicle(p1);

   485

   486

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

   487

   488

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

   489

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

   490

		return_cmd_error(STR_A017_AIRCRAFT_IS_IN_FLIGHT);

   491