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

    12

#include "station_map.h"

    13

#include "table/strings.h"

    14

#include "map.h"

    15

#include "tile.h"

    16

#include "vehicle.h"

    17

#include "depot.h"

    18

#include "engine.h"

    19

#include "command.h"

    20

#include "station.h"

    21

#include "news.h"

    22

#include "sound.h"

    23

#include "player.h"

    24

#include "aircraft.h"

    25

#include "airport.h"

    26

#include "vehicle_gui.h"

    27

#include "table/sprites.h"

    28

#include "newgrf_engine.h"

    29

#include "newgrf_callbacks.h"

    30

#include "newgrf_text.h"

    31

#include "newgrf_sound.h"

    32

#include "date.h"

    33

#include "spritecache.h"

    34

#include "cargotype.h"

    35

    65

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

    66

 *  currently set for 10 terms, 4 helipads */

    67

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

    68

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

    69

    70

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

    71

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

    72

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

    73

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

    74

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

    75

static void CrashAirplane(Vehicle *v);

    76

    77

static void AircraftNextAirportPos_and_Order(Vehicle *v);

    78

static byte GetAircraftFlyingAltitude(const Vehicle *v);

    79

    80

static const SpriteID _aircraft_sprite[] = {

    81

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

    82

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

    83

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

    84

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

    85

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

    86

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

    87

	0x0EBD, 0x0EC5

    88

};

    89

    90

/** Helicopter rotor animation states */

    91

enum HelicopterRotorStates {

    92

	HRS_ROTOR_STOPPED,

    93

	HRS_ROTOR_MOVING_1,

    94

	HRS_ROTOR_MOVING_2,

    95

	HRS_ROTOR_MOVING_3,

    96

};

    97

    98

/** Find the nearest hangar to v

    99

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

   100

 * airports (like helipads only)

   101

 * @param v vehicle looking for a hangar

   102

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

   103

 */

   104

static StationID FindNearestHangar(const Vehicle *v)

   105

{

   106

	const Station *st;

   107

	uint best = 0;

   108

	StationID index = INVALID_STATION;

   109

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

   110

   111

	FOR_ALL_STATIONS(st) {

   112

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

   113

   114

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

   115

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

   116

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

   117

					afc->flags & AirportFTAClass::SHORT_STRIP &&

   118

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

   119

					!_cheats.no_jetcrash.value

   120

				)) {

   121

			continue;

   122

		}

   123

   124

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

   125

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

   126

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

   127

			best = distance;

   128

			index = st->index;

   129

		}

   130

	}

   131

	return index;

   132

}

   133

   134

#if 0

   135

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

   136

 * @param v vehicle to inquiry

   137

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

   138

static bool HaveHangarInOrderList(Vehicle *v)

   139

{

   140

	const Order *order;

   141

   142

	FOR_VEHICLE_ORDERS(v, order) {

   143

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

   144

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

   145

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

   146

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

   147

				return true;

   148

		}

   149

	}

   150

   151

	return false;

   152

}

   153

#endif

   154

   155

int GetAircraftImage(const Vehicle* v, Direction direction)

   156

{

   157

	int spritenum = v->spritenum;

   158

   159

	if (is_custom_sprite(spritenum)) {

   160

		int sprite = GetCustomVehicleSprite(v, direction);

   161

   162

		if (sprite != 0) return sprite;

   163

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

   164

	}

   165

	return direction + _aircraft_sprite[spritenum];

   166

}

   167

   168

SpriteID GetRotorImage(const Vehicle *v)

   169

{

   170

	assert(v->subtype == AIR_HELICOPTER);

   171

   172

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

   173

	if (is_custom_sprite(v->spritenum)) {

   174

		SpriteID spritenum = GetCustomRotorSprite(v, false);

   175

		if (spritenum != 0) return spritenum;

   176

	}

   177

   178

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

   179

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

   180

}

   181

   182

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

   183

