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

    14

#include "news_func.h"

    15

#include "aircraft.h"

    16

#include "airport.h"

    17

#include "vehicle_gui.h"

    18

#include "newgrf_engine.h"

    19

#include "newgrf_callbacks.h"

    20

#include "newgrf_text.h"

    21

#include "newgrf_sound.h"

    22

#include "spritecache.h"

    23

#include "cargotype.h"

    24

#include "strings_func.h"

    25

#include "command_func.h"

    26

#include "window_func.h"

    27

#include "date_func.h"

    28

#include "vehicle_func.h"

    29

#include "sound_func.h"

    30

#include "functions.h"

    31

#include "variables.h"

    32

#include "cheat_func.h"

    33

#include "autoreplace_func.h"

    34

#include "autoreplace_gui.h"

    35

#include "gfx_func.h"

    36

#include "company_func.h"

    37

#include "settings_type.h"

    38

#include "order_func.h"

    39

#include "effectvehicle_func.h"

    40

    41

#include "table/strings.h"

    42

#include "table/sprites.h"

    43

    44

void Aircraft::UpdateDeltaXY(Direction direction)

    45

{

    46

	uint32 x;

    47

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

    48

	switch (this->subtype) {

    49

		default: NOT_REACHED();

    50

		case AIR_AIRCRAFT:

    51

		case AIR_HELICOPTER:

    52

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

    53

				case ENDTAKEOFF:

    54

				case LANDING:

    55

				case HELILANDING:

    56

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

    57

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

    58

			}

    59

			this->z_extent = 5;

    60

			break;

    61

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

    62

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

    63

	}

    64

#undef MKIT

    65

    66

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

    67

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

    68

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

    69

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

    70

}

    71

    72

    73

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

    74

 *  currently set for 10 terms, 4 helipads */

    75

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

    76

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

    77

    78

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

    79

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

    80

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

    81

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

    82

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

    83

static void CrashAirplane(Vehicle *v);

    84

    85

void AircraftNextAirportPos_and_Order(Vehicle *v);

    86

static byte GetAircraftFlyingAltitude(const Vehicle *v);

    87

    88

static const SpriteID _aircraft_sprite[] = {

    89

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

    90

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

    91

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

    92

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

    93

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

    94

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

    95

	0x0EBD, 0x0EC5

    96

};

    97

    98

/** Helicopter rotor animation states */

    99

enum HelicopterRotorStates {

   100

	HRS_ROTOR_STOPPED,

   101

	HRS_ROTOR_MOVING_1,

   102

	HRS_ROTOR_MOVING_2,

   103

	HRS_ROTOR_MOVING_3,

   104

};

   105

   106

/** Find the nearest hangar to v

   107

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

   108

 * airports (like helipads only)

   109

 * @param v vehicle looking for a hangar

   110

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

   111

 */

   112

static StationID FindNearestHangar(const Vehicle *v)

   113

{

   114

	const Station *st;

   115

	uint best = 0;

   116

	StationID index = INVALID_STATION;

   117

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

   118

   119

	FOR_ALL_STATIONS(st) {

   120

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

   121

   122

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

   123

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

   124

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

   125

					afc->flags & AirportFTAClass::SHORT_STRIP &&

   126

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

   127

					!_cheats.no_jetcrash.value

   128

				)) {

   129

			continue;

   130

		}

   131

   132

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

   133

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

   134

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

   135

			best = distance;

   136

			index = st->index;

   137

		}

   138

	}

   139

	return index;

   140

}

   141

   142

#if 0

   143

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

   144

 * @param v vehicle to inquiry

   145

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

   146

static bool HaveHangarInOrderList(Vehicle *v)

   147

{

   148

	const Order *order;

   149

   150

	FOR_VEHICLE_ORDERS(v, order) {

   151

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

   152

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

   153

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

   154

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

   155

				return true;

   156

		}

   157

	}

   158

   159

	return false;

   160

}

   161

#endif

   162

   163

SpriteID Aircraft::GetImage(Direction direction) const

   164

{

   165

	uint8 spritenum = this->spritenum;

   166

   167

	if (is_custom_sprite(spritenum)) {

   168

		SpriteID sprite = GetCustomVehicleSprite(this, direction);

   169

		if (sprite != 0) return sprite;

   170

   171

		spritenum = GetEngine(this->engine_type)->image_index;

   172

	}

   173

   174

	return direction + _aircraft_sprite[spritenum];

   175

}

   176

   177

SpriteID GetRotorImage(const Vehicle *v)

   178

{

   179

	assert(v->subtype == AIR_HELICOPTER);

   180

   181

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

   182

	if (is_custom_sprite(v->spritenum)) {

   183

		SpriteID sprite = GetCustomRotorSprite(v, false);

   184

		if (sprite != 0) return sprite;

   185

	}

   186

   187

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

   188

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

   189

}

   190

   191

static SpriteID GetAircraftIcon(EngineID engine)

   192

{

   193

	uint8 spritenum = AircraftVehInfo(engine)->image_index;

   194

   195

	if (is_custom_sprite(spritenum)) {

   196

		SpriteID sprite = GetCustomVehicleIcon(engine, DIR_W);

   197

		if (sprite != 0) return sprite;

   198

   199

		spritenum = GetEngine(engine)->image_index;

   200

	}

   201

   202

	return 6 + _aircraft_sprite[spritenum];

   203

}

   204

   205

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

   206

