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

    14

#include "table/strings.h"

    15

#include "map.h"

    16

#include "tile.h"

    17

#include "vehicle.h"

    18

#include "timetable.h"

    19

#include "depot.h"

    20

#include "engine.h"

    21

#include "command.h"

    22

#include "station.h"

    23

#include "news.h"

    24

#include "sound.h"

    25

#include "player.h"

    26

#include "aircraft.h"

    27

#include "airport.h"

    28

#include "vehicle_gui.h"

    29

#include "table/sprites.h"

    30

#include "newgrf_engine.h"

    31

#include "newgrf_callbacks.h"

    32

#include "newgrf_text.h"

    33

#include "newgrf_sound.h"

    34

#include "date.h"

    35

#include "spritecache.h"

    36

#include "cargotype.h"

    37

    38

void Aircraft::UpdateDeltaXY(Direction direction)

    39

{

    40

	uint32 x;

    41

#define MKIT(a, b, c, d) ((a & 0xFF) << 24) | ((b & 0xFF) << 16) | ((c & 0xFF) << 8) | ((d & 0xFF) << 0)

    42

	switch (this->subtype) {

    43

		default: NOT_REACHED();

    44

		case AIR_AIRCRAFT:

    45

		case AIR_HELICOPTER:

    46

			switch (this->u.air.state) {

    47

				case ENDTAKEOFF:

    48

				case LANDING:

    49

				case HELILANDING:

    50

				case FLYING:     x = MKIT(24, 24, -1, -1); break;

    51

				default:         x = MKIT( 2,  2, -1, -1); break;

    52

			}

    53

			this->z_height = 5;

    54

			break;

    55

		case AIR_SHADOW:     this->z_height = 1; x = MKIT(2,  2,  0,  0); break;

    56

		case AIR_ROTOR:      this->z_height = 1; x = MKIT(2,  2, -1, -1); break;

    57

	}

    58

#undef MKIT

    59

    60

	this->x_offs        = GB(x,  0, 8);

    61

	this->y_offs        = GB(x,  8, 8);

    62

	this->sprite_width  = GB(x, 16, 8);

    63

	this->sprite_height = GB(x, 24, 8);

    64

}

    65

    66

    67

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

    68

 *  currently set for 10 terms, 4 helipads */

    69

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

    70

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

    71

    72

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

    73

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

    74

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

    75

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

    76

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

    77

static void CrashAirplane(Vehicle *v);

    78

    79

static void AircraftNextAirportPos_and_Order(Vehicle *v);

    80

static byte GetAircraftFlyingAltitude(const Vehicle *v);

    81

    82

static const SpriteID _aircraft_sprite[] = {

    83

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

    84

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

    85

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

    86

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

    87

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

    88

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

    89

	0x0EBD, 0x0EC5

    90

};

    91

    92

/** Helicopter rotor animation states */

    93

enum HelicopterRotorStates {

    94

	HRS_ROTOR_STOPPED,

    95

	HRS_ROTOR_MOVING_1,

    96

	HRS_ROTOR_MOVING_2,

    97

	HRS_ROTOR_MOVING_3,

    98

};

    99

   100

/** Find the nearest hangar to v

   101

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

   102

 * airports (like helipads only)

   103

 * @param v vehicle looking for a hangar

   104

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

   105

 */

   106

static StationID FindNearestHangar(const Vehicle *v)

   107

{

   108

	const Station *st;

   109

	uint best = 0;

   110

	StationID index = INVALID_STATION;

   111

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

   112

   113

	FOR_ALL_STATIONS(st) {

   114

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

   115

   116

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

   117

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

   118

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

   119

					afc->flags & AirportFTAClass::SHORT_STRIP &&

   120

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

   121

					!_cheats.no_jetcrash.value

   122

				)) {

   123

			continue;

   124

		}

   125

   126

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

   127

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

   128

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

   129

			best = distance;

   130

			index = st->index;

   131

		}

   132

	}

   133

	return index;

   134

}

   135

   136

#if 0

   137

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

   138

 * @param v vehicle to inquiry

   139

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

   140

static bool HaveHangarInOrderList(Vehicle *v)

   141

{

   142

	const Order *order;

   143

   144

	FOR_VEHICLE_ORDERS(v, order) {

   145

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

   146

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

   147

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

   148

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

   149

				return true;

   150

		}

   151

	}

   152

   153

	return false;

   154

}

   155

#endif

   156

   157

int Aircraft::GetImage(Direction direction) const

   158

{

   159

	int spritenum = this->spritenum;

   160

   161

	if (is_custom_sprite(spritenum)) {

   162

		int sprite = GetCustomVehicleSprite(this, direction);

   163

   164

		if (sprite != 0) return sprite;

   165

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

   166

	}

   167

	return direction + _aircraft_sprite[spritenum];

   168

}

   169

   170

