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

    11

#include "station_map.h"

    12

#include "table/strings.h"

    13

#include "timetable.h"

    14

#include "depot.h"

    15

#include "engine.h"

    16

#include "station.h"

    17

#include "news.h"

    18

#include "player.h"

    19

#include "aircraft.h"

    20

#include "airport.h"

    21

#include "vehicle_gui.h"

    22

#include "table/sprites.h"

    23

#include "newgrf_engine.h"

    24

#include "newgrf_callbacks.h"

    25

#include "newgrf_text.h"

    26

#include "newgrf_sound.h"

    27

#include "spritecache.h"

    28

#include "cargotype.h"

    29

#include "strings_func.h"

    30

#include "command_func.h"

    31

#include "window_func.h"

    32

#include "date_func.h"

    33

#include "vehicle_func.h"

    35

#include "functions.h"

    36

    37

void Aircraft::UpdateDeltaXY(Direction direction)

    38

{

    39

	uint32 x;

    40

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

    41

	switch (this->subtype) {

    42

		default: NOT_REACHED();

    43

		case AIR_AIRCRAFT:

    44

		case AIR_HELICOPTER:

    45

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

    46

				case ENDTAKEOFF:

    47

				case LANDING:

    48

				case HELILANDING:

    49

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

    50

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

    51

			}

    52

			this->z_height = 5;

    53

			break;

    54

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

    55

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

    56

	}

    57

#undef MKIT

    58

    59

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

    60

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

    61

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

    62

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

    63

}

    64

    65

    66

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

    67

 *  currently set for 10 terms, 4 helipads */

    68

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

    69

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

    70

    71

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

    72

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

    73

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

    74

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

    75

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

    76

static void CrashAirplane(Vehicle *v);

    77

    78

static void AircraftNextAirportPos_and_Order(Vehicle *v);

    79

static byte GetAircraftFlyingAltitude(const Vehicle *v);

    80

    81

static const SpriteID _aircraft_sprite[] = {

    82

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

    83

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

    84

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

    85

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

    86

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

    87

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

    88

	0x0EBD, 0x0EC5

    89

};

    90

    91

/** Helicopter rotor animation states */

    92

enum HelicopterRotorStates {

    93

	HRS_ROTOR_STOPPED,

    94

	HRS_ROTOR_MOVING_1,

    95

	HRS_ROTOR_MOVING_2,

    96

	HRS_ROTOR_MOVING_3,

    97

};

    98

    99

/** Find the nearest hangar to v

   100

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

   101

 * airports (like helipads only)

   102

 * @param v vehicle looking for a hangar

   103

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

   104

 */

   105

static StationID FindNearestHangar(const Vehicle *v)

   106

{

   107

	const Station *st;

   108

	uint best = 0;

   109

	StationID index = INVALID_STATION;

   110

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

   111

   112

	FOR_ALL_STATIONS(st) {

   113

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

   114

   115

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

   116

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

   117

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

   118

					afc->flags & AirportFTAClass::SHORT_STRIP &&

   119

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

   120

					!_cheats.no_jetcrash.value

   121

				)) {

   122

			continue;

   123

		}

   124

   125

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

   126

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

   127

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

   128

			best = distance;

   129

			index = st->index;

   130

		}

   131

	}

   132

	return index;

   133

}

   134

   135

#if 0

   136

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

   137

 * @param v vehicle to inquiry

   138

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

   139

static bool HaveHangarInOrderList(Vehicle *v)

   140

{

   141

	const Order *order;

   142

   143

	FOR_VEHICLE_ORDERS(v, order) {

   144

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

   145

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

   146

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

   147

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

   148

				return true;

   149

		}

   150

	}

   151

   152

	return false;

   153

}

   154

#endif

   155

   156

int Aircraft::GetImage(Direction direction) const

   157

{

   158

	int spritenum = this->spritenum;

   159

   160

	if (is_custom_sprite(spritenum)) {

   161

		int sprite = GetCustomVehicleSprite(this, direction);

   162

   163

		if (sprite != 0) return sprite;

   164

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

   165

	}

   166

	return direction + _aircraft_sprite[spritenum];

   167

}

   168

   169

SpriteID GetRotorImage(const Vehicle *v)

   170

{

   171

	assert(v->subtype == AIR_HELICOPTER);

   172

   173

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

   174

	if (is_custom_sprite(v->spritenum)) {

   175

		SpriteID spritenum = GetCustomRotorSprite(v, false);

   176

		if (spritenum != 0) return spritenum;

   177

	}

   178

   179

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

   180

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

   181

}

   182

   183

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

   184

