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"

    18

#include "depot.h"

    19

#include "engine.h"

    20

#include "command.h"

    21

#include "station.h"

    22

#include "news.h"

    23

#include "sound.h"

    24

#include "player.h"

    25

#include "aircraft.h"

    26

#include "airport.h"

    27

#include "vehicle_gui.h"

    28

#include "table/sprites.h"

    29

#include "newgrf_engine.h"

    30

#include "newgrf_callbacks.h"

    31

#include "newgrf_text.h"

    32

#include "newgrf_sound.h"

    33

#include "date.h"

    34

#include "spritecache.h"

    35

#include "cargotype.h"

    36

#include "airport_states.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

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

    67

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

    68

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

    69

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

    70

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

    71

static void CrashAirplane(Vehicle *v);

    72

    73

static void AircraftNextAirportPos_and_Order(Vehicle *v);

    74

static byte GetAircraftFlyingAltitude(const Vehicle *v);

    75

    76

static const SpriteID _aircraft_sprite[] = {

    77

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

    78

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

    79

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

    80

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

    81

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

    82

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

    83

	0x0EBD, 0x0EC5

    84

};

    85

    86

/** Helicopter rotor animation states */

    87

enum HelicopterRotorStates {

    88

	HRS_ROTOR_STOPPED,

    89

	HRS_ROTOR_MOVING_1,

    90

	HRS_ROTOR_MOVING_2,

    91

	HRS_ROTOR_MOVING_3,

    92

};

    93

    94

/** Find the nearest hangar to v

    95

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

    96

 * airports (like helipads only)

    97

 * @param v vehicle looking for a hangar

    98

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

    99

 */

   100

static StationID FindNearestHangar(const Vehicle *v)

   101

{

   102

	const Station *st;

   103

	uint best = 0;

   104

	StationID index = INVALID_STATION;

   105

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

   106

   107

	FOR_ALL_STATIONS(st) {

   108

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

   109

   110

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

   111

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

   112

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

   113

					afc->flags & AirportFTAClass::SHORT_STRIP &&

   114

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

   115

					!_cheats.no_jetcrash.value

   116

				)) {

   117

			continue;

   118

		}

   119

   120

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

   121

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

   122

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

   123

			best = distance;

   124

			index = st->index;

   125

		}

   126

	}

   127

	return index;

   128

}

   129

   130

#if 0

   131

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

   132

 * @param v vehicle to inquiry

   133

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

   134

static bool HaveHangarInOrderList(Vehicle *v)

   135

{

   136

	const Order *order;

   137

   138

	FOR_VEHICLE_ORDERS(v, order) {

   139

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

   140

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

   141

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

   142

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

   143

				return true;

   144

		}

   145

	}

   146

   147

	return false;

   148

}

   149

#endif

   150

   152

{

   154

   155

	if (is_custom_sprite(spritenum)) {

   157

   158

		if (sprite != 0) return sprite;

   160

	}

   161

	return direction + _aircraft_sprite[spritenum];

   162

}

   163

   164

SpriteID GetRotorImage(const Vehicle *v)

   165

{

   166

	assert(v->subtype == AIR_HELICOPTER);

   167

   168

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

   169

	if (is_custom_sprite(v->spritenum)) {

   170

		SpriteID spritenum = GetCustomRotorSprite(v, false);

   171

		if (spritenum != 0) return spritenum;

   172

	}

   173

   174

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

   175

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

   176

}

   177

   178

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

   179

{

   180

	const AircraftVehicleInfo* avi = AircraftVehInfo(engine);

   181

	int spritenum = avi->image_index;

   182

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

   183

   184

	if (is_custom_sprite(spritenum)) {

   185

		sprite = GetCustomVehicleIcon(engine, DIR_W);

   186

		if (sprite == 0) {

   187

			spritenum = orig_aircraft_vehicle_info[engine - AIRCRAFT_ENGINES_INDEX].image_index;

   188

			sprite = (6 + _aircraft_sprite[spritenum]);

   189

		}

   190

	}

   191

   192

	DrawSprite(sprite, pal, x, y);

   193

   194

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

   195

		SpriteID rotor_sprite = GetCustomRotorIcon(engine);

   196

		if (rotor_sprite == 0) rotor_sprite = SPR_ROTOR_STOPPED;

   197

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

   198

	}

   199

}

   200

   201

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

   202

 * @param engine The engine to get the sprite from

   203

 * @param width The width of the sprite

   204

 * @param height The height of the sprite

   205

 */

   206

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

   207