SpriteID GetRotorImage(const Vehicle *v)

   171

{

   172

	assert(v->subtype == AIR_HELICOPTER);

   173

   174

	const Vehicle *w = v->Next()->Next();

   175

	if (is_custom_sprite(v->spritenum)) {

   176

		SpriteID spritenum = GetCustomRotorSprite(v, false);

   177

		if (spritenum != 0) return spritenum;

   178

	}

   179

   180

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

   181

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

   182

}

   183

   184

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

   185

{

   186

	const AircraftVehicleInfo* avi = AircraftVehInfo(engine);

   187

	int spritenum = avi->image_index;

   188

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

   189

   190

	if (is_custom_sprite(spritenum)) {

   191

		sprite = GetCustomVehicleIcon(engine, DIR_W);

   192

		if (sprite == 0) {

   193

			spritenum = orig_aircraft_vehicle_info[engine - AIRCRAFT_ENGINES_INDEX].image_index;

   194

			sprite = (6 + _aircraft_sprite[spritenum]);

   195

		}

   196

	}

   197

   198

	DrawSprite(sprite, pal, x, y);

   199

   200

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

   201

		SpriteID rotor_sprite = GetCustomRotorIcon(engine);

   202

		if (rotor_sprite == 0) rotor_sprite = SPR_ROTOR_STOPPED;

   203

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

   204

	}

   205

}

   206

   207

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

   208

 * @param engine The engine to get the sprite from

   209

 * @param width The width of the sprite

   210

 * @param height The height of the sprite

   211

 */

   212

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

   213

{

   214

	const AircraftVehicleInfo* avi = AircraftVehInfo(engine);

   215

	int spritenum = avi->image_index;

   216

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

   217

   218

	if (is_custom_sprite(spritenum)) {

   219

		sprite = GetCustomVehicleIcon(engine, DIR_W);

   220

		if (sprite == 0) {

   221

			spritenum = orig_aircraft_vehicle_info[engine - AIRCRAFT_ENGINES_INDEX].image_index;

   222

			sprite = (6 + _aircraft_sprite[spritenum]);

   223

		}

   224

	}

   225

   226

	const Sprite *spr = GetSprite(sprite);

   227

   228

	width  = spr->width ;

   229

	height = spr->height;

   230

}

   231

   232

static CommandCost EstimateAircraftCost(EngineID engine, const AircraftVehicleInfo *avi)

   233

{

   234

	return CommandCost(GetEngineProperty(engine, 0x0B, avi->base_cost) * (_price.aircraft_base >> 3) >> 5);

   235

}

   236

   237

   238

/**

   239

 * Calculates cargo capacity based on an aircraft's passenger

   240

 * and mail capacities.

   241

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

   242

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

   243

 * @return New cargo capacity value.

   244

 */

   245

uint16 AircraftDefaultCargoCapacity(CargoID cid, const AircraftVehicleInfo *avi)

   246

{

   247

	assert(cid != CT_INVALID);

   248

   249

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

   250

	 * and four times as many passengers. */

   251

	switch (cid) {

   252

		case CT_PASSENGERS:

   253

			return avi->passenger_capacity;

   254

		case CT_MAIL:

   255

			return avi->passenger_capacity + avi->mail_capacity;

   256

		case CT_GOODS:

   257

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

   258

		default:

   259

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

   260

	}

   261

}

   262

   263

/** Build an aircraft.

   264

 * @param tile tile of depot where aircraft is built

   265

 * @param flags for command

   266

 * @param p1 aircraft type being built (engine)

   267

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

   268

 * return result of operation.  Could be cost, error

   269

 */

   270

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

   271

