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

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

    72

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

    73

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

    74

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

    75

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

    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

/* Recalculates airport moving data based on orientation of airport.

   100

 */

   102

{

   105

   106

	switch (FSM_orientation) {

   107

		case DIR_NE:

   108

			break;

   109

		case DIR_SE:

   110

			/* the small numbers are to realign aircraft with the ground graphics, due to perspective angle being different

   111

			 * Helis have a slightly different offset. Not sure why.

   112

			 */

   116

			break;

   117

		case DIR_SW:

   121

			break;

   122

		case DIR_NW:

   123

			// the small numbers are to realign aircraft with the ground graphics, due to perspective angle being different

   127

			break;

   128

		default:

   129

			break;

   130

	}

   131

   133

}

   134

   135

/** Find the nearest hangar to v

   136

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

   137

 * airports (like helipads only)

   138

 * @param v vehicle looking for a hangar

   139

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

   140

 */

   141

static StationID FindNearestHangar(const Vehicle *v)

   142

{

   143

	const Station *st;

   144

	uint best = 0;

   145

	StationID index = INVALID_STATION;

   146

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

   147

   148

	FOR_ALL_STATIONS(st) {

   149

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

   150

   151

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

   152

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

   153

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

   154

					afc->flags & AirportFTAClass::SHORT_STRIP &&

   155

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

   156

					!_cheats.no_jetcrash.value

   157

				)) {

   158

			continue;

   159

		}

   160

   161

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

   162

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

   163

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

   164

			best = distance;

   165

			index = st->index;

   166

		}

   167

	}

   168

	return index;

   169

}

   170

   171

#if 0

   172

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

   173

 * @param v vehicle to inquiry

   174

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

   175

static bool HaveHangarInOrderList(Vehicle *v)

   176

{

   177

	const Order *order;

   178

   179

	FOR_VEHICLE_ORDERS(v, order) {

   180

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

   181

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

   182

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

   183

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

   184

				return true;

   185

		}

   186

	}

   187

   188

	return false;

   189

}

   190

#endif

   191

   192

int Aircraft::GetImage(Direction direction) const

   193

{

   194

	int spritenum = this->spritenum;

   195

   196

	if (is_custom_sprite(spritenum)) {

   197

		int sprite = GetCustomVehicleSprite(this, direction);

   198

   199

		if (sprite != 0) return sprite;

   200

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

   201

	}

   202

	return direction + _aircraft_sprite[spritenum];

   203

}

   204

   205

SpriteID GetRotorImage(const Vehicle *v)

   206

{

   207

	assert(v->subtype == AIR_HELICOPTER);

   208

   209

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

   210

	if (is_custom_sprite(v->spritenum)) {

   211

		SpriteID spritenum = GetCustomRotorSprite(v, false);

   212

		if (spritenum != 0) return spritenum;

   213

	}

   214

   215

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

   216

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

   217

}

   218

   219

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

   220

{

   221

	const AircraftVehicleInfo* avi = AircraftVehInfo(engine);

   222

	int spritenum = avi->image_index;

   223

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

   224

   225

	if (is_custom_sprite(spritenum)) {

   226

		sprite = GetCustomVehicleIcon(engine, DIR_W);

   227

		if (sprite == 0) {

   228

			spritenum = _orig_aircraft_vehicle_info[engine - AIRCRAFT_ENGINES_INDEX].image_index;

   229

			sprite = (6 + _aircraft_sprite[spritenum]);

   230

		}

   231

	}

   232

   233

	DrawSprite(sprite, pal, x, y);

   234

   235

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

   236

		SpriteID rotor_sprite = GetCustomRotorIcon(engine);

   237

		if (rotor_sprite == 0) rotor_sprite = SPR_ROTOR_STOPPED;

   238

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

   239

	}

   240

}

   241

   242

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

   243

 * @param engine The engine to get the sprite from

   244

 * @param width The width of the sprite

   245

 * @param height The height of the sprite

   246

 */

   247

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

   248

{

   249

	const AircraftVehicleInfo* avi = AircraftVehInfo(engine);

   250

	int spritenum = avi->image_index;

   251

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

   252

   253

	if (is_custom_sprite(spritenum)) {

   254

		sprite = GetCustomVehicleIcon(engine, DIR_W);

   255

		if (sprite == 0) {

   256

			spritenum = _orig_aircraft_vehicle_info[engine - AIRCRAFT_ENGINES_INDEX].image_index;

   257

			sprite = (6 + _aircraft_sprite[spritenum]);

   258

		}

   259

	}

   260

   261

	const Sprite *spr = GetSprite(sprite);

   262

   263

	width  = spr->width ;

   264

	height = spr->height;

   265

}

   266

   267

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

   268

{

   269

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

   270

}

   271

   272

   273

/**

   274

 * Calculates cargo capacity based on an aircraft's passenger

   275

 * and mail capacities.

   276

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

   277

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

   278

 * @return New cargo capacity value.

   279

 */

   280

uint16 AircraftDefaultCargoCapacity(CargoID cid, const AircraftVehicleInfo *avi)

   281

{

   282

	assert(cid != CT_INVALID);

   283

   284

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

   285

	 * and four times as many passengers. */

   286

	switch (cid) {

   287

		case CT_PASSENGERS:

   288

			return avi->passenger_capacity;

   289

		case CT_MAIL:

   290

			return avi->passenger_capacity + avi->mail_capacity;

   291

		case CT_GOODS:

   292

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

   293

		default:

   294

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

   295

	}

   296

}

   297

   298

/** Build an aircraft.

   299

 * @param tile tile of depot where aircraft is built

   300

 * @param flags for command

   301

 * @param p1 aircraft type being built (engine)

   302

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

   303

 * return result of operation.  Could be cost, error

   304

 */

   305

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

   306