{

   185

	const AircraftVehicleInfo* avi = AircraftVehInfo(engine);

   186

	int spritenum = avi->image_index;

   187

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

   188

   189

	if (is_custom_sprite(spritenum)) {

   190

		sprite = GetCustomVehicleIcon(engine, DIR_W);

   191

		if (sprite == 0) {

   192

			spritenum = orig_aircraft_vehicle_info[engine - AIRCRAFT_ENGINES_INDEX].image_index;

   193

			sprite = (6 + _aircraft_sprite[spritenum]);

   194

		}

   195

	}

   196

   197

	DrawSprite(sprite, pal, x, y);

   198

   199

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

   200

		SpriteID rotor_sprite = GetCustomRotorIcon(engine);

   201

		if (rotor_sprite == 0) rotor_sprite = SPR_ROTOR_STOPPED;

   202

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

   203

	}

   204

}

   205

   206

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

   207

 * @param engine The engine to get the sprite from

   208

 * @param width The width of the sprite

   209

 * @param height The height of the sprite

   210

 */

   211

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

   212

{

   213

	const AircraftVehicleInfo* avi = AircraftVehInfo(engine);

   214

	int spritenum = avi->image_index;

   215

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

   216

   217

	if (is_custom_sprite(spritenum)) {

   218

		sprite = GetCustomVehicleIcon(engine, DIR_W);

   219

		if (sprite == 0) {

   220

			spritenum = orig_aircraft_vehicle_info[engine - AIRCRAFT_ENGINES_INDEX].image_index;

   221

			sprite = (6 + _aircraft_sprite[spritenum]);

   222

		}

   223

	}

   224

   225

	const Sprite *spr = GetSprite(sprite);

   226

   227

	width  = spr->width ;

   228

	height = spr->height;

   229

}

   230

   231

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

   232

{

   233

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

   234

}

   235

   236

   237

/**

   238

 * Calculates cargo capacity based on an aircraft's passenger

   239

 * and mail capacities.

   240

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

   241

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

   242

 * @return New cargo capacity value.

   243

 */

   244

uint16 AircraftDefaultCargoCapacity(CargoID cid, const AircraftVehicleInfo *avi)

   245

{

   246

	assert(cid != CT_INVALID);

   247

   248

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

   249

	 * and four times as many passengers. */

   250

	switch (cid) {

   251

		case CT_PASSENGERS:

   252

			return avi->passenger_capacity;

   253

		case CT_MAIL:

   254

			return avi->passenger_capacity + avi->mail_capacity;

   255

		case CT_GOODS:

   256

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

   257

		default:

   258

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

   259

	}

   260

}

   261

   262

/** Build an aircraft.

   263

 * @param tile tile of depot where aircraft is built

   264

 * @param flags for command

   265

 * @param p1 aircraft type being built (engine)

   266

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

   267

 * return result of operation.  Could be cost, error

   268

 */

   269

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

   270

