1

/* $Id$ */

     2

     3

#include "stdafx.h"

     4

#include "openttd.h"

     5

#include "aircraft.h"

     6

#include "debug.h"

     7

#include "functions.h"

     8

#include "station_map.h"

     9

#include "table/strings.h"

    10

#include "map.h"

    11

#include "tile.h"

    12

#include "vehicle.h"

    13

#include "depot.h"

    14

#include "engine.h"

    15

#include "command.h"

    16

#include "station.h"

    17

#include "news.h"

    18

#include "sound.h"

    19

#include "player.h"

    20

#include "airport.h"

    21

#include "vehicle_gui.h"

    22

#include "table/sprites.h"

    23

#include "newgrf_engine.h"

    24

    25

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

    26

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

    27

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

    28

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

    29

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

    30

static void AirportGoToNextPosition(Vehicle *v, const AirportFTAClass *Airport);

    31

static void CrashAirplane(Vehicle *v);

    32

    33

static void AircraftNextAirportPos_and_Order(Vehicle *v);

    34

static byte GetAircraftFlyingAltitude(const Vehicle *v);

    35

    36

static const SpriteID _aircraft_sprite[] = {

    37

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

    38

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

    39

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

    40

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

    41

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

    42

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

    43

	0x0EBD, 0x0EC5

    44

};

    45

    46

/* Helicopter rotor animation states */

    47

enum HelicopterRotorStates {

    48

	HRS_ROTOR_STOPPED,

    49

	HRS_ROTOR_MOVING_1,

    50

	HRS_ROTOR_MOVING_2,

    51

	HRS_ROTOR_MOVING_3,

    52

};

    53

    54

/* Find the nearest hangar to v

    55

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

    56

 * airports (like helipads only)

    57

 */

    58

static StationID FindNearestHangar(const Vehicle *v)

    59

{

    60

	const Station *st;

    61

	uint best = 0;

    62

	StationID index = INVALID_STATION;

    63

    64

	FOR_ALL_STATIONS(st) {

    65

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

    66

				GetAirport(st->airport_type)->nof_depots > 0) {

    67

			uint distance;

    68

    69

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

    70

			if (HASBIT(v->subtype, 1) && st->airport_type == AT_SMALL &&

    71

					!_cheats.no_jetcrash.value)

    72

				continue;

    73

    74

			distance = DistanceSquare(v->tile, st->airport_tile);

    75

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

    76

				best = distance;

    77

				index = st->index;

    78

			}

    79

		}

    80

	}

    81

	return index;

    82

}

    83

    84

#if 0

    85

// returns true if vehicle v have an airport in the schedule, that has a hangar

    86

static bool HaveHangarInOrderList(Vehicle *v)

    87

{

    88

	const Order *order;

    89

    90

	FOR_VEHICLE_ORDERS(v, order) {

    91

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

    92

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

    93

			// If an airport doesn't have terminals (so no landing space for airports),

    94

			// it surely doesn't have any hangars

    95

			if (GetAirport(st->airport_type)->terminals != NULL)

    96

				return true;

    97

		}

    98

	}

    99

   100

	return false;

   101

}

   102

#endif

   103

   104

int GetAircraftImage(const Vehicle* v, Direction direction)

   105

{

   106

	int spritenum = v->spritenum;

   107

   108

	if (is_custom_sprite(spritenum)) {

   109

		int sprite = GetCustomVehicleSprite(v, direction);

   110

   111

		if (sprite != 0) return sprite;

   112

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

   113

	}

   114

	return direction + _aircraft_sprite[spritenum];

   115

}

   116

   117

SpriteID GetRotorImage(const Vehicle *v)

   118

{

   119

	const Vehicle *w;

   120

   121

	assert((v->subtype & 1) == 0);

   122

   123

	w = v->next->next;

   124

	if (is_custom_sprite(v->spritenum)) {

   125

		SpriteID spritenum = GetCustomRotorSprite(v);

   126

		if (spritenum != 0) return spritenum;

   127

	}

   128

   129

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

   130

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

   131

}

   132

   133

void DrawAircraftEngine(int x, int y, EngineID engine, uint32 image_ormod)

   134

{

   135

	int spritenum = AircraftVehInfo(engine)->image_index;

   136

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

   137

   138

	if (is_custom_sprite(spritenum)) {

   139

		sprite = GetCustomVehicleIcon(engine, DIR_W);

   140

		if (!sprite)

   141

			spritenum = orig_aircraft_vehicle_info[engine - AIRCRAFT_ENGINES_INDEX].image_index;

   142

	}

   143

   144

	DrawSprite(sprite | image_ormod, x, y);

   145

   146

	if ((AircraftVehInfo(engine)->subtype & 1) == 0) {

   147

		SpriteID rotor_sprite = GetCustomRotorIcon(engine);

   148

		if (rotor_sprite == 0) rotor_sprite = SPR_ROTOR_STOPPED;

   149

		DrawSprite(rotor_sprite, x, y - 5);

   150

	}

   151

}

   152

   153

