1

/* $Id$ */

     2

     3

#include "stdafx.h"

     4

#include "openttd.h"

     5

#include "debug.h"

     6

#include "functions.h"

     7

#include "table/strings.h"

     8

#include "map.h"

     9

#include "tile.h"

    10

#include "vehicle.h"

    11

#include "depot.h"

    12

#include "engine.h"

    13

#include "command.h"

    14

#include "station.h"

    15

#include "news.h"

    16

#include "sound.h"

    17

#include "player.h"

    18

#include "airport.h"

    19

#include "vehicle_gui.h"

    20

#include "table/sprites.h"

    21

    22

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

    23

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

    24

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

    25

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

    26

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

    27

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

    28

static void CrashAirplane(Vehicle *v);

    29

    30

static void AircraftNextAirportPos_and_Order(Vehicle *v);

    31

static byte GetAircraftFlyingAltitude(const Vehicle *v);

    32

    33

static const SpriteID _aircraft_sprite[] = {

    34

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

    35

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

    36

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

    37

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

    38

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

    39

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

    40

	0x0EBD, 0x0EC5

    41

};

    42

    43

/* Find the nearest hangar to v

    44

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

    45

 * airports (like helipads only)

    46

 */

    47

static StationID FindNearestHangar(const Vehicle *v)

    48

{

    49

	const Station *st;

    50

	uint best = 0;

    51

	StationID index = INVALID_STATION;

    52

    53

	FOR_ALL_STATIONS(st) {

    54

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

    55

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

    56

			uint distance;

    57

    58

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

    59

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

    60

					!_cheats.no_jetcrash.value)

    61

				continue;

    62

    63

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

    64

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

    65

				best = distance;

    66

				index = st->index;

    67

			}

    68

		}

    69

	}

    70

	return index;

    71

}

    72

    73

#if 0

    74

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

    75

static bool HaveHangarInOrderList(Vehicle *v)

    76

{

    77

	const Order *order;

    78

    79

	FOR_VEHICLE_ORDERS(v, order) {

    80

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

    81

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

    82

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

    83

			// it surely doesn't have any hangars

    84

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

    85

				return true;

    86

		}

    87

	}

    88

    89

	return false;

    90

}

    91

#endif

    92

    93

int GetAircraftImage(const Vehicle *v, byte direction)

    94

{

    95

	int spritenum = v->spritenum;

    96

    97

	if (is_custom_sprite(spritenum)) {

    98

		int sprite = GetCustomVehicleSprite(v, direction);

    99

   100

		if (sprite) return sprite;

   101

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

   102

	}

   103

	return direction + _aircraft_sprite[spritenum];

   104

}

   105

   106

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

   107

{

   108

	int spritenum = AircraftVehInfo(engine)->image_index;

   109

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

   110

   111

	if (is_custom_sprite(spritenum)) {

   112

		sprite = GetCustomVehicleIcon(engine, 6);

   113

		if (!sprite)

   114

			spritenum = orig_aircraft_vehicle_info[engine - AIRCRAFT_ENGINES_INDEX].image_index;

   115

	}

   116

   117

	DrawSprite(sprite | image_ormod, x, y);

   118

   119

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

   120

		DrawSprite(SPR_ROTOR_STOPPED, x, y - 5);

   121

	}

   122

}

   123

   124

/* Allocate many vehicles */

   125

static bool AllocateVehicles(Vehicle **vl, int num)

   126

{

   127

	int i;

   128

	Vehicle *v;

   129

	bool success = true;

   130

   131

	for(i=0; i!=num; i++) {

   132

		vl[i] = v = AllocateVehicle();

   133

		if (v == NULL) {

   134

			success = false;

   135

			break;

   136

		}

   137

		v->type = 1;

   138

	}

   139

   140

	while (--i >= 0) {

   141

		vl[i]->type = 0;

   142

	}

   143

   144

	return success;

   145

}

   146

   147

int32 EstimateAircraftCost(EngineID engine_type)

   148

{

   149

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

   150

}

   151

   152

   153

/** Build an aircraft.

   154

 * @param x,y tile coordinates of depot where aircraft is built

   155

 * @param p1 aircraft type being built (engine)

   156

 * @param p2 unused

   157

 */

   158

int32 CmdBuildAircraft(int x, int y, uint32 flags, uint32 p1, uint32 p2)

   159