{

   208

	const AircraftVehicleInfo* avi = AircraftVehInfo(engine);

   209

	int spritenum = avi->image_index;

   210

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

   211

   212

	if (is_custom_sprite(spritenum)) {

   213

		sprite = GetCustomVehicleIcon(engine, DIR_W);

   214

		if (sprite == 0) {

   215

			spritenum = orig_aircraft_vehicle_info[engine - AIRCRAFT_ENGINES_INDEX].image_index;

   216

			sprite = (6 + _aircraft_sprite[spritenum]);

   217

		}

   218

	}

   219

   220

	const Sprite *spr = GetSprite(sprite);

   221

   222

	width  = spr->width ;

   223

	height = spr->height;

   224

}

   225

   227

{

   229

}

   230

   231

   232

/**

   233

 * Calculates cargo capacity based on an aircraft's passenger

   234

 * and mail capacities.

   235

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

   236

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

   237

 * @return New cargo capacity value.

   238

 */

   239

uint16 AircraftDefaultCargoCapacity(CargoID cid, const AircraftVehicleInfo *avi)

   240

{

   241

	assert(cid != CT_INVALID);

   242

   243

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

   244

	 * and four times as many passengers. */

   245

	switch (cid) {

   246

		case CT_PASSENGERS:

   247

			return avi->passenger_capacity;

   248

		case CT_MAIL:

   249

			return avi->passenger_capacity + avi->mail_capacity;

   250

		case CT_GOODS:

   251

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

   252

		default:

   253

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

   254

	}

   255

}

   256

   257

/** Build an aircraft.

   258

 * @param tile tile of depot where aircraft is built

   259

 * @param flags for command

   260

 * @param p1 aircraft type being built (engine)

   261

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

   262

 * return result of operation.  Could be cost, error

   263

 */

   265

