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

    14

#include "table/strings.h"

    15

#include "map.h"

    16

#include "tile.h"

    17

#include "vehicle.h"

    18

#include "timetable.h"

    19

#include "depot.h"

    20

#include "engine.h"

    21

#include "command.h"

    22

#include "station.h"

    23

#include "news.h"

    24

#include "sound.h"

    25

#include "player.h"

    26

#include "aircraft.h"

    27

#include "airport.h"

    28

#include "vehicle_gui.h"

    29

#include "table/sprites.h"

    30

#include "newgrf_engine.h"

    31

#include "newgrf_callbacks.h"

    32

#include "newgrf_text.h"

    33

#include "newgrf_sound.h"

    34

#include "date.h"

    35

#include "spritecache.h"

    36

#include "cargotype.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, AirportFTA *current_pos, const AirportFTAClass *apc);

    68

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

    69

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

    70

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

    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

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

    95

 */

    96

static AirportMovingData RotateAMDbyOrientation(Vehicle *v, AirportMovingData amd, byte size_x, byte size_y, byte FSM_orientation)

    97

{

    98

	AirportMovingData new_amd;

    99

	new_amd = amd;

   100

   101

	switch (FSM_orientation) {

   102

		case DIR_NE:

   103

			break;

   104

		case DIR_SE:

   105

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

   106

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

   107

			 */

   108

			new_amd.x = amd.y + ((v->subtype == AIR_HELICOPTER)? 0 : 2);

   109

			new_amd.y = (size_y * TILE_SIZE) - amd.x  + ((v->subtype == AIR_HELICOPTER)? 0 : -2);

   110

			new_amd.direction = (Direction)((amd.direction + 2) & 0x07);  // rotate direction "clock" forward 2 ticks

   111

			break;

   112

		case DIR_SW:

   113

			new_amd.x = (size_y * TILE_SIZE) - amd.x + ((v->subtype == AIR_HELICOPTER)? -1 : -2);

   114

			new_amd.y = (size_x * TILE_SIZE) - amd.y + ((v->subtype == AIR_HELICOPTER)? 0 : -1);

   115

			new_amd.direction = (Direction)((amd.direction + 4) & 0x07);  // rotate direction "clock" forward 4 ticks

   116

			break;

   117

		case DIR_NW:

   118

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

   119

			new_amd.x = (size_y * TILE_SIZE) - amd.y + ((v->subtype == AIR_HELICOPTER)? 0 : -2);

   120

			new_amd.y = amd.x  + ((v->subtype == AIR_HELICOPTER)? 0 : -1);

   121

			new_amd.direction = (Direction)((amd.direction + 6) & 0x07);  // rotate direction "clock" back 2 ticks (add 6, then mod 8)

   122

			break;

   123

		default:

   124

			break;

   125

	}

   126

   127

	return new_amd;

   128

}

   129

   130

/** Find the nearest hangar to v

   131

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

   132

 * airports (like helipads only)

   133

 * @param v vehicle looking for a hangar

   134

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

   135

 */

   136

static StationID FindNearestHangar(const Vehicle *v)

   137

{

   138

	const Station *st;

   139

	uint best = 0;

   140

	StationID index = INVALID_STATION;

   141

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

   142

   143

	FOR_ALL_STATIONS(st) {

   144

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

   145

   146

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

   147

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

   148

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

   149

					afc->flags & AirportFTAClass::SHORT_STRIP &&

   150

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

   151

					!_cheats.no_jetcrash.value

   152

				)) {

   153

			continue;

   154

		}

   155

   156

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

   157

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

   158

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

   159

			best = distance;

   160

			index = st->index;

   161

		}

   162

	}

   163

	return index;

   164

}

   165

   166

#if 0

   167

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

   168

 * @param v vehicle to inquiry

   169

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

   170

static bool HaveHangarInOrderList(Vehicle *v)

   171

{

   172

	const Order *order;

   173

   174

	FOR_VEHICLE_ORDERS(v, order) {

   175

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

   176

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

   177

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

   178

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

   179

				return true;

   180

		}

   181

	}

   182

   183

	return false;

   184

}

   185

#endif

   186

   187

int Aircraft::GetImage(Direction direction) const

   188

{

   189

	int spritenum = this->spritenum;

   190

   191

	if (is_custom_sprite(spritenum)) {

   192

		int sprite = GetCustomVehicleSprite(this, direction);

   193

   194

		if (sprite != 0) return sprite;

   195

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

   196

	}

   197

	return direction + _aircraft_sprite[spritenum];

   198

}

   199

   200

SpriteID GetRotorImage(const Vehicle *v)

   201