{

   184

	const AircraftVehicleInfo* avi = AircraftVehInfo(engine);

   185

	int spritenum = avi->image_index;

   186

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

   187

   188

	if (is_custom_sprite(spritenum)) {

   189

		sprite = GetCustomVehicleIcon(engine, DIR_W);

   190

		if (sprite == 0) {

   191

			spritenum = orig_aircraft_vehicle_info[engine - AIRCRAFT_ENGINES_INDEX].image_index;

   192

			sprite = (6 + _aircraft_sprite[spritenum]);

   193

		}

   194

	}

   195

   196

	DrawSprite(sprite, pal, x, y);

   197

   198

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

   199

		SpriteID rotor_sprite = GetCustomRotorIcon(engine);

   200

		if (rotor_sprite == 0) rotor_sprite = SPR_ROTOR_STOPPED;

   201

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

   202

	}

   203

}

   204

   205

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

   206

 * @param engine The engine to get the sprite from

   207

 * @param width The width of the sprite

   208

 * @param height The height of the sprite

   209

 */

   210

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

   211

{

   212

	const AircraftVehicleInfo* avi = AircraftVehInfo(engine);

   213

	int spritenum = avi->image_index;

   214

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

   215

   216

	if (is_custom_sprite(spritenum)) {

   217

		sprite = GetCustomVehicleIcon(engine, DIR_W);

   218

		if (sprite == 0) {

   219

			spritenum = orig_aircraft_vehicle_info[engine - AIRCRAFT_ENGINES_INDEX].image_index;

   220

			sprite = (6 + _aircraft_sprite[spritenum]);

   221

		}

   222

	}

   223

   224

	const Sprite *spr = GetSprite(sprite);

   225

   226

	width  = spr->width ;

   227

	height = spr->height;

   228

}

   229

   231

{

   233

}

   234

   235

   236

/**

   237

 * Calculates cargo capacity based on an aircraft's passenger

   238

 * and mail capacities.

   239

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

   240

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

   241

 * @return New cargo capacity value.

   242

 */

   243

uint16 AircraftDefaultCargoCapacity(CargoID cid, const AircraftVehicleInfo *avi)

   244

{

   245

	assert(cid != CT_INVALID);

   246

   247

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

   248

	 * and four times as many passengers. */

   249

	switch (cid) {

   250

		case CT_PASSENGERS:

   251

			return avi->passenger_capacity;

   252

		case CT_MAIL:

   253

			return avi->passenger_capacity + avi->mail_capacity;

   254

		case CT_GOODS:

   255

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

   256

		default:

   257

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

   258

	}

   259

}

   260

   261

/** Build an aircraft.

   262

 * @param tile tile of depot where aircraft is built

   263

 * @param flags for command

   264

 * @param p1 aircraft type being built (engine)

   265

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

   266

 * return result of operation.  Could be cost, error

   267

 */

   268

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

   269