{

   272

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

   273

   274

	const AircraftVehicleInfo *avi = AircraftVehInfo(p1);

   275

	CommandCost value = EstimateAircraftCost(p1, avi);

   276

   277

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

   278

	if (flags & DC_QUERY_COST) return value;

   279

   280

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

   281

   282

	SET_EXPENSES_TYPE(EXPENSES_NEW_VEHICLES);

   283

   284

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

   285

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

   286

   287

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

   288

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

   289

	Vehicle *vl[3];

   290

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

   291

		return_cmd_error(STR_00E1_TOO_MANY_VEHICLES_IN_GAME);

   292

	}

   293

   294

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

   295

	if (unit_num > _patches.max_aircraft)

   296

		return_cmd_error(STR_00E1_TOO_MANY_VEHICLES_IN_GAME);

   297

   298

	if (flags & DC_EXEC) {

   299

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

   300

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

   301

   302

		v->unitnumber = unit_num;

   303

		v = new (v) Aircraft();

   304

		u = new (u) Aircraft();

   305

		v->direction = DIR_SE;

   306

   307

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

   308

   309

		v->tile = tile;

   310

//		u->tile = 0;

   311

   312

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

   313

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

   314

   315

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

   316

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

   317

   318

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

   319

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

   320

   321

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

   322

   323

		v->vehstatus = VS_HIDDEN | VS_STOPPED | VS_DEFPAL;

   324

		u->vehstatus = VS_HIDDEN | VS_UNCLICKABLE | VS_SHADOW;

   325

   326

		v->spritenum = avi->image_index;

   327

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

   328

   329

		v->cargo_cap = avi->passenger_capacity;

   330

		u->cargo_cap = avi->mail_capacity;

   331

   332

		v->cargo_type = CT_PASSENGERS;

   333

		u->cargo_type = CT_MAIL;

   334

   335

		v->cargo_subtype = 0;

   336

   337

		v->string_id = STR_SV_AIRCRAFT_NAME;

   338

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

   339

   340

//		v->load_unload_time_rem = 0;

   341

//		v->progress = 0;

   342

		v->last_station_visited = INVALID_STATION;

   343

//		v->destination_coords = 0;

   344

   345

		v->max_speed = avi->max_speed;

   346

		v->acceleration = avi->acceleration;

   347

		v->engine_type = p1;

   348

   349

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

   350

		v->UpdateDeltaXY(INVALID_DIR);

   351

		v->value = value.GetCost();

   352

   353

		u->subtype = AIR_SHADOW;

   354

		u->UpdateDeltaXY(INVALID_DIR);

   355

   356

		/* Danger, Will Robinson!

   357

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

   358

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

   359

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

   360

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

   361

		CargoID cargo = FindFirstRefittableCargo(p1);

   362

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

   363

			uint16 callback = CALLBACK_FAILED;

   364

   365

			v->cargo_type = cargo;

   366

   367

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

   368

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

   369

			}

   370

   371

			if (callback == CALLBACK_FAILED) {

   372

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

   373

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

   374

			} else {

   375

				v->cargo_cap = callback;

   376

			}

   377

   378

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

   379

			u->cargo_cap = 0;

   380

		}

   381

   382

		const Engine *e = GetEngine(p1);

   383

		v->reliability = e->reliability;

   384

		v->reliability_spd_dec = e->reliability_spd_dec;

   385

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

   386

   387

		_new_vehicle_id = v->index;

   388

   389

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

   390

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

   391

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

   392

		 * of all depots, it is simple */

   393

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

   394

			const Station *st = GetStationByTile(tile);

   395

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

   396

   397

			assert(i != apc->nof_depots);

   398

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

   399

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

   400

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

   401

				break;

   402

			}

   403

		}

   404

   405

		v->u.air.state = HANGAR;

   406

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

   407

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

   408

		v->SetNext(u);

   409

   410

		v->service_interval = _patches.servint_aircraft;

   411

   412

		v->date_of_last_service = _date;

   413

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

   414

   415

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

   416

   417

		v->random_bits = VehicleRandomBits();

   418

		u->random_bits = VehicleRandomBits();

   419

   420

		v->vehicle_flags = 0;

   421

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

   422

   423

		UpdateAircraftCache(v);

   424

   425

		VehiclePositionChanged(v);

   426

		VehiclePositionChanged(u);

   427

   428

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

   429

		if (v->subtype == AIR_HELICOPTER) {

   430

			Vehicle *w = vl[2];

   431

   432

			w = new (w) Aircraft();

   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;

   445

			w->UpdateDeltaXY(INVALID_DIR);

   446

   447

			u->SetNext(w);

   448

			VehiclePositionChanged(w);

   449

		}

   450

   451

		InvalidateWindowData(WC_VEHICLE_DEPOT, v->tile);

   452

		RebuildVehicleLists();

   453

		InvalidateWindow(WC_COMPANY, v->owner);

   454

		if (IsLocalPlayer())

   455

			InvalidateAutoreplaceWindow(v->engine_type, v->group_id); //updates the replace Aircraft window

   456

   457

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

   458

	}

   459

   460

	return value;

   461

}

   462

   463

   464

static void DoDeleteAircraft(Vehicle *v)

   465

{

   466

	DeleteWindowById(WC_VEHICLE_VIEW, v->index);

   467

	RebuildVehicleLists();

   468

	InvalidateWindow(WC_COMPANY, v->owner);

   469

	DeleteDepotHighlightOfVehicle(v);

   470

	DeleteVehicleChain(v);

   471

	InvalidateWindowClasses(WC_AIRCRAFT_LIST);

   472

}

   473

   474

/** Sell an aircraft.

   475

 * @param tile unused

   476

 * @param flags for command type

   477

 * @param p1 vehicle ID to be sold

   478

 * @param p2 unused

   479

 * @return result of operation.  Error or sold value

   480

 */

   481

CommandCost CmdSellAircraft(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

	if (!v->IsStoppedInDepot()) return_cmd_error(STR_A01B_AIRCRAFT_MUST_BE_STOPPED);

   489