{

   271

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

   272

   273

	const AircraftVehicleInfo *avi = AircraftVehInfo(p1);

   274

	CommandCost value = EstimateAircraftCost(p1, avi);

   275

   276

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

   277

	if (flags & DC_QUERY_COST) return value;

   278

   279

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

   280

   281

	SET_EXPENSES_TYPE(EXPENSES_NEW_VEHICLES);

   282

   283

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

   284

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

   285

   286

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

   287

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

   288

	Vehicle *vl[3];

   289

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

   290

		return_cmd_error(STR_00E1_TOO_MANY_VEHICLES_IN_GAME);

   291

	}

   292

   293

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

   294

	if (unit_num > _patches.max_aircraft)

   295

		return_cmd_error(STR_00E1_TOO_MANY_VEHICLES_IN_GAME);

   296

   297

	if (flags & DC_EXEC) {

   298

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

   299

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

   300

   301

		v = new (v) Aircraft();

   302

		u = new (u) Aircraft();

   303

		v->unitnumber = unit_num;

   304

		v->direction = DIR_SE;

   305

   306

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

   307

   308

		v->tile = tile;

   309

//		u->tile = 0;

   310

   311

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

   312

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

   313

   314

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

   315

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

   316

   317

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

   318

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

   319

   320

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

   321

   322

		v->vehstatus = VS_HIDDEN | VS_STOPPED | VS_DEFPAL;

   323

		u->vehstatus = VS_HIDDEN | VS_UNCLICKABLE | VS_SHADOW;

   324

   325

		v->spritenum = avi->image_index;

   326

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

   327

   328

		v->cargo_cap = avi->passenger_capacity;

   329

		u->cargo_cap = avi->mail_capacity;

   330

   331

		v->cargo_type = CT_PASSENGERS;

   332

		u->cargo_type = CT_MAIL;

   333

   334

		v->cargo_subtype = 0;

   335

   336

		v->string_id = STR_SV_AIRCRAFT_NAME;

   337

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

   338

   339

//		v->load_unload_time_rem = 0;

   340

//		v->progress = 0;

   341

		v->last_station_visited = INVALID_STATION;

   342

//		v->destination_coords = 0;

   343

   344

		v->max_speed = avi->max_speed;

   345

		v->acceleration = avi->acceleration;

   346

		v->engine_type = p1;

   347

   348

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

   349

		v->UpdateDeltaXY(INVALID_DIR);

   350

		v->value = value.GetCost();

   351

   352

		u->subtype = AIR_SHADOW;

   353

		u->UpdateDeltaXY(INVALID_DIR);

   354

   355

		/* Danger, Will Robinson!

   356

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

   357

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

   358

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

   359

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

   360

		CargoID cargo = FindFirstRefittableCargo(p1);

   361

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

   362

			uint16 callback = CALLBACK_FAILED;

   363

   364

			v->cargo_type = cargo;

   365

   366

			if (HasBit(EngInfo(p1)->callbackmask, CBM_VEHICLE_REFIT_CAPACITY)) {

   367

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

   368

			}

   369

   370

			if (callback == CALLBACK_FAILED) {

   371

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

   372

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

   373

			} else {

   374

				v->cargo_cap = callback;

   375

			}

   376

   377

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

   378

			u->cargo_cap = 0;

   379

		}

   380

   381

		const Engine *e = GetEngine(p1);

   382

		v->reliability = e->reliability;

   383

		v->reliability_spd_dec = e->reliability_spd_dec;

   384

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

   385

   386

		_new_vehicle_id = v->index;

   387

   388

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

   389

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

   390

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

   391

		 * of all depots, it is simple */

   392

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

   393

			const Station *st = GetStationByTile(tile);

   394

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

   395

   396

			assert(i != apc->nof_depots);

   397

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

   398

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

   399

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

   400

				break;

   401

			}

   402

		}

   403

   404

		v->u.air.state = HANGAR;

   405

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

   406

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

   407

		v->SetNext(u);

   408

   409

		v->service_interval = _patches.servint_aircraft;

   410

   411

		v->date_of_last_service = _date;

   412

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

   413

   414

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

   415

   416

		v->random_bits = VehicleRandomBits();

   417

		u->random_bits = VehicleRandomBits();

   418

   419

		v->vehicle_flags = 0;

   420

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

   421

   422

		UpdateAircraftCache(v);

   423

   424

		VehiclePositionChanged(v);

   425

		VehiclePositionChanged(u);

   426

   427

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

   428

		if (v->subtype == AIR_HELICOPTER) {

   429

			Vehicle *w = vl[2];

   430

   431

			w = new (w) Aircraft();

   432

			w->direction = DIR_N;

   433

			w->owner = _current_player;

   434

			w->x_pos = v->x_pos;

   435

			w->y_pos = v->y_pos;

   436

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

   437

			w->vehstatus = VS_HIDDEN | VS_UNCLICKABLE;

   438

			w->spritenum = 0xFF;

   439

			w->subtype = AIR_ROTOR;

   440

			w->cur_image = SPR_ROTOR_STOPPED;

   441

			w->random_bits = VehicleRandomBits();

   442

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

   443

			w->u.air.state = HRS_ROTOR_STOPPED;

   444

			w->UpdateDeltaXY(INVALID_DIR);

   445

   446

			u->SetNext(w);

   447

			VehiclePositionChanged(w);

   448

		}

   449

   450

		InvalidateWindowData(WC_VEHICLE_DEPOT, v->tile);

   451

		RebuildVehicleLists();

   452

		InvalidateWindow(WC_COMPANY, v->owner);

   453

		if (IsLocalPlayer())

   454

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

   455

   456

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

   457

	}

   458

   459

	return value;

   460

}

   461

   462

   463

static void DoDeleteAircraft(Vehicle *v)

   464

{

   465

	DeleteWindowById(WC_VEHICLE_VIEW, v->index);

   466

	RebuildVehicleLists();

   467

	InvalidateWindow(WC_COMPANY, v->owner);

   468

	DeleteDepotHighlightOfVehicle(v);

   469

	DeleteVehicleChain(v);

   470

	InvalidateWindowClasses(WC_AIRCRAFT_LIST);

   471

}

   472

   473

/** Sell an aircraft.

   474

 * @param tile unused

   475

 * @param flags for command type

   476

 * @param p1 vehicle ID to be sold

   477

 * @param p2 unused

   478

 * @return result of operation.  Error or sold value

   479

 */

   480

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

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

   488

   489

	if (HASBITS(v->vehstatus, VS_CRASHED)) return_cmd_error(STR_CAN_T_SELL_DESTROYED_VEHICLE);