{

   160

	int32 value;

   161

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

   162

	UnitID unit_num;

   163

	TileIndex tile = TileVirtXY(x, y);

   164

	const AircraftVehicleInfo *avi;

   165

	Engine *e;

   166

   167

	if (!IsEngineBuildable(p1, VEH_Aircraft)) return CMD_ERROR;

   168

   169

	value = EstimateAircraftCost(p1);

   170

   171

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

   172

	if (flags & DC_QUERY_COST) return value;

   173

   174

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

   175

   176

	SET_EXPENSES_TYPE(EXPENSES_NEW_VEHICLES);

   177

   178

	avi = AircraftVehInfo(p1);

   179

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

   180

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

   181

				IsOrderPoolFull())

   182

					return_cmd_error(STR_00E1_TOO_MANY_VEHICLES_IN_GAME);

   183

   184

	unit_num = GetFreeUnitNumber(VEH_Aircraft);

   185

	if (unit_num > _patches.max_aircraft)

   186

		return_cmd_error(STR_00E1_TOO_MANY_VEHICLES_IN_GAME);

   187

   188

	if (flags & DC_EXEC) {

   189

		v = vl[0];

   190

		u = vl[1];

   191

   192

		v->unitnumber = unit_num;

   193

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

   194

		v->direction = 3;

   195

   196

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

   197

   198

		v->tile = tile;

   199

//		u->tile = 0;

   200

   201

		x = TileX(tile) * 16 + 5;

   202

		y = TileY(tile) * 16 + 3;

   203

   204

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

   205

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

   206

   207

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

   208

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

   209

   210

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

   211

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

   212

   213

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

   214

		v->z_height = 5;

   215

   216

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

   217

		u->z_height = 1;

   218

   219

		v->vehstatus = VS_HIDDEN | VS_STOPPED | VS_DEFPAL;

   220

		u->vehstatus = VS_HIDDEN | VS_UNCLICKABLE | VS_DISASTER;

   221

   222

		v->spritenum = avi->image_index;

   223

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

   224

   225

		v->cargo_cap = avi->passenger_capacity;

   226

		u->cargo_cap = avi->mail_capacity;

   227

   228

		v->cargo_type = CT_PASSENGERS;

   229

		u->cargo_type = CT_MAIL;

   230

   231

		v->string_id = STR_SV_AIRCRAFT_NAME;

   232

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

   233

   234

//		v->load_unload_time_rem = 0;

   235

//		v->progress = 0;

   236

		v->last_station_visited = INVALID_STATION;

   237

//		v->destination_coords = 0;

   238

   239

		v->max_speed = avi->max_speed;

   240

		v->acceleration = avi->acceleration;

   241

		v->engine_type = p1;

   242

   243

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

   244

		v->value = value;

   245

   246

		u->subtype = 4;

   247

   248

		e = GetEngine(p1);

   249

		v->reliability = e->reliability;

   250

		v->reliability_spd_dec = e->reliability_spd_dec;

   251

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

   252

   253

		_new_aircraft_id = v->index;

   255

   256

		v->u.air.pos = MAX_ELEMENTS;

   257

   258

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

   259

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

   260

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

   261

		 * of all depots, it is simple */

   262

		{

   263

			const Station* st = GetStation(_m[tile].m2);

   264

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

   265

			uint i;

   266

   267

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

   268

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

   269

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

   270

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

   271

					break;

   272

				}

   273

			}

   274

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

   275

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

   276

		}

   277

   278

		v->u.air.state = HANGAR;

   279

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

   280

		v->u.air.targetairport = _m[tile].m2;

   281

		v->next = u;

   282

   283

		v->service_interval = _patches.servint_aircraft;

   284

   285

		v->date_of_last_service = _date;

   286

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

   287

   288

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

   289

   290

		VehiclePositionChanged(v);

   291

		VehiclePositionChanged(u);

   292

   293

		// Aircraft with 3 vehicles (chopper)?

   294

		if (v->subtype == 0) {

   295

			w = vl[2];

   296

   297

			u->next = w;

   298

   299

			w->type = VEH_Aircraft;

   300

			w->direction = 0;

   301

			w->owner = _current_player;

   302

			w->x_pos = v->x_pos;

   303

			w->y_pos = v->y_pos;

   304

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

   305

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

   306

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

   307

			w->z_height = 1;

   308

			w->vehstatus = VS_HIDDEN | VS_UNCLICKABLE;

   309

			w->subtype = 6;

   310

			w->cur_image = SPR_ROTOR_STOPPED;

   311

			VehiclePositionChanged(w);

   312

		}

   313

   314

		InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   315

		RebuildVehicleLists();

   316

		InvalidateWindow(WC_COMPANY, v->owner);

   317

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

   318

	}

   319

   320

	return value;

   321

}

   322

   323

bool IsAircraftHangarTile(TileIndex tile)

   324

{

   325

	// 0x56 - hangar facing other way international airport (86)

   326

	// 0x20 - hangar large airport (32)

   327

	// 0x41 - hangar small airport (65)

   328

	return IsTileType(tile, MP_STATION) &&

   329

				(_m[tile].m5 == 32 || _m[tile].m5 == 65 || _m[tile].m5 == 86);

   330

}

   331

   332

bool CheckStoppedInHangar(const Vehicle* v)

   333

{

   334

	if (!(v->vehstatus & VS_STOPPED) || !IsAircraftHangarTile(v->tile)) {

   335

		_error_message = STR_A01B_AIRCRAFT_MUST_BE_STOPPED;

   336

		return false;

   337

	}

   338

   339

	return true;

   340

}

   341

   342

   343

