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"

    35

    36

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

    37

static bool AirportSetBlocks(Vehicle *v, const 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 CrashAirplane(Vehicle *v);

    42

    43

static void AircraftNextAirportPos_and_Order(Vehicle *v);

    44

static byte GetAircraftFlyingAltitude(const Vehicle *v);

    45

    46

static const SpriteID _aircraft_sprite[] = {

    47

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

    48

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

    49

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

    50

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

    51

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

    52

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

    53

	0x0EBD, 0x0EC5

    54

};

    55

    56

/** Helicopter rotor animation states */

    57

enum HelicopterRotorStates {

    58

	HRS_ROTOR_STOPPED,

    59

	HRS_ROTOR_MOVING_1,

    60

	HRS_ROTOR_MOVING_2,

    61

	HRS_ROTOR_MOVING_3,

    62

};

    63

    64

/** Find the nearest hangar to v

    65

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

    66

 * airports (like helipads only)

    67

 * @param v vehicle looking for a hangar

    68

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

    69

 */

    70

static StationID FindNearestHangar(const Vehicle *v)

    71

{

    72

	const Station *st;

    73

	uint best = 0;

    74

	StationID index = INVALID_STATION;

    75

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

    76

    77

	FOR_ALL_STATIONS(st) {

    78

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

    79

    80

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

    81

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

    82

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

    83

					afc->flags & AirportFTAClass::SHORT_STRIP &&

    84

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

    85

					!_cheats.no_jetcrash.value

    86

				)) {

    87

			continue;

    88

		}

    89

    90

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

    91

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

    92

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

    93

			best = distance;

    94

			index = st->index;

    95

		}

    96

	}

    97

	return index;

    98

}

    99

   100

#if 0

   101

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

   102

 * @param v vehicle to inquiry

   103

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

   104

static bool HaveHangarInOrderList(Vehicle *v)

   105

{

   106

	const Order *order;

   107

   108

	FOR_VEHICLE_ORDERS(v, order) {

   109

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

   110

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

   111

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

   112

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

   113

				return true;

   114

		}

   115

	}

   116

   117

	return false;

   118

}

   119

#endif

   120

   121

int GetAircraftImage(const Vehicle* v, Direction direction)

   122

{

   123

	int spritenum = v->spritenum;

   124

   125

	if (is_custom_sprite(spritenum)) {

   126

		int sprite = GetCustomVehicleSprite(v, direction);

   127

   128

		if (sprite != 0) return sprite;

   129

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

   130

	}

   131

	return direction + _aircraft_sprite[spritenum];

   132

}

   133

   134

SpriteID GetRotorImage(const Vehicle *v)

   135

{

   136

	assert(v->subtype == AIR_HELICOPTER);

   137

   138

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

   139

	if (is_custom_sprite(v->spritenum)) {

   140

		SpriteID spritenum = GetCustomRotorSprite(v, false);

   141

		if (spritenum != 0) return spritenum;

   142

	}

   143

   144

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

   145

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

   146

}

   147

   148

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

   149

{

   150

	const AircraftVehicleInfo* avi = AircraftVehInfo(engine);

   151

	int spritenum = avi->image_index;

   152

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

   153

   154

	if (is_custom_sprite(spritenum)) {

   155

		sprite = GetCustomVehicleIcon(engine, DIR_W);

   156

		if (sprite == 0) {

   157

			spritenum = orig_aircraft_vehicle_info[engine - AIRCRAFT_ENGINES_INDEX].image_index;

   158

			sprite = (6 + _aircraft_sprite[spritenum]);

   159

		}

   160

	}

   161

   162

	DrawSprite(sprite, pal, x, y);

   163

   164

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

   165

		SpriteID rotor_sprite = GetCustomRotorIcon(engine);

   166

		if (rotor_sprite == 0) rotor_sprite = SPR_ROTOR_STOPPED;

   167

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

   168

	}

   169

}

   170

   171

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

   172

 * @param engine The engine to get the sprite from

   173

 * @param &width The width of the sprite

   174

 * @param &height The height of the sprite

   175

 */

   176

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

   177

{

   178

	const AircraftVehicleInfo* avi = AircraftVehInfo(engine);

   179

	int spritenum = avi->image_index;

   180

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

   181

   182

	if (is_custom_sprite(spritenum)) {

   183

		sprite = GetCustomVehicleIcon(engine, DIR_W);

   184

		if (sprite == 0) {

   185

			spritenum = orig_aircraft_vehicle_info[engine - AIRCRAFT_ENGINES_INDEX].image_index;

   186

			sprite = (6 + _aircraft_sprite[spritenum]);

   187

		}

   188

	}

   189

   190

	const Sprite *spr = GetSprite(sprite);

   191

   192

	width  = spr->width ;

   193

	height = spr->height;

   194

}

   195

   196