static int32 EstimateAircraftCost(EngineID engine_type)

   154

{

   155

	return AircraftVehInfo(engine_type)->base_cost * (_price.aircraft_base>>3)>>5;

   156

}

   157

   158

   159

/** Build an aircraft.

   160

 * @param tile tile of depot where aircraft is built

   161

 * @param p1 aircraft type being built (engine)

   162

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

   163

 */

   164

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

   165

{

   166

	int32 value;

   167

	Vehicle *vl[3], *v, *u, *w;

   168

	UnitID unit_num;

   169

	const AircraftVehicleInfo *avi;

   170

	Engine *e;

   171

   172

	if (!IsEngineBuildable(p1, VEH_Aircraft)) return_cmd_error(STR_ENGINE_NOT_BUILDABLE);

   173

   174

	value = EstimateAircraftCost(p1);

   175

   176

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

   177

	if (flags & DC_QUERY_COST) return value;

   178

   179

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

   180

   181

	SET_EXPENSES_TYPE(EXPENSES_NEW_VEHICLES);

   182

   183

	avi = AircraftVehInfo(p1);

   184

	// allocate 2 or 3 vehicle structs, depending on type

   185

	if (!AllocateVehicles(vl, (avi->subtype & 1) == 0 ? 3 : 2) ||

   186

			IsOrderPoolFull()) {

   187

		return_cmd_error(STR_00E1_TOO_MANY_VEHICLES_IN_GAME);

   188

	}

   189

   190

	unit_num = (HASBIT(p2, 0) == true) ? 0 : GetFreeUnitNumber(VEH_Aircraft);

   191

	if (unit_num > _patches.max_aircraft)

   192

		return_cmd_error(STR_00E1_TOO_MANY_VEHICLES_IN_GAME);

   193

   194

	if (flags & DC_EXEC) {

   195

		uint x;

   196

		uint y;

   197

   198

		v = vl[0];

   199

		u = vl[1];

   200

   201

		v->unitnumber = unit_num;

   202

		v->type = u->type = VEH_Aircraft;

   203

		v->direction = 3;

   204

   205

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

   206

   207

		v->tile = tile;

   208

//		u->tile = 0;

   209

   210

		x = TileX(tile) * TILE_SIZE + 5;

   211

		y = TileY(tile) * TILE_SIZE + 3;

   212

   213

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

   214

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

   215

   216

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

   217

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

   218

   219

		v->x_offs = v->y_offs = -1;

   220

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

   221

   222

		v->sprite_width = v->sprite_height = 2;

   223

		v->z_height = 5;

   224

   225

		u->sprite_width = u->sprite_height = 2;

   226

		u->z_height = 1;

   227

   228

		v->vehstatus = VS_HIDDEN | VS_STOPPED | VS_DEFPAL;

   229

		u->vehstatus = VS_HIDDEN | VS_UNCLICKABLE | VS_DISASTER;

   230

   231

		v->spritenum = avi->image_index;

   232

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

   233

   234

		v->cargo_cap = avi->passenger_capacity;

   235

		u->cargo_cap = avi->mail_capacity;

   236

   237

		v->cargo_type = CT_PASSENGERS;

   238

		u->cargo_type = CT_MAIL;

   239

   240

		v->cargo_subtype = 0;

   241

   242

		v->string_id = STR_SV_AIRCRAFT_NAME;

   243

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

   244

   245

//		v->load_unload_time_rem = 0;

   246

//		v->progress = 0;

   247

		v->last_station_visited = INVALID_STATION;

   248

//		v->destination_coords = 0;

   249

   250

		v->max_speed = avi->max_speed;

   251

		v->acceleration = avi->acceleration;

   252

		v->engine_type = p1;

   253

   254

		v->subtype = (avi->subtype & 1) == 0 ? 0 : 2;

   255

		v->value = value;

   256

   257

		u->subtype = 4;

   258

   259

		e = GetEngine(p1);

   260

		v->reliability = e->reliability;

   261

		v->reliability_spd_dec = e->reliability_spd_dec;

   262

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

   263

   264

		_new_vehicle_id = v->index;

   265

   266

		v->u.air.pos = MAX_ELEMENTS;

   267

   268

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

   269

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

   270

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

   271

		 * of all depots, it is simple */

   272

		{

   273

			const Station* st = GetStationByTile(tile);

   274

			const AirportFTAClass* apc = GetAirport(st->airport_type);

   275

			uint i;

   276

   277

			for (i = 0; i < apc->nof_depots; i++) {

   278

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

   279

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

   280

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

   281

					break;

   282

				}

   283

			}

   284

			// to ensure v->u.air.pos has been given a value

   285

			assert(v->u.air.pos != MAX_ELEMENTS);

   286

		}

   287

   288

		v->u.air.state = HANGAR;

   289

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

   290

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

   291

		v->next = u;

   292

   293

		v->service_interval = _patches.servint_aircraft;

   294

   295

		v->date_of_last_service = _date;

   296

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

   297

   298

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

   299

   300

		v->random_bits = VehicleRandomBits();

   301

		u->random_bits = VehicleRandomBits();

   302

   303

		VehiclePositionChanged(v);

   304

		VehiclePositionChanged(u);

   305

   306

		// Aircraft with 3 vehicles (chopper)?

   307

		if (v->subtype == 0) {

   308

			w = vl[2];

   309

   310

			u->next = w;

   311

   312

			w->type = VEH_Aircraft;

   313

			w->direction = 0;

   314

			w->owner = _current_player;

   315

			w->x_pos = v->x_pos;

   316

			w->y_pos = v->y_pos;

   317

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

   318

			w->x_offs = w->y_offs = -1;

   319

			w->sprite_width = w->sprite_height = 2;

   320

			w->z_height = 1;

   321

			w->vehstatus = VS_HIDDEN | VS_UNCLICKABLE;

   322

			w->spritenum = 0xFF;

   323

			w->subtype = 6;

   324

			w->cur_image = SPR_ROTOR_STOPPED;

   325

			w->random_bits = VehicleRandomBits();

   326

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

   327

			w->u.air.state = HRS_ROTOR_STOPPED;

   328

			VehiclePositionChanged(w);

   329

		}

   330

   331

		InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   332

		RebuildVehicleLists();

   333

		InvalidateWindow(WC_COMPANY, v->owner);

   334

		if (IsLocalPlayer())

   335

			InvalidateWindow(WC_REPLACE_VEHICLE, VEH_Aircraft); //updates the replace Aircraft window

   336

	}

   337

   338

	return value;

   339

}

   340

   341

   342

