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

    13

#include "depot.h"

    14

#include "engine.h"

    15

#include "station.h"

    16

#include "news.h"

    17

#include "aircraft.h"

    18

#include "airport.h"

    19

#include "vehicle_gui.h"

    20

#include "newgrf_engine.h"

    21

#include "newgrf_callbacks.h"

    22

#include "newgrf_text.h"

    23

#include "newgrf_sound.h"

    24

#include "spritecache.h"

    25

#include "cargotype.h"

    26

#include "strings_func.h"

    27

#include "command_func.h"

    28

#include "window_func.h"

    29

#include "date_func.h"

    30

#include "vehicle_func.h"

    31

#include "sound_func.h"

    32

#include "functions.h"

    33

#include "variables.h"

    34

#include "autoreplace_func.h"

    35

#include "autoreplace_gui.h"

    36

#include "gfx_func.h"

    37

#include "player_func.h"

    38

#include "settings_type.h"

    39

    40

#include "table/strings.h"

    41

#include "table/sprites.h"

    42

    43

void Aircraft::UpdateDeltaXY(Direction direction)

    44

{

    45

	uint32 x;

    46

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

    47

	switch (this->subtype) {

    48

		default: NOT_REACHED();

    49

		case AIR_AIRCRAFT:

    50

		case AIR_HELICOPTER:

    51

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

    52

				case ENDTAKEOFF:

    53

				case LANDING:

    54

				case HELILANDING:

    55

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

    56

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

    57

			}

    58

			this->z_height = 5;

    59

			break;

    60

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

    61

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

    62

	}

    63

#undef MKIT

    64

    65

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

    66

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

    67

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

    68

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

    69

}

    70

    71

    72

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

    73

 *  currently set for 10 terms, 4 helipads */

    74

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

    75

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

    76

    77

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

    78

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

    79

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

    80

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

    81

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

    82

static void CrashAirplane(Vehicle *v);

    83

    84

static void AircraftNextAirportPos_and_Order(Vehicle *v);

    85

static byte GetAircraftFlyingAltitude(const Vehicle *v);

    86

    87

static const SpriteID _aircraft_sprite[] = {

    88

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

    89

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

    90

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

    91

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

    92

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

    93

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

    94

	0x0EBD, 0x0EC5

    95

};

    96

    97

/** Helicopter rotor animation states */

    98

enum HelicopterRotorStates {

    99

	HRS_ROTOR_STOPPED,

   100

	HRS_ROTOR_MOVING_1,

   101

	HRS_ROTOR_MOVING_2,

   102

	HRS_ROTOR_MOVING_3,

   103

};

   104

   105

/** Find the nearest hangar to v

   106

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

   107

 * airports (like helipads only)

   108

 * @param v vehicle looking for a hangar

   109

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

   110

 */

   111

static StationID FindNearestHangar(const Vehicle *v)

   112

{

   113

	const Station *st;

   114

	uint best = 0;

   115

	StationID index = INVALID_STATION;

   116

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

   117

   118

	FOR_ALL_STATIONS(st) {

   119

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

   120

   121

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

   122

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

   123

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

   124

					afc->flags & AirportFTAClass::SHORT_STRIP &&

   125

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

   126

					!_cheats.no_jetcrash.value

   127

				)) {

   128

			continue;

   129

		}

   130

   131

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

   132

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

   133

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

   134

			best = distance;

   135

			index = st->index;

   136

		}

   137

	}

   138

	return index;

   139

}

   140

   141

#if 0

   142

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

   143

 * @param v vehicle to inquiry

   144

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

   145

static bool HaveHangarInOrderList(Vehicle *v)

   146

{

   147

	const Order *order;

   148

   149

	FOR_VEHICLE_ORDERS(v, order) {

   150

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

   151

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

   152

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

   153

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

   154

				return true;

   155

		}

   156

	}

   157

   158

	return false;

   159

}

   160

#endif

   161

   162

int Aircraft::GetImage(Direction direction) const

   163

{

   164

	int spritenum = this->spritenum;

   165

   166

	if (is_custom_sprite(spritenum)) {

   167

		int sprite = GetCustomVehicleSprite(this, direction);

   168

   169

		if (sprite != 0) return sprite;

   170

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

   171

	}

   172

	return direction + _aircraft_sprite[spritenum];

   173

}

   174

   175

SpriteID GetRotorImage(const Vehicle *v)

   176

{

   177

	assert(v->subtype == AIR_HELICOPTER);

   178

   179

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

   180

	if (is_custom_sprite(v->spritenum)) {

   181

		SpriteID spritenum = GetCustomRotorSprite(v, false);

   182

		if (spritenum != 0) return spritenum;

   183

	}

   184

   185

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

   186

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

   187

}

   188

   189

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

   190