{

   307

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

   308

   309

	const AircraftVehicleInfo *avi = AircraftVehInfo(p1);

   310

	CommandCost value = EstimateAircraftCost(p1, avi);

   311

   312

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

   313

	if (flags & DC_QUERY_COST) return value;

   314

   315

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

   316

   317

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

   318

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

   319

   320

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

   321

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

   322

	Vehicle *vl[3];

   323

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

   324

		return_cmd_error(STR_00E1_TOO_MANY_VEHICLES_IN_GAME);

   325

	}

   326

   327

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

   328

	if (unit_num > _patches.max_aircraft)

   329

		return_cmd_error(STR_00E1_TOO_MANY_VEHICLES_IN_GAME);

   330

   331

	if (flags & DC_EXEC) {

   332

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

   333

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

   334

   335

		v = new (v) Aircraft();

   336

		u = new (u) Aircraft();

   337

		v->unitnumber = unit_num;

   338

		v->direction = DIR_SE;

   339

   340

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

   341

   342

		v->tile = tile;

   343

//		u->tile = 0;

   344

   347

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

   348

   349

		v->vehstatus = VS_HIDDEN | VS_STOPPED | VS_DEFPAL;

   350

		u->vehstatus = VS_HIDDEN | VS_UNCLICKABLE | VS_SHADOW;

   351

   352

		v->spritenum = avi->image_index;

   353

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

   354

   355

		v->cargo_cap = avi->passenger_capacity;

   356

		u->cargo_cap = avi->mail_capacity;

   357

   358

		v->cargo_type = CT_PASSENGERS;

   359

		u->cargo_type = CT_MAIL;

   360

   361

		v->cargo_subtype = 0;

   362

   363

		v->name = NULL;

   364

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

   365

   366

//		v->load_unload_time_rem = 0;

   367

//		v->progress = 0;

   368

		v->last_station_visited = INVALID_STATION;

   369

//		v->destination_coords = 0;

   370

   371

		v->max_speed = avi->max_speed;

   372

		v->acceleration = avi->acceleration;

   373

		v->engine_type = p1;

   374

   375

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

   376

		v->UpdateDeltaXY(INVALID_DIR);

   377

		v->value = value.GetCost();

   378

   379

		u->subtype = AIR_SHADOW;

   380

		u->UpdateDeltaXY(INVALID_DIR);

   381

   382

		/* Danger, Will Robinson!

   383

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

   384

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

   385

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

   386

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

   387

		CargoID cargo = FindFirstRefittableCargo(p1);

   388

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

   389

			uint16 callback = CALLBACK_FAILED;

   390

   391

			v->cargo_type = cargo;

   392

   393

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

   394

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

   395

			}

   396

   397

			if (callback == CALLBACK_FAILED) {

   398

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

   399

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

   400

			} else {

   401

				v->cargo_cap = callback;

   402

			}

   403

   404

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

   405

			u->cargo_cap = 0;

   406

		}

   407

   408

		const Engine *e = GetEngine(p1);

   409

		v->reliability = e->reliability;

   410

		v->reliability_spd_dec = e->reliability_spd_dec;

   411

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

   412

   413

		_new_vehicle_id = v->index;

   414

   415

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

   416

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

   417

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

   418

		 * of all depots, it is simple */

   419

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

   420

			const Station *st = GetStationByTile(tile);

   421

			const AirportFTAClass *apc;

   422

			TileIndexDiffC depots;

   423

			if (IsCustomFSMportsSpecIndex(tile)) {

   424

				apc = st->fsmportsspeclist[1].spec->portFSM;

   425

				depots = RotateFSMPosition(apc->depots[i].tile_pos, st->fsmportsspeclist[1].spec->size_x[st->FSMport_layout_set],

   426

										   st->fsmportsspeclist[1].spec->size_y[st->FSMport_layout_set], st->FSMport_orientation);

   427

			} else {

   428

				apc = st->Airport();

   429

				depots = apc->depots[i].tile_pos;

   430

			}

   431

   432

			assert(i != apc->num_depots);  //asserts if depot not found

   433

			if (st->airport_tile + ToTileIndexDiff(depots) == tile) {

   434

//TODO: update this to work with multi tile depots

   435

				/* adjust all the initial position data by the orientation of the airport */

   437

											 st->fsmportsspeclist[1].spec->size_y[st->FSMport_layout_set], st->FSMport_orientation);

   441

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

   442

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

   444

   445

				break;

   446

			}

   447

		}

   448

   449

		v->u.air.state = HANGAR;

   450

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

   451

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

   452

		v->SetNext(u);

   453

   454

		v->service_interval = _patches.servint_aircraft;

   455

   456

		v->date_of_last_service = _date;

   457

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

   458

   459

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

   460

   461

		v->random_bits = VehicleRandomBits();

   462

		u->random_bits = VehicleRandomBits();

   463

   464

		v->vehicle_flags = 0;

   465

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

   466

   467

		UpdateAircraftCache(v);

   468

   469

		VehiclePositionChanged(v);

   470

		VehiclePositionChanged(u);

   471

   472

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

   473

		if (v->subtype == AIR_HELICOPTER) {

   474

			Vehicle *w = vl[2];

   475

   476

			w = new (w) Aircraft();

   477

			w->direction = DIR_N;

   478

			w->owner = _current_player;

   479

			w->x_pos = v->x_pos;

   480

			w->y_pos = v->y_pos;

   481

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

   482

			w->vehstatus = VS_HIDDEN | VS_UNCLICKABLE;

   483

			w->spritenum = 0xFF;

   484

			w->subtype = AIR_ROTOR;

   485

			w->cur_image = SPR_ROTOR_STOPPED;

   486

			w->random_bits = VehicleRandomBits();

   487

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