{

   270

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

   271

   272

	const AircraftVehicleInfo *avi = AircraftVehInfo(p1);

   274

   275

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

   276

	if (flags & DC_QUERY_COST) return value;

   277

   278

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

   279

   280

	SET_EXPENSES_TYPE(EXPENSES_NEW_VEHICLES);

   281

   282

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

   283

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

   284

   285

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

   286

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

   287

	Vehicle *vl[3];

   288

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

   289

		return_cmd_error(STR_00E1_TOO_MANY_VEHICLES_IN_GAME);

   290

	}

   291

   292

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

   293

	if (unit_num > _patches.max_aircraft)

   294

		return_cmd_error(STR_00E1_TOO_MANY_VEHICLES_IN_GAME);

   295

   296

	if (flags & DC_EXEC) {

   297

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

   298

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

   299

   300

		v->unitnumber = unit_num;

   303

		v->direction = DIR_SE;

   304

   305

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

   306

   307

		v->tile = tile;

   308

//		u->tile = 0;

   309

   310

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

   311

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

   312

   313

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

   314

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

   315

   316

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

   317

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

   318

   319

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

   320

   321

		v->vehstatus = VS_HIDDEN | VS_STOPPED | VS_DEFPAL;

   322

		u->vehstatus = VS_HIDDEN | VS_UNCLICKABLE | VS_SHADOW;

   323

   324

		v->spritenum = avi->image_index;

   325

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

   326

   327

		v->cargo_cap = avi->passenger_capacity;

   328

		u->cargo_cap = avi->mail_capacity;

   329

   330

		v->cargo_type = CT_PASSENGERS;

   331

		u->cargo_type = CT_MAIL;

   332

   333

		v->cargo_subtype = 0;

   334

   335

		v->string_id = STR_SV_AIRCRAFT_NAME;

   336

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

   337

   338

//		v->load_unload_time_rem = 0;

   339

//		v->progress = 0;

   340

		v->last_station_visited = INVALID_STATION;

   341

//		v->destination_coords = 0;

   342

   343

		v->max_speed = avi->max_speed;

   344

		v->acceleration = avi->acceleration;

   345

		v->engine_type = p1;

   346

   347

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

   349

		v->value = value;

   350

   351

		u->subtype = AIR_SHADOW;

   353

   354

		/* Danger, Will Robinson!

   355

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

   356

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

   357

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

   358

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

   359

		CargoID cargo = FindFirstRefittableCargo(p1);

   360

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

   361

			uint16 callback = CALLBACK_FAILED;

   362

   363

			v->cargo_type = cargo;

   364

   365

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

   366

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

   367

			}

   368

   369

			if (callback == CALLBACK_FAILED) {

   370

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

   371

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

   372

			} else {

   373

				v->cargo_cap = callback;

   374

			}

   375

   376

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

   377

			u->cargo_cap = 0;

   378

		}

   379

   380

		const Engine *e = GetEngine(p1);

   381

		v->reliability = e->reliability;

   382

		v->reliability_spd_dec = e->reliability_spd_dec;

   383

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

   384

   385

		_new_vehicle_id = v->index;

   386

   387

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

   388

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

   389

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

   390

		 * of all depots, it is simple */

   391

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

   392

			const Station *st = GetStationByTile(tile);

   393

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

   394

   395

			assert(i != apc->nof_depots);

   396

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

   397

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

   398

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

   399

				break;

   400

			}

   401

		}

   402

   403

		v->u.air.state = HANGAR;

   404

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

   405

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

   406

		v->next = u;

   407

   408

		v->service_interval = _patches.servint_aircraft;

   409

   410

		v->date_of_last_service = _date;

   411

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

   412

   413

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

   414

   415

		v->random_bits = VehicleRandomBits();

   416

		u->random_bits = VehicleRandomBits();

   417

   418

		v->vehicle_flags = 0;

   419

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

   420

   421

		UpdateAircraftCache(v);

   422

   423

		VehiclePositionChanged(v);

   424

		VehiclePositionChanged(u);

   425

   426

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

   427

		if (v->subtype == AIR_HELICOPTER) {

   428

			Vehicle *w = vl[2];

   429

   430

			u->next = w;

   431

   433

			w->direction = DIR_N;

   434

			w->owner = _current_player;

   435

			w->x_pos = v->x_pos;

   436

			w->y_pos = v->y_pos;

   437

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

   438

			w->vehstatus = VS_HIDDEN | VS_UNCLICKABLE;

   439

			w->spritenum = 0xFF;

   440

			w->subtype = AIR_ROTOR;

   441

			w->cur_image = SPR_ROTOR_STOPPED;

   442

			w->random_bits = VehicleRandomBits();

   443

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

   444

			w->u.air.state = HRS_ROTOR_STOPPED;

   446

			VehiclePositionChanged(w);

   447

		}

   448

   449

		InvalidateWindowData(WC_VEHICLE_DEPOT, v->tile);

   450

		RebuildVehicleLists();

   451

		InvalidateWindow(WC_COMPANY, v->owner);

   452

		if (IsLocalPlayer())

   453

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

   454

   455

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

   456

	}

   457

   458

	return value;

   459

}

   460

   461

   462

static void DoDeleteAircraft(Vehicle *v)

   463

{

   464

	DeleteWindowById(WC_VEHICLE_VIEW, v->index);

   465

	RebuildVehicleLists();

   466

	InvalidateWindow(WC_COMPANY, v->owner);

   467

	DeleteDepotHighlightOfVehicle(v);

   468

	DeleteVehicleChain(v);

   469

	InvalidateWindowClasses(WC_AIRCRAFT_LIST);

   470

}

   471

   472

/** Sell an aircraft.

   473

 * @param tile unused

   474

 * @param flags for command type

   475

 * @param p1 vehicle ID to be sold

   476

 * @param p2 unused

   477

 * @return result of operation.  Error or sold value

   478

 */

   479

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

   480

{

   481

	if (!IsValidVehicleID(p1)) return CMD_ERROR;

   482

   483

	Vehicle *v = GetVehicle(p1);

   484

   485

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

   486

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

   487

   488

	SET_EXPENSES_TYPE(EXPENSES_NEW_VEHICLES);

   489

   490

	if (flags & DC_EXEC) {