{

   191

	const AircraftVehicleInfo* avi = AircraftVehInfo(engine);

   192

	int spritenum = avi->image_index;

   193

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

   194

   195

	if (is_custom_sprite(spritenum)) {

   196

		sprite = GetCustomVehicleIcon(engine, DIR_W);

   197

		if (sprite == 0) {

   198

			spritenum = _orig_aircraft_vehicle_info[engine - AIRCRAFT_ENGINES_INDEX].image_index;

   199

			sprite = (6 + _aircraft_sprite[spritenum]);

   200

		}

   201

	}

   202

   203

	DrawSprite(sprite, pal, x, y);

   204

   205

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

   206

		SpriteID rotor_sprite = GetCustomRotorIcon(engine);

   207

		if (rotor_sprite == 0) rotor_sprite = SPR_ROTOR_STOPPED;

   208

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

   209

	}

   210

}

   211

   212

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

   213

 * @param engine The engine to get the sprite from

   214

 * @param width The width of the sprite

   215

 * @param height The height of the sprite

   216

 */

   217

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

   218

{

   219

	const AircraftVehicleInfo* avi = AircraftVehInfo(engine);

   220

	int spritenum = avi->image_index;

   221

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

   222

   223

	if (is_custom_sprite(spritenum)) {

   224

		sprite = GetCustomVehicleIcon(engine, DIR_W);

   225

		if (sprite == 0) {

   226

			spritenum = _orig_aircraft_vehicle_info[engine - AIRCRAFT_ENGINES_INDEX].image_index;

   227

			sprite = (6 + _aircraft_sprite[spritenum]);

   228

		}

   229

	}

   230

   231

	const Sprite *spr = GetSprite(sprite);

   232

   233

	width  = spr->width ;

   234

	height = spr->height;

   235

}

   236

   237

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

   238

{

   239

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

   240

}

   241

   242

   243

/**

   244

 * Calculates cargo capacity based on an aircraft's passenger

   245

 * and mail capacities.

   246

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

   247

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

   248

 * @return New cargo capacity value.

   249

 */

   250

uint16 AircraftDefaultCargoCapacity(CargoID cid, const AircraftVehicleInfo *avi)

   251

{

   252

	assert(cid != CT_INVALID);

   253

   254

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

   255

	 * and four times as many passengers. */

   256

	switch (cid) {

   257

		case CT_PASSENGERS:

   258

			return avi->passenger_capacity;

   259

		case CT_MAIL:

   260

			return avi->passenger_capacity + avi->mail_capacity;

   261

		case CT_GOODS:

   262

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

   263

		default:

   264

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

   265

	}

   266

}

   267

   268

/** Build an aircraft.

   269

 * @param tile tile of depot where aircraft is built

   270

 * @param flags for command

   271

 * @param p1 aircraft type being built (engine)

   272

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

   273

 * return result of operation.  Could be cost, error

   274

 */

   275

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

   276