{

   207

	DrawSprite(GetAircraftIcon(engine), pal, x, y);

   208

   209

	if (!(AircraftVehInfo(engine)->subtype & AIR_CTOL)) {

   210

		SpriteID rotor_sprite = GetCustomRotorIcon(engine);

   211

		if (rotor_sprite == 0) rotor_sprite = SPR_ROTOR_STOPPED;

   212

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

   213

	}

   214

}

   215

   216

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

   217

 * @param engine The engine to get the sprite from

   218

 * @param width The width of the sprite

   219

 * @param height The height of the sprite

   220

 */

   221

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

   222

{

   223

	const Sprite *spr = GetSprite(GetAircraftIcon(engine), ST_NORMAL);

   224

   225

	width  = spr->width;

   226

	height = spr->height;

   227

}

   228

   229

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

   230

{

   231

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

   232

}

   233

   234

   235

/**

   236

 * Calculates cargo capacity based on an aircraft's passenger

   237

 * and mail capacities.

   238

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

   239

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

   240

 * @return New cargo capacity value.

   241

 */

   242

uint16 AircraftDefaultCargoCapacity(CargoID cid, const AircraftVehicleInfo *avi)

   243

{

   244

	assert(cid != CT_INVALID);

   245

   246

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

   247

	 * and four times as many passengers. */

   248

	switch (cid) {

   249

		case CT_PASSENGERS:

   250

			return avi->passenger_capacity;

   251

		case CT_MAIL:

   252

			return avi->passenger_capacity + avi->mail_capacity;

   253

		case CT_GOODS:

   254

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

   255

		default:

   256

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

   257

	}

   258

}

   259

   260

/** Build an aircraft.

   261

 * @param tile tile of depot where aircraft is built

   262

 * @param flags for command

   263

 * @param p1 aircraft type being built (engine)

   264

 * @param p2 unused

   265

 * return result of operation.  Could be cost, error

   266

 */

   267

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

   268

{

   269

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

   270

   271

	const AircraftVehicleInfo *avi = AircraftVehInfo(p1);

   272

	CommandCost value = EstimateAircraftCost(p1, avi);

   273

   274

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

   275

	if (flags & DC_QUERY_COST) return value;

   276

   277

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

   278

   279

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

   280

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

   281

   282

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

   283

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

   284

	Vehicle *vl[3];

   285

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

   286

		return_cmd_error(STR_00E1_TOO_MANY_VEHICLES_IN_GAME);

   287

	}

   288

   289

	UnitID unit_num = (flags & DC_AUTOREPLACE) ? 0 : GetFreeUnitNumber(VEH_AIRCRAFT);

   290

	if (unit_num > _settings_game.vehicle.max_aircraft)

   291

		return_cmd_error(STR_00E1_TOO_MANY_VEHICLES_IN_GAME);

   292

   293

	if (flags & DC_EXEC) {

   294

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

   295

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

   296

   297

		v = new (v) Aircraft();

   298

		u = new (u) Aircraft();

   299

		v->unitnumber = unit_num;

   300

		v->direction = DIR_SE;

   301

   302

		v->owner = u->owner = _current_company;

   303

   304

		v->tile = tile;

   305

//		u->tile = 0;

   306

   307

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

   308

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

   309

   310

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

   311

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

   312

   313

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

   314

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

   315

   316

		v->running_ticks = 0;

   317

   318

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

   319

   320

		v->vehstatus = VS_HIDDEN | VS_STOPPED | VS_DEFPAL;

   321

		u->vehstatus = VS_HIDDEN | VS_UNCLICKABLE | VS_SHADOW;

   322

   323

		v->spritenum = avi->image_index;

   324

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

   325

   326

		v->cargo_cap = avi->passenger_capacity;

   327

		u->cargo_cap = avi->mail_capacity;

   328

   329

		v->cargo_type = CT_PASSENGERS;

   330

		u->cargo_type = CT_MAIL;

   331

   332

		v->cargo_subtype = 0;

   333

   334

		v->name = NULL;

   335

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

   336

   337

//		v->load_unload_time_rem = 0;

   338

//		v->progress = 0;

   339

		v->last_station_visited = INVALID_STATION;

   340

//		v->destination_coords = 0;

   341

   342

		v->max_speed = avi->max_speed;

   343

		v->acceleration = avi->acceleration;

   344

		v->engine_type = p1;

   346

   347

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

   348

		v->UpdateDeltaXY(INVALID_DIR);

   349

		v->value = value.GetCost();

   350

   351

		u->subtype = AIR_SHADOW;

   352

		u->UpdateDeltaXY(INVALID_DIR);

   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_VEHICLE_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->SetNext(u);

   407

   408

		v->service_interval = _settings_game.vehicle.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

			w = new (w) Aircraft();

   432

			w->direction = DIR_N;

   433

			w->owner = _current_company;

   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

		InvalidateWindowClassesData(WC_AIRCRAFT_LIST, 0);

   452

		InvalidateWindow(WC_COMPANY, v->owner);

   453

		if (IsLocalCompany())

   454

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

   455

   456

		GetCompany(_current_company)->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

	InvalidateWindow(WC_COMPANY, v->owner);

   467

	DeleteDepotHighlightOfVehicle(v);

   468

	DeleteVehicleChain(v);

   469

	InvalidateWindowClassesData(WC_AIRCRAFT_LIST, 0);

   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

CommandCost 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 (!v->IsStoppedInDepot()) return_cmd_error(STR_A01B_AIRCRAFT_MUST_BE_STOPPED);

   487