{

   202

	assert(v->subtype == AIR_HELICOPTER);

   203

   204

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

   205

	if (is_custom_sprite(v->spritenum)) {

   206

		SpriteID spritenum = GetCustomRotorSprite(v, false);

   207

		if (spritenum != 0) return spritenum;

   208

	}

   209

   210

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

   211

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

   212

}

   213

   214

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

   215

{

   216

	const AircraftVehicleInfo* avi = AircraftVehInfo(engine);

   217

	int spritenum = avi->image_index;

   218

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

   219

   220

	if (is_custom_sprite(spritenum)) {

   221

		sprite = GetCustomVehicleIcon(engine, DIR_W);

   222

		if (sprite == 0) {

   223

			spritenum = orig_aircraft_vehicle_info[engine - AIRCRAFT_ENGINES_INDEX].image_index;

   224

			sprite = (6 + _aircraft_sprite[spritenum]);

   225

		}

   226

	}

   227

   228

	DrawSprite(sprite, pal, x, y);

   229

   230

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

   231

		SpriteID rotor_sprite = GetCustomRotorIcon(engine);

   232

		if (rotor_sprite == 0) rotor_sprite = SPR_ROTOR_STOPPED;

   233

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

   234

	}

   235

}

   236

   237

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

   238

 * @param engine The engine to get the sprite from

   239

 * @param width The width of the sprite

   240

 * @param height The height of the sprite

   241

 */

   242

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

   243

{

   244

	const AircraftVehicleInfo* avi = AircraftVehInfo(engine);

   245

	int spritenum = avi->image_index;

   246

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

   247

   248

	if (is_custom_sprite(spritenum)) {

   249

		sprite = GetCustomVehicleIcon(engine, DIR_W);

   250

		if (sprite == 0) {

   251

			spritenum = orig_aircraft_vehicle_info[engine - AIRCRAFT_ENGINES_INDEX].image_index;

   252

			sprite = (6 + _aircraft_sprite[spritenum]);

   253

		}

   254

	}

   255

   256

	const Sprite *spr = GetSprite(sprite);

   257

   258

	width  = spr->width ;

   259

	height = spr->height;

   260

}

   261

   262

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

   263

{

   264

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

   265

}

   266

   267

   268

/**

   269

 * Calculates cargo capacity based on an aircraft's passenger

   270

 * and mail capacities.

   271

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

   272

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

   273

 * @return New cargo capacity value.

   274

 */

   275

uint16 AircraftDefaultCargoCapacity(CargoID cid, const AircraftVehicleInfo *avi)

   276

{

   277

	assert(cid != CT_INVALID);

   278

   279

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

   280

	 * and four times as many passengers. */

   281

	switch (cid) {

   282

		case CT_PASSENGERS:

   283

			return avi->passenger_capacity;

   284

		case CT_MAIL:

   285

			return avi->passenger_capacity + avi->mail_capacity;

   286

		case CT_GOODS:

   287

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

   288

		default:

   289

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

   290

	}

   291

}

   292

   293

/** Build an aircraft.

   294

 * @param tile tile of depot where aircraft is built

   295

 * @param flags for command

   296

 * @param p1 aircraft type being built (engine)

   297

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

   298

 * return result of operation.  Could be cost, error

   299

 */

   300

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

   301