static void DoDeleteAircraft(Vehicle *v)

   343

{

   344

	DeleteWindowById(WC_VEHICLE_VIEW, v->index);

   345

	RebuildVehicleLists();

   346

	InvalidateWindow(WC_COMPANY, v->owner);

   347

	DeleteVehicleChain(v);

   348

	InvalidateWindowClasses(WC_AIRCRAFT_LIST);

   349

}

   350

   351

/** Sell an aircraft.

   352

 * @param tile unused

   353

 * @param p1 vehicle ID to be sold

   354

 * @param p2 unused

   355

 */

   356

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

   357

{

   358

	Vehicle *v;

   359

   360

	if (!IsVehicleIndex(p1)) return CMD_ERROR;

   361

   362

	v = GetVehicle(p1);

   363

   364

	if (v->type != VEH_Aircraft || !CheckOwnership(v->owner)) return CMD_ERROR;

   365

	if (!IsAircraftInHangarStopped(v)) return_cmd_error(STR_A01B_AIRCRAFT_MUST_BE_STOPPED);

   366

   367

	SET_EXPENSES_TYPE(EXPENSES_NEW_VEHICLES);

   368

   369

	if (flags & DC_EXEC) {

   370

		// Invalidate depot

   371

		InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   372

		DoDeleteAircraft(v);

   373

		if (IsLocalPlayer())

   374

			InvalidateWindow(WC_REPLACE_VEHICLE, VEH_Aircraft); // updates the replace Aircraft window

   375

	}

   376

   377

	return -(int32)v->value;

   378

}

   379

   380

/** Start/Stop an aircraft.

   381

 * @param tile unused

   382

 * @param p1 aircraft ID to start/stop

   383

 * @param p2 unused

   384

 */

   385

int32 CmdStartStopAircraft(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)

   386

{

   387

	Vehicle *v;

   388

   389

	if (!IsVehicleIndex(p1)) return CMD_ERROR;

   390

   391

	v = GetVehicle(p1);

   392

   393

	if (v->type != VEH_Aircraft || !CheckOwnership(v->owner)) return CMD_ERROR;

   394

   395

	// cannot stop airplane when in flight, or when taking off / landing

   396

	if (v->u.air.state >= STARTTAKEOFF)

   397

		return_cmd_error(STR_A017_AIRCRAFT_IS_IN_FLIGHT);

   398

   399

	if (flags & DC_EXEC) {

   400

		if (IsAircraftInHangarStopped(v)) {

   401

			DeleteVehicleNews(p1, STR_A014_AIRCRAFT_IS_WAITING_IN);

   402

		}

   403

   404

		v->vehstatus ^= VS_STOPPED;

   405

		InvalidateWindowWidget(WC_VEHICLE_VIEW, v->index, STATUS_BAR);

   406

		InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   407

		InvalidateWindowClasses(WC_AIRCRAFT_LIST);

   408

	}

   409

   410

	return 0;

   411

}

   412

   413