static int32 EstimateAircraftCost(const AircraftVehicleInfo *avi)

   197

{

   198

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

   199

}

   200

   201

   202

/**

   203

 * Calculates cargo capacity based on an aircraft's passenger

   204

 * and mail capacities.

   205

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

   206

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

   207

 * @return New cargo capacity value.

   208

 */

   209

uint16 AircraftDefaultCargoCapacity(CargoID cid, const AircraftVehicleInfo *avi)

   210

{

   211

	assert(cid != CT_INVALID);

   212

   213

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

   214

	 * and four times as many passengers. */

   215

	switch (cid) {

   216

		case CT_PASSENGERS:

   217

			return avi->passenger_capacity;

   218

		case CT_MAIL:

   219

			return avi->passenger_capacity + avi->mail_capacity;

   220

		case CT_GOODS:

   221

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

   222

		default:

   223

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

   224

	}

   225

}

   226

   227

/** Build an aircraft.

   228

 * @param tile tile of depot where aircraft is built

   229

 * @param flags for command

   230

 * @param p1 aircraft type being built (engine)

   231

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

   232

 * return result of operation.  Could be cost, error

   233

 */

   234

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

   235

{

   236

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

   237

   238

	const AircraftVehicleInfo *avi = AircraftVehInfo(p1);

   239

	int32 value = EstimateAircraftCost(avi);

   240

   241

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

   242

	if (flags & DC_QUERY_COST) return value;

   243

   244

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

   245

   246

	SET_EXPENSES_TYPE(EXPENSES_NEW_VEHICLES);

   247

   248

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

   249

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

   250

   251

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

   252

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

   253

	Vehicle *vl[3];

   254

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

   255

		return_cmd_error(STR_00E1_TOO_MANY_VEHICLES_IN_GAME);

   256

	}

   257

   258

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

   259

	if (unit_num > _patches.max_aircraft)

   260

		return_cmd_error(STR_00E1_TOO_MANY_VEHICLES_IN_GAME);

   261

   262

	if (flags & DC_EXEC) {

   263

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

   264

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

   265

   266

		v->unitnumber = unit_num;

   267

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

   268

		v->direction = DIR_SE;

   269

   270

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

   271

   272

		v->tile = tile;

   273

//		u->tile = 0;

   274

   275

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

   276

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

   277

   278

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

   279

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

   280

   281

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

   282

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

   283

   284

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

   285

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

   286

   287

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

   288

		v->z_height = 5;

   289

   290

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

   291

		u->z_height = 1;

   292

   293

		v->vehstatus = VS_HIDDEN | VS_STOPPED | VS_DEFPAL;

   294

		u->vehstatus = VS_HIDDEN | VS_UNCLICKABLE | VS_SHADOW;

   295

   296

		v->spritenum = avi->image_index;

   297

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

   298

   299

		v->cargo_cap = avi->passenger_capacity;

   300

		u->cargo_cap = avi->mail_capacity;

   301

   302

		v->cargo_type = CT_PASSENGERS;

   303

		u->cargo_type = CT_MAIL;

   304

   305

		v->cargo_subtype = 0;

   306

   307

		v->string_id = STR_SV_AIRCRAFT_NAME;

   308

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

   309

   310

//		v->load_unload_time_rem = 0;

   311

//		v->progress = 0;

   312

		v->last_station_visited = INVALID_STATION;

   313

//		v->destination_coords = 0;

   314

   315

		v->max_speed = avi->max_speed;

   316

		v->acceleration = avi->acceleration;

   317

		v->engine_type = p1;

   318

   319

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

   320

		v->value = value;

   321

   322

		u->subtype = AIR_SHADOW;

   323

   324

		/* Danger, Will Robinson!

   325

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

   326

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

   327

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

   328

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

   329

		CargoID cargo = FindFirstRefittableCargo(p1);

   330

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

   331

			uint16 callback = CALLBACK_FAILED;

   332

   333

			v->cargo_type = cargo;

   334

   335

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

   336

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

   337

			}

   338

   339

			if (callback == CALLBACK_FAILED) {

   340

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

   341

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

   342

			} else {

   343

				v->cargo_cap = callback;

   344

			}

   345

   346

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

   347

			u->cargo_cap = 0;

   348

		}

   349

   350

		const Engine *e = GetEngine(p1);

   351

		v->reliability = e->reliability;

   352

		v->reliability_spd_dec = e->reliability_spd_dec;

   353

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

   354

   355

		_new_vehicle_id = v->index;

   356

   357

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

   358

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

   359

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

   360

		 * of all depots, it is simple */

   361

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

   362

			const Station *st = GetStationByTile(tile);

   363

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

   364

   365

			assert(i != apc->nof_depots);

   366

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

   367

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

   368

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

   369

				break;

   370

			}

   371

		}

   372

   373

		v->u.air.state = HANGAR;

   374

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

   375

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

   376

		v->next = u;

   377

   378

		v->service_interval = _patches.servint_aircraft;

   379

   380

		v->date_of_last_service = _date;

   381

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

   382

   383

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

   384

   385

		v->random_bits = VehicleRandomBits();

   386

		u->random_bits = VehicleRandomBits();

   387

   388

		v->vehicle_flags = 0;

   389

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

   390

   391

		VehiclePositionChanged(v);

   392

		VehiclePositionChanged(u);

   393

   394

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

   395

		if (v->subtype == AIR_HELICOPTER) {

   396

			Vehicle *w = vl[2];

   397

   398

			u->next = w;

   399

   400

			w->type = VEH_AIRCRAFT;

   401

			w->direction = DIR_N;

   402

			w->owner = _current_player;

   403

			w->x_pos = v->x_pos;

   404

			w->y_pos = v->y_pos;

   405

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

   406

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

   407

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

   408

			w->z_height = 1;

   409

			w->vehstatus = VS_HIDDEN | VS_UNCLICKABLE;

   410

			w->spritenum = 0xFF;

   411

			w->subtype = AIR_ROTOR;

   412

			w->cur_image = SPR_ROTOR_STOPPED;

   413

			w->random_bits = VehicleRandomBits();

   414

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

   415

			w->u.air.state = HRS_ROTOR_STOPPED;

   416

			VehiclePositionChanged(w);

   417

		}

   418

   419

		InvalidateWindowData(WC_VEHICLE_DEPOT, v->tile);

   420

		RebuildVehicleLists();

   421

		InvalidateWindow(WC_COMPANY, v->owner);

   422

		if (IsLocalPlayer())

   423

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

   424

   425

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

   426

	}

   427

   428

	return value;

   429

}

   430

   431

   432