{

   266

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

   267

   268

	const AircraftVehicleInfo *avi = AircraftVehInfo(p1);

   270

   271

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

   272

	if (flags & DC_QUERY_COST) return value;

   273

   274

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

   275

   276

	SET_EXPENSES_TYPE(EXPENSES_NEW_VEHICLES);

   277

   278

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

   279

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

   280

   281

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

   282

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

   283

	Vehicle *vl[3];

   284

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

   285

		return_cmd_error(STR_00E1_TOO_MANY_VEHICLES_IN_GAME);

   286

	}

   287

   288

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

   289

	if (unit_num > _patches.max_aircraft)

   290

		return_cmd_error(STR_00E1_TOO_MANY_VEHICLES_IN_GAME);

   291

   292

	if (flags & DC_EXEC) {

   293

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

   294

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

   295

   296

		v->unitnumber = unit_num;

   297

		v = new (v) Aircraft();

   298

		u = new (u) Aircraft();

   299

		v->direction = DIR_SE;

   300

   301

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

   302

   303

		v->tile = tile;

   304

//		u->tile = 0;

   305

   306

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

   307

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

   308

   309

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

   310

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

   311

   312

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

   313

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

   314

   315

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

   316

   317

		v->vehstatus = VS_HIDDEN | VS_STOPPED | VS_DEFPAL;

   318

		u->vehstatus = VS_HIDDEN | VS_UNCLICKABLE | VS_SHADOW;

   319

   320

		v->spritenum = avi->image_index;

   321

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

   322

   323

		v->cargo_cap = avi->passenger_capacity;

   324

		u->cargo_cap = avi->mail_capacity;

   325

   326

		v->cargo_type = CT_PASSENGERS;

   327

		u->cargo_type = CT_MAIL;

   328

   329

		v->cargo_subtype = 0;

   330

   331

		v->string_id = STR_SV_AIRCRAFT_NAME;

   332

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

   333

   334

//		v->load_unload_time_rem = 0;

   335

//		v->progress = 0;

   336

		v->last_station_visited = INVALID_STATION;

   337

//		v->destination_coords = 0;

   338

   339

		v->max_speed = avi->max_speed;

   340

		v->acceleration = avi->acceleration;

   341

		v->engine_type = p1;

   342

   343

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

   344

		v->UpdateDeltaXY(INVALID_DIR);

   346

   347

		u->subtype = AIR_SHADOW;

   348

		u->UpdateDeltaXY(INVALID_DIR);

   349

   350

		/* Danger, Will Robinson!

   351

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

   352

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

   353

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

   354

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

   355

		CargoID cargo = FindFirstRefittableCargo(p1);

   356

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

   357

			uint16 callback = CALLBACK_FAILED;

   358

   359

			v->cargo_type = cargo;

   360

   361

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

   362

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

   363

			}

   364

   365

			if (callback == CALLBACK_FAILED) {

   366

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

   367

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

   368

			} else {

   369

				v->cargo_cap = callback;

   370

			}

   371

   372

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

   373

			u->cargo_cap = 0;

   374

		}

   375

   376

		const Engine *e = GetEngine(p1);

   377

		v->reliability = e->reliability;

   378

		v->reliability_spd_dec = e->reliability_spd_dec;

   379

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

   380

   381

		_new_vehicle_id = v->index;

   382

   383

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

   384

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

   385

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

   386

		 * of all depots, it is simple */

   387

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

   388

			const Station *st = GetStationByTile(tile);

   389

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

   390

   391

			assert(i != apc->nof_depots);

   392

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

   393

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

   394

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

   395

				break;

   396

			}

   397

		}

   398

   399

		v->u.air.state = HANGAR;

   400

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

   401

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

   402

		v->next = u;

   403

   404

		v->service_interval = _patches.servint_aircraft;

   405

   406

		v->date_of_last_service = _date;

   407

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

   408

   409

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

   410

   411

		v->random_bits = VehicleRandomBits();

   412

		u->random_bits = VehicleRandomBits();

   413

   414

		v->vehicle_flags = 0;

   415

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

   416

   417

		UpdateAircraftCache(v);

   418

   419

		VehiclePositionChanged(v);

   420

		VehiclePositionChanged(u);

   421

   422

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

   423

		if (v->subtype == AIR_HELICOPTER) {

   424

			Vehicle *w = vl[2];

   425

   426

			u->next = w;

   427

   428

			w = new (w) Aircraft();

   429

			w->direction = DIR_N;

   430

			w->owner = _current_player;

   431

			w->x_pos = v->x_pos;

   432

			w->y_pos = v->y_pos;

   433

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

   434

			w->vehstatus = VS_HIDDEN | VS_UNCLICKABLE;

   435

			w->spritenum = 0xFF;

   436

			w->subtype = AIR_ROTOR;

   437

			w->cur_image = SPR_ROTOR_STOPPED;

   438

			w->random_bits = VehicleRandomBits();

   439

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

   440

			w->u.air.state = HRS_ROTOR_STOPPED;

   441

			w->UpdateDeltaXY(INVALID_DIR);

   442

			VehiclePositionChanged(w);

   443

		}

   444

   445

		InvalidateWindowData(WC_VEHICLE_DEPOT, v->tile);

   446

		RebuildVehicleLists();

   447

		InvalidateWindow(WC_COMPANY, v->owner);

   448

		if (IsLocalPlayer())

   450

   451

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

   452

	}

   453

   454

	return value;

   455

}

   456

   457

   458

static void DoDeleteAircraft(Vehicle *v)

   459

{

   460

	DeleteWindowById(WC_VEHICLE_VIEW, v->index);

   461

	RebuildVehicleLists();

   462

	InvalidateWindow(WC_COMPANY, v->owner);

   463

	DeleteDepotHighlightOfVehicle(v);

   464

	DeleteVehicleChain(v);

   465

	InvalidateWindowClasses(WC_AIRCRAFT_LIST);

   466

}

   467

   468

/** Sell an aircraft.

   469

 * @param tile unused

   470

 * @param flags for command type

   471

 * @param p1 vehicle ID to be sold

   472

 * @param p2 unused

   473

 * @return result of operation.  Error or sold value

   474

 */

   476

{

   477

	if (!IsValidVehicleID(p1)) return CMD_ERROR;

   478

   479

	Vehicle *v = GetVehicle(p1);

   480

   481

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

   482

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

   483

   484

	SET_EXPENSES_TYPE(EXPENSES_NEW_VEHICLES);

   485

   486

	if (flags & DC_EXEC) {

   487

		// Invalidate depot

   488

		InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   489

		DoDeleteAircraft(v);

   490

	}