{

   302

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

   303

   304

	const AircraftVehicleInfo *avi = AircraftVehInfo(p1);

   305

	CommandCost value = EstimateAircraftCost(p1, avi);

   306

   307

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

   308

	if (flags & DC_QUERY_COST) return value;

   309

   310

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

   311

   312

	SET_EXPENSES_TYPE(EXPENSES_NEW_VEHICLES);

   313

   314

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

   316

   317

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

   318

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

   319

	Vehicle *vl[3];

   320

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

   321

		return_cmd_error(STR_00E1_TOO_MANY_VEHICLES_IN_GAME);

   322

	}

   323

   324

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

   325

	if (unit_num > _patches.max_aircraft)

   326

		return_cmd_error(STR_00E1_TOO_MANY_VEHICLES_IN_GAME);

   327

   328

	if (flags & DC_EXEC) {

   329

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

   330

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

   331

   332

		v->unitnumber = unit_num;

   333

		v = new (v) Aircraft();

   334

		u = new (u) Aircraft();

   335

		v->direction = DIR_SE;

   336

   337

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

   338

   339

		v->tile = tile;

   340

//		u->tile = 0;

   341

   342

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

   343

   344

		v->vehstatus = VS_HIDDEN | VS_STOPPED | VS_DEFPAL;

   345

		u->vehstatus = VS_HIDDEN | VS_UNCLICKABLE | VS_SHADOW;

   346

   347

		v->spritenum = avi->image_index;

   348

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

   349

   350

		v->cargo_cap = avi->passenger_capacity;

   351

		u->cargo_cap = avi->mail_capacity;

   352

   353

		v->cargo_type = CT_PASSENGERS;

   354

		u->cargo_type = CT_MAIL;

   355

   356

		v->cargo_subtype = 0;

   357

   358

		v->string_id = STR_SV_AIRCRAFT_NAME;

   359

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

   360

   361

//		v->load_unload_time_rem = 0;

   362

//		v->progress = 0;

   363

		v->last_station_visited = INVALID_STATION;

   364

//		v->destination_coords = 0;

   365

   366

		v->max_speed = avi->max_speed;

   367

		v->acceleration = avi->acceleration;

   368

		v->engine_type = p1;

   369

   370

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

   371

		v->UpdateDeltaXY(INVALID_DIR);

   372

		v->value = value.GetCost();

   373

   374

		u->subtype = AIR_SHADOW;

   375

		u->UpdateDeltaXY(INVALID_DIR);

   376

   377

		/* Danger, Will Robinson!

   378

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

   379

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

   380

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

   381

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

   382

		CargoID cargo = FindFirstRefittableCargo(p1);

   383

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

   384

			uint16 callback = CALLBACK_FAILED;

   385

   386

			v->cargo_type = cargo;

   387

   389

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

   390

			}

   391

   392

			if (callback == CALLBACK_FAILED) {

   393

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

   394

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

   395

			} else {

   396

				v->cargo_cap = callback;

   397

			}

   398

   399

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

   400

			u->cargo_cap = 0;

   401

		}

   402

   403

		const Engine *e = GetEngine(p1);

   404

		v->reliability = e->reliability;

   405

		v->reliability_spd_dec = e->reliability_spd_dec;

   406

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

   407

   408

		_new_vehicle_id = v->index;

   409

   410

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

   411

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

   412

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

   413

		 * of all depots, it is simple */

   414

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

   415

			const Station *st = GetStationByTile(tile);

   416

			const AirportFTAClass *apc;

   417

			TileIndexDiffC depots;

   418

			if (IsCustomFSMportsSpecIndex(tile)) {

   419

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

   420

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

   421

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

   422

			} else {

   423

				apc = st->Airport();

   424

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

   425

			}

   426

   427

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

   428

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

   429

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

   430

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

   431

				AirportMovingData amd = RotateAMDbyOrientation(v, *apc->MovingData(i), st->fsmportsspeclist[1].spec->size_x[st->FSMport_layout_set],

   432

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

   433

				v->x_pos = u->x_pos = TileX(st->airport_tile) * TILE_SIZE + amd.x;

   434

				v->y_pos = u->y_pos = TileY(st->airport_tile) * TILE_SIZE + amd.y;

   435

				u->z_pos = GetTileMaxZ(st->airport_tile) + amd.z;

   436

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

   437

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

   438

				v->direction = amd.direction;

   439

   440

				break;

   441

			}

   442

		}

   443

   444

		v->u.air.state = HANGAR;

   445

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

   446

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

   447

		v->SetNext(u);

   448

   449

		v->service_interval = _patches.servint_aircraft;

   450

   451

		v->date_of_last_service = _date;

   452

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

   453

   454

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

   455

   456

		v->random_bits = VehicleRandomBits();

   457

		u->random_bits = VehicleRandomBits();

   458

   459

		v->vehicle_flags = 0;

   460

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

   461

   462

		UpdateAircraftCache(v);

   463

   464

		VehiclePositionChanged(v);

   465

		VehiclePositionChanged(u);

   466

   467

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

   468

		if (v->subtype == AIR_HELICOPTER) {

   469

			Vehicle *w = vl[2];

   470

   471

			w = new (w) Aircraft();

   472

			w->direction = DIR_N;

   473

			w->owner = _current_player;

   474

			w->x_pos = v->x_pos;

   475

			w->y_pos = v->y_pos;

   476

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

   477

			w->vehstatus = VS_HIDDEN | VS_UNCLICKABLE;

   478

			w->spritenum = 0xFF;

   479

			w->subtype = AIR_ROTOR;

   480

			w->cur_image = SPR_ROTOR_STOPPED;

   481

			w->random_bits = VehicleRandomBits();

   482

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

   483

			w->u.air.state = HRS_ROTOR_STOPPED;

   484

			w->UpdateDeltaXY(INVALID_DIR);

   485

   486

			u->SetNext(w);

   487

			VehiclePositionChanged(w);

   488

		}