static void DoDeleteAircraft(Vehicle *v)

   433

{

   434

	DeleteWindowById(WC_VEHICLE_VIEW, v->index);

   435

	RebuildVehicleLists();

   436

	InvalidateWindow(WC_COMPANY, v->owner);

   437

	DeleteDepotHighlightOfVehicle(v);

   438

	DeleteVehicleChain(v);

   439

	InvalidateWindowClasses(WC_AIRCRAFT_LIST);

   440

}

   441

   442

/** Sell an aircraft.

   443

 * @param tile unused

   444

 * @param flags for command type

   445

 * @param p1 vehicle ID to be sold

   446

 * @param p2 unused

   447

 * @return result of operation.  Error or sold value

   448

 */

   449

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

   450

{

   451

	if (!IsValidVehicleID(p1)) return CMD_ERROR;

   452

   453

	Vehicle *v = GetVehicle(p1);

   454

   455

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

   456

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

   457

   458

	SET_EXPENSES_TYPE(EXPENSES_NEW_VEHICLES);

   459

   460

	if (flags & DC_EXEC) {

   461

		// Invalidate depot

   462

		InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   463

		DoDeleteAircraft(v);

   464

	}

   465

   466

	return -(int32)v->value;

   467

}

   468

   469

/** Start/Stop an aircraft.

   470

 * @param tile unused

   471

 * @param flags for command type

   472

 * @param p1 aircraft ID to start/stop

   473

 * @param p2 unused

   474

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

   475

 */

   476

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

   477

{

   478

	if (!IsValidVehicleID(p1)) return CMD_ERROR;

   479

   480

	Vehicle *v = GetVehicle(p1);

   481

   482

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

   483

   484

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

   485

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

   486

		return_cmd_error(STR_A017_AIRCRAFT_IS_IN_FLIGHT);

   487

   488

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

   489

	 * return 0xFF if it can. */

   490

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

   491

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