static void DoDeleteAircraft(Vehicle *v)

   344

{

   345

	DeleteWindowById(WC_VEHICLE_VIEW, v->index);

   346

	RebuildVehicleLists();

   347

	InvalidateWindow(WC_COMPANY, v->owner);

   348

	DeleteVehicleChain(v);

   349

	InvalidateWindowClasses(WC_AIRCRAFT_LIST);

   350

}

   351

   352

/** Sell an aircraft.

   353

 * @param x,y unused

   354

 * @param p1 vehicle ID to be sold

   355

 * @param p2 unused

   356

 */

   357

int32 CmdSellAircraft(int x, int y, uint32 flags, uint32 p1, uint32 p2)

   358

{

   359

	Vehicle *v;

   360

   361

	if (!IsVehicleIndex(p1)) return CMD_ERROR;

   362

   363

	v = GetVehicle(p1);

   364

   365

	if (v->type != VEH_Aircraft || !CheckOwnership(v->owner) || !CheckStoppedInHangar(v))

   366

		return CMD_ERROR;

   367

   368

	SET_EXPENSES_TYPE(EXPENSES_NEW_VEHICLES);

   369

   370

	if (flags & DC_EXEC) {

   371

		// Invalidate depot

   372

		InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   373

		DoDeleteAircraft(v);

   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 x,y unused

   382

 * @param p1 aircraft ID to start/stop

   383

 * @param p2 unused

   384

 */

   385

int32 CmdStartStopAircraft(int x, int y, 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

		v->vehstatus ^= VS_STOPPED;

   401

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

   402

		InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   403

		InvalidateWindowClasses(WC_AIRCRAFT_LIST);

   404

	}

   405

   406

	return 0;

   407

}

   408

   409

/** Send an aircraft to the hangar.

   410

 * @param x,y unused

   411

 * @param p1 vehicle ID to send to the hangar

   412

 * @param p2 various bitmasked elements

   413

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

   414

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

   415

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

   416

 */

   417

int32 CmdSendAircraftToHangar(int x, int y, uint32 flags, uint32 p1, uint32 p2)

   418

{

   419

	Vehicle *v;

   420

   421

	if (!IsVehicleIndex(p1)) return CMD_ERROR;

   422

   423

	v = GetVehicle(p1);

   424

   425

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

   426

   427

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

   428

		if (flags & DC_EXEC) {

   429

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

   430

			v->current_order.type = OT_DUMMY;

   431

			v->current_order.flags = 0;

   432

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

   433

		}

   434

	} else {

   435

		bool next_airport_has_hangar = true;

   436

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

   437

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

   438

		const Station *st = GetStation(next_airport_index);

   439

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

   440

		// it surely doesn't have any hangars

   441

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

   442

			StationID station;

   443

   444

			if (p2 != 0) return CMD_ERROR;

   445

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

   446

			station = FindNearestHangar(v);

   447

   448

			next_airport_has_hangar = false;

   449

			if (station == INVALID_STATION) return CMD_ERROR;

   450

			st = GetStation(station);

   451

			next_airport_index = station;

   452

   453

		}

   454

   455

		if (flags & DC_EXEC) {

   456

			v->current_order.type = OT_GOTO_DEPOT;

   457

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

   458

			v->current_order.station = next_airport_index;

   459

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

   460

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

   461

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

   462

				AircraftNextAirportPos_and_Order(v);

   463

				v->u.air.targetairport = next_airport_index;

   464

			}

   465

		}

   466

	}

   467

   468

	return 0;

   469

}

   470

   471

/** Change the service interval for aircraft.

   472

 * @param x,y unused

   473

 * @param p1 vehicle ID that is being service-interval-changed

   474

 * @param p2 new service interval

   475

 */

   476

int32 CmdChangeAircraftServiceInt(int x, int y, uint32 flags, uint32 p1, uint32 p2)

   477

{

   478

	Vehicle *v;

   479

	uint16 serv_int = GetServiceIntervalClamped(p2); /* Double check the service interval from the user-input */

   480

   481

	if (serv_int != p2 || !IsVehicleIndex(p1)) return CMD_ERROR;

   482

   483

	v = GetVehicle(p1);

   484

   485

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

   486

   487

	if (flags & DC_EXEC) {

   488

		v->service_interval = serv_int;

   489

		InvalidateWindowWidget(WC_VEHICLE_DETAILS, v->index, 7);

   490

	}

   491

   492

	return 0;

   493

}

   494

   495

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

   496

 * @param x,y unused

   497

 * @param p1 vehicle ID of the aircraft to refit

   498

 * @param p2 various bitstuffed elements

   499

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

   500

 * - p2 = (bit 8)   - skip check for stopped in hangar, used by autoreplace (p2 & 0x100)

   501

 * @todo p2 bit8 check <b>NEEDS TO GO</b>