/** Send an aircraft to the hangar.

   414

 * @param tile unused

   415

 * @param p1 vehicle ID to send to the hangar

   416

 * @param p2 various bitmasked elements

   417

 * - p2 = 0      - aircraft goes to the depot and stays there (user command)

   418

 * - p2 non-zero - aircraft will try to goto a depot, but not stop there (eg forced servicing)

   419

 * - p2 (bit 17) - aircraft will try to goto a depot at the next airport

   420

 */

   421

int32 CmdSendAircraftToHangar(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)

   422

{

   423

	Vehicle *v;

   424

   425

	if (!IsVehicleIndex(p1)) return CMD_ERROR;

   426

   427

	v = GetVehicle(p1);

   428

   429

	if (v->type != VEH_Aircraft || !CheckOwnership(v->owner)) return CMD_ERROR;

   430

   431

	if (v->current_order.type == OT_GOTO_DEPOT && p2 == 0) {

   432

		if (flags & DC_EXEC) {

   433

			if (v->current_order.flags & OF_UNLOAD) v->cur_order_index++;

   434

			v->current_order.type = OT_DUMMY;

   435

			v->current_order.flags = 0;

   436

			InvalidateWindowWidget(WC_VEHICLE_VIEW, v->index, STATUS_BAR);

   437

		}

   438

	} else {

   439

		bool next_airport_has_hangar = true;

   440

		/* XXX - I don't think p2 is any valid station cause all calls use either 0, 1, or 1<<16!!!!!!!!! */

   441

		StationID next_airport_index = (HASBIT(p2, 17)) ? (StationID)p2 : v->u.air.targetairport;

   442

		const Station *st = GetStation(next_airport_index);

   443

		// If an airport doesn't have terminals (so no landing space for airports),

   444

		// it surely doesn't have any hangars

   445

		if (!IsValidStation(st) || st->airport_tile == 0 || GetAirport(st->airport_type)->nof_depots == 0) {

   446

			StationID station;

   447

   448

			if (p2 != 0) return CMD_ERROR;

   449

			// the aircraft has to search for a hangar on its own

   450

			station = FindNearestHangar(v);

   451

   452

			next_airport_has_hangar = false;

   453

			if (station == INVALID_STATION) return CMD_ERROR;

   454

			st = GetStation(station);

   455

			next_airport_index = station;

   456

   457

		}

   458

   459

		if (flags & DC_EXEC) {

   460

			v->current_order.type = OT_GOTO_DEPOT;

   461

			v->current_order.flags = HASBIT(p2, 16) ? 0 : OF_NON_STOP | OF_FULL_LOAD;

   462

			v->current_order.station = next_airport_index;

   463

			InvalidateWindowWidget(WC_VEHICLE_VIEW, v->index, STATUS_BAR);

   464

			if (HASBIT(p2, 17) || (p2 == 0 && v->u.air.state == FLYING && !next_airport_has_hangar)) {

   465

			// the aircraft is now heading for a different hangar than the next in the orders

   466

				AircraftNextAirportPos_and_Order(v);

   467

				v->u.air.targetairport = next_airport_index;

   468

			}

   469

		}

   470

	}

   471

   472

	return 0;

   473

}

   474

   475

   476

/** Refits an aircraft to the specified cargo type.

   477

 * @param tile unused

   478

 * @param p1 vehicle ID of the aircraft to refit

   479

 * @param p2 various bitstuffed elements

   480

 * - p2 = (bit 0-7) - the new cargo type to refit to

   481

 * - p2 = (bit 8-15) - the new cargo subtype to refit to

   482

 */

   483

int32 CmdRefitAircraft(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)

   484

{

   485

	Vehicle *v;

   486

	int pass, mail;

   487

	int32 cost;

   488

	CargoID new_cid = GB(p2, 0, 8);

   489

	byte new_subtype = GB(p2, 8, 8);

   490

	const AircraftVehicleInfo *avi;

   491

   492

	if (!IsVehicleIndex(p1)) return CMD_ERROR;

   493

   494

	v = GetVehicle(p1);

   495

   496

	if (v->type != VEH_Aircraft || !CheckOwnership(v->owner)) return CMD_ERROR;