{

   277

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

   278

   279

	const AircraftVehicleInfo *avi = AircraftVehInfo(p1);

   280

	CommandCost value = EstimateAircraftCost(p1, avi);

   281

   282

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

   283

	if (flags & DC_QUERY_COST) return value;

   284

   285

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

   286

   287

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

   288

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

   289

   290

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

   291

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

   292

	Vehicle *vl[3];

   293

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

   294

		return_cmd_error(STR_00E1_TOO_MANY_VEHICLES_IN_GAME);

   295

	}

   296

   297

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

   298

	if (unit_num > _patches.max_aircraft)

   299

		return_cmd_error(STR_00E1_TOO_MANY_VEHICLES_IN_GAME);

   300

   301

	if (flags & DC_EXEC) {

   302

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

   303

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

   304

   305

		v = new (v) Aircraft();

   306

		u = new (u) Aircraft();

   307

		v->unitnumber = unit_num;

   308

		v->direction = DIR_SE;

   309

   310

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

   311

   312

		v->tile = tile;

   313

//		u->tile = 0;

   314

   315

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

   316

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

   317

   318

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

   319

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

   320

   321

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

   322

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

   323

   324

		v->running_ticks = 0;

   325

   326

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

   327

   328

		v->vehstatus = VS_HIDDEN | VS_STOPPED | VS_DEFPAL;

   329

		u->vehstatus = VS_HIDDEN | VS_UNCLICKABLE | VS_SHADOW;

   330

   331

		v->spritenum = avi->image_index;

   332

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

   333

   334

		v->cargo_cap = avi->passenger_capacity;

   335

		u->cargo_cap = avi->mail_capacity;

   336

   337

		v->cargo_type = CT_PASSENGERS;

   338

		u->cargo_type = CT_MAIL;

   339

   340

		v->cargo_subtype = 0;

   341

   342

		v->name = NULL;

   343

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

   344

   345

//		v->load_unload_time_rem = 0;

   346

//		v->progress = 0;

   347

		v->last_station_visited = INVALID_STATION;

   348

//		v->destination_coords = 0;

   349

   350

		v->max_speed = avi->max_speed;

   351

		v->acceleration = avi->acceleration;

   352

		v->engine_type = p1;

   353

   354

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

   355

		v->UpdateDeltaXY(INVALID_DIR);

   356

		v->value = value.GetCost();

   357

   358

		u->subtype = AIR_SHADOW;

   359

		u->UpdateDeltaXY(INVALID_DIR);

   360

   361

		/* Danger, Will Robinson!

   362

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

   363

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

   364

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

   365

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

   366

		CargoID cargo = FindFirstRefittableCargo(p1);

   367

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

   368

			uint16 callback = CALLBACK_FAILED;

   369

   370

			v->cargo_type = cargo;

   371

   372

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

   373

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

   374

			}

   375

   376

			if (callback == CALLBACK_FAILED) {

   377

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

   378

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

   379

			} else {

   380

				v->cargo_cap = callback;

   381

			}

   382

   383

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

   384

			u->cargo_cap = 0;

   385

		}

   386

   387

		const Engine *e = GetEngine(p1);

   388

		v->reliability = e->reliability;

   389

		v->reliability_spd_dec = e->reliability_spd_dec;

   390

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

   391

   392

		_new_vehicle_id = v->index;

   393

   394

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

   395

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

   396

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

   397

		 * of all depots, it is simple */

   398

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

   399

			const Station *st = GetStationByTile(tile);

   400

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

   401

   402

			assert(i != apc->nof_depots);

   403

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

   404

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

   405

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

   406

				break;

   407

			}

   408

		}

   409

   410

		v->u.air.state = HANGAR;

   411

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

   412

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

   413

		v->SetNext(u);

   414

   415

		v->service_interval = _patches.servint_aircraft;

   416

   417

		v->date_of_last_service = _date;

   418

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

   419

   420

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

   421

   422

		v->random_bits = VehicleRandomBits();

   423

		u->random_bits = VehicleRandomBits();

   424

   425

		v->vehicle_flags = 0;

   426

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

   427

   428

		UpdateAircraftCache(v);

   429

   430

		VehiclePositionChanged(v);

   431

		VehiclePositionChanged(u);

   432

   433

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

   434

		if (v->subtype == AIR_HELICOPTER) {

   435

			Vehicle *w = vl[2];

   436

   437

			w = new (w) Aircraft();

   438

			w->direction = DIR_N;

   439

			w->owner = _current_player;

   440

			w->x_pos = v->x_pos;

   441

			w->y_pos = v->y_pos;

   442

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

   443

			w->vehstatus = VS_HIDDEN | VS_UNCLICKABLE;

   444

			w->spritenum = 0xFF;

   445

			w->subtype = AIR_ROTOR;

   446

			w->cur_image = SPR_ROTOR_STOPPED;

   447

			w->random_bits = VehicleRandomBits();

   448

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

   449

			w->u.air.state = HRS_ROTOR_STOPPED;

   450

			w->UpdateDeltaXY(INVALID_DIR);

   451

   452

			u->SetNext(w);

   453

			VehiclePositionChanged(w);

   454

		}

   455

   456

		InvalidateWindowData(WC_VEHICLE_DEPOT, v->tile);

   457

		RebuildVehicleLists();

   458

		InvalidateWindow(WC_COMPANY, v->owner);

   459

		if (IsLocalPlayer())

   460

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

   461

   462

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

   463

	}

   464

   465

	return value;

   466

}

   467

   468

   469

static void DoDeleteAircraft(Vehicle *v)

   470

{

   471

	DeleteWindowById(WC_VEHICLE_VIEW, v->index);

   472

	RebuildVehicleLists();

   473

	InvalidateWindow(WC_COMPANY, v->owner);

   474

	DeleteDepotHighlightOfVehicle(v);

   475

	DeleteVehicleChain(v);

   476

	InvalidateWindowClasses(WC_AIRCRAFT_LIST);

   477

}

   478

   479

/** Sell an aircraft.

   480

 * @param tile unused

   481

 * @param flags for command type

   482

 * @param p1 vehicle ID to be sold

   483

 * @param p2 unused

   484

 * @return result of operation.  Error or sold value

   485

 */

   486

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

   487

{

   488

	if (!IsValidVehicleID(p1)) return CMD_ERROR;