1

/* $Id$ */

     2

     3

#include "stdafx.h"

     4

#include "openttd.h"

     5

#include "debug.h"

     6

#include "functions.h"

     7

#include "station_map.h"

     8

#include "table/strings.h"

     9

#include "map.h"

    10

#include "tile.h"

    11

#include "vehicle.h"

    12

#include "depot.h"

    13

#include "engine.h"

    14

#include "command.h"

    15

#include "station.h"

    16

#include "news.h"

    17

#include "sound.h"

    18

#include "player.h"

    19

#include "airport.h"

    20

#include "vehicle_gui.h"

    21

#include "table/sprites.h"

    22

#include "newgrf_engine.h"

    23

    24

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

    25

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

    26

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

    27

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

    28

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

    29

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

    30

static void CrashAirplane(Vehicle *v);

    31

    32

static void AircraftNextAirportPos_and_Order(Vehicle *v);

    33

static byte GetAircraftFlyingAltitude(const Vehicle *v);

    34

    35

static const SpriteID _aircraft_sprite[] = {

    36

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

    37

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

    38

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

    39

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

    40

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

    41

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

    42

	0x0EBD, 0x0EC5

    43

};

    44

    45

/* Helicopter rotor animation states */

    46

enum HelicopterRotorStates {

    47

	HRS_ROTOR_STOPPED,

    48

	HRS_ROTOR_MOVING_1,

    49

	HRS_ROTOR_MOVING_2,

    50

	HRS_ROTOR_MOVING_3,

    51

};

    52

    53

/* Find the nearest hangar to v

    54

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

    55

 * airports (like helipads only)

    56

 */

    57

static StationID FindNearestHangar(const Vehicle *v)

    58

{

    59

	const Station *st;

    60

	uint best = 0;

    61

	StationID index = INVALID_STATION;

    62

    63

	FOR_ALL_STATIONS(st) {

    64

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

    65

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

    66

			uint distance;

    67

    68

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

    69

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

    70

					!_cheats.no_jetcrash.value)

    71

				continue;

    72

    73

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

    74

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

    75

				best = distance;

    76

				index = st->index;

    77

			}

    78

		}

    79

	}

    80

	return index;

    81

}

    82

    83

#if 0

    84

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

    85

static bool HaveHangarInOrderList(Vehicle *v)

    86

{

    87

	const Order *order;

    88

    89

	FOR_VEHICLE_ORDERS(v, order) {

    90

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

    91

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

    92

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

    93

			// it surely doesn't have any hangars

    94

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

    95

				return true;

    96

		}

    97

	}

    98

    99

	return false;

   100

}

   101

#endif

   102

   103

int GetAircraftImage(const Vehicle* v, Direction direction)

   104

{

   105

	int spritenum = v->spritenum;

   106

   107

	if (is_custom_sprite(spritenum)) {

   108

		int sprite = GetCustomVehicleSprite(v, direction);

   109

   110

		if (sprite != 0) return sprite;

   111

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

   112

	}

   113

	return direction + _aircraft_sprite[spritenum];

   114

}

   115

   116

SpriteID GetRotorImage(const Vehicle *v)

   117

{

   118

	const Vehicle *w;

   119

   120

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

   121

   122

	w = v->next->next;

   123

	if (is_custom_sprite(v->spritenum)) {

   124

		SpriteID spritenum = GetCustomRotorSprite(v);

   125

		if (spritenum != 0) return spritenum;

   126

	}

   127

   128

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

   129

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

   130

}

   131

   132

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

   133

{

   134

	int spritenum = AircraftVehInfo(engine)->image_index;

   135

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

   136

   137

	if (is_custom_sprite(spritenum)) {

   138

		sprite = GetCustomVehicleIcon(engine, DIR_W);

   139

		if (!sprite)

   140

			spritenum = orig_aircraft_vehicle_info[engine - AIRCRAFT_ENGINES_INDEX].image_index;

   141

	}

   142

   143

	DrawSprite(sprite | image_ormod, x, y);

   144

   145

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

   146

		SpriteID rotor_sprite = GetCustomRotorIcon(engine);

   147

		if (rotor_sprite == 0) rotor_sprite = SPR_ROTOR_STOPPED;

   148

		DrawSprite(rotor_sprite, x, y - 5);

   149

	}

   150

}

   151

   152

static int32 EstimateAircraftCost(EngineID engine_type)

   153

{

   154

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

   155

}

   156

   157

   158

/** Build an aircraft.

   159

 * @param tile tile of depot where aircraft is built

   160

 * @param p1 aircraft type being built (engine)

   161

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

   162

 */

   163

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

   164

{

   165

	int32 value;

   166

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

   167

	UnitID unit_num;

   168

	const AircraftVehicleInfo *avi;

   169

	Engine *e;

   170

   171

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

   172

   173

	value = EstimateAircraftCost(p1);

   174

   175

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

   176

	if (flags & DC_QUERY_COST) return value;

   177

   178

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

   179

   180

	SET_EXPENSES_TYPE(EXPENSES_NEW_VEHICLES);

   181

   182

	avi = AircraftVehInfo(p1);

   183

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

   184

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

   185

			IsOrderPoolFull()) {

   186

		return_cmd_error(STR_00E1_TOO_MANY_VEHICLES_IN_GAME);

   187

	}

   188

   189

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

   190

	if (unit_num > _patches.max_aircraft)

   191

		return_cmd_error(STR_00E1_TOO_MANY_VEHICLES_IN_GAME);

   192

   193

	if (flags & DC_EXEC) {

   194

		uint x;

   195

		uint y;

   196

   197

		v = vl[0];

   198

		u = vl[1];

   199

   200

		v->unitnumber = unit_num;

   201

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

   202

		v->direction = 3;

   203

   204

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

   205

   206

		v->tile = tile;

   207

//		u->tile = 0;

   208

   209

		x = TileX(tile) * TILE_SIZE + 5;

   210

		y = TileY(tile) * TILE_SIZE + 3;

   211

   212

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

   213

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

   214

   215

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

   216

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

   217

   218

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

   219

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

   220

   221

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

   222

		v->z_height = 5;

   223

   224

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

   225

		u->z_height = 1;

   226

   227

		v->vehstatus = VS_HIDDEN | VS_STOPPED | VS_DEFPAL;

   228

		u->vehstatus = VS_HIDDEN | VS_UNCLICKABLE | VS_DISASTER;

   229

   230

		v->spritenum = avi->image_index;

   231

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

   232

   233

		v->cargo_cap = avi->passenger_capacity;

   234

		u->cargo_cap = avi->mail_capacity;

   235

   236

		v->cargo_type = CT_PASSENGERS;

   237

		u->cargo_type = CT_MAIL;

   238

   239

		v->cargo_subtype = 0;

   240

   241

		v->string_id = STR_SV_AIRCRAFT_NAME;

   242

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

   243

   244

//		v->load_unload_time_rem = 0;

   245

//		v->progress = 0;

   246

		v->last_station_visited = INVALID_STATION;

   247

//		v->destination_coords = 0;

   248

   249

		v->max_speed = avi->max_speed;

   250

		v->acceleration = avi->acceleration;

   251

		v->engine_type = p1;

   252

   253

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

   254

		v->value = value;

   255

   256

		u->subtype = 4;

   257

   258

		e = GetEngine(p1);

   259

		v->reliability = e->reliability;

   260

		v->reliability_spd_dec = e->reliability_spd_dec;

   261

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

   262

   263

		_new_vehicle_id = v->index;

   264

   265

		v->u.air.pos = MAX_ELEMENTS;

   266

   267

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

   268

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

   269

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

   270

		 * of all depots, it is simple */

   271

		{

   272

			const Station* st = GetStationByTile(tile);

   273

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

   274

			uint i;

   275

   276

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

   277

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

   278

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

   279

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

   280

					break;

   281

				}

   282

			}

   283

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

   284

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

   285

		}

   286

   287

		v->u.air.state = HANGAR;

   288

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

   289

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

   290

		v->next = u;

   291

   292

		v->service_interval = _patches.servint_aircraft;

   293

   294

		v->date_of_last_service = _date;

   295

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

   296

   297

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

   298

   299

		v->random_bits = VehicleRandomBits();

   300

		u->random_bits = VehicleRandomBits();

   301

   302

		VehiclePositionChanged(v);

   303

		VehiclePositionChanged(u);

   304

   305

		// Aircraft with 3 vehicles (chopper)?

   306

		if (v->subtype == 0) {

   307

			w = vl[2];

   308

   309

			u->next = w;

   310

   311

			w->type = VEH_Aircraft;

   312

			w->direction = 0;

   313

			w->owner = _current_player;

   314

			w->x_pos = v->x_pos;

   315

			w->y_pos = v->y_pos;

   316

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

   317

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

   318

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

   319

			w->z_height = 1;

   320

			w->vehstatus = VS_HIDDEN | VS_UNCLICKABLE;

   321

			w->spritenum = 0xFF;

   322

			w->subtype = 6;

   323

			w->cur_image = SPR_ROTOR_STOPPED;

   324

			w->random_bits = VehicleRandomBits();

   325

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

   326

			w->u.air.state = HRS_ROTOR_STOPPED;

   327

			VehiclePositionChanged(w);

   328

		}

   329

   330

		InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   331

		RebuildVehicleLists();

   332

		InvalidateWindow(WC_COMPANY, v->owner);

   333

		if (IsLocalPlayer())

   334

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

   335

	}

   336

   337

	return value;

   338

}

   339

   340

   341

bool CheckStoppedInHangar(const Vehicle* v)

   342

{

   343

	return v->vehstatus & VS_STOPPED && IsHangarTile(v->tile);

   344

}

   345

   346

   347

static void DoDeleteAircraft(Vehicle *v)

   348

{

   349

	DeleteWindowById(WC_VEHICLE_VIEW, v->index);

   350

	RebuildVehicleLists();

   351

	InvalidateWindow(WC_COMPANY, v->owner);

   352

	DeleteVehicleChain(v);

   353

	InvalidateWindowClasses(WC_AIRCRAFT_LIST);

   354

}

   355

   356

/** Sell an aircraft.

   357

 * @param tile unused

   358

 * @param p1 vehicle ID to be sold

   359

 * @param p2 unused

   360

 */

   361

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

   362

{

   363

	Vehicle *v;

   364

   365

	if (!IsVehicleIndex(p1)) return CMD_ERROR;

   366

   367

	v = GetVehicle(p1);

   368

   369

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

   370

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

   371

   372

	SET_EXPENSES_TYPE(EXPENSES_NEW_VEHICLES);

   373

   374

	if (flags & DC_EXEC) {

   375

		// Invalidate depot

   376

		InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   377

		DoDeleteAircraft(v);

   378

		if (IsLocalPlayer())

   379

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

   380

	}

   381

   382

	return -(int32)v->value;

   383

}

   384

   385

/** Start/Stop an aircraft.

   386

 * @param tile unused

   387

 * @param p1 aircraft ID to start/stop

   388

 * @param p2 unused

   389

 */

   390

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

   391

{

   392

	Vehicle *v;

   393

   394

	if (!IsVehicleIndex(p1)) return CMD_ERROR;

   395

   396

	v = GetVehicle(p1);

   397

   398

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

   399

   400

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

   401

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

   402

		return_cmd_error(STR_A017_AIRCRAFT_IS_IN_FLIGHT);

   403

   404

	if (flags & DC_EXEC) {

   405

		if (v->vehstatus & VS_STOPPED && IsHangarTile(v->tile)) {

   406

			DeleteVehicleNews(p1, STR_A014_AIRCRAFT_IS_WAITING_IN);

   407

		}

   408

   409

		v->vehstatus ^= VS_STOPPED;

   410

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

   411

		InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   412

		InvalidateWindowClasses(WC_AIRCRAFT_LIST);

   413

	}

   414

   415

	return 0;

   416

}

   417

   418

/** Send an aircraft to the hangar.

   419

 * @param tile unused

   420

 * @param p1 vehicle ID to send to the hangar

   421

 * @param p2 various bitmasked elements

   422

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

   423

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

   424

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

   425

 */

   426

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

   427

{

   428

	Vehicle *v;

   429

   430

	if (!IsVehicleIndex(p1)) return CMD_ERROR;

   431

   432

	v = GetVehicle(p1);

   433

   434

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

   435

   436

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

   437

		if (flags & DC_EXEC) {

   438

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

   439

			v->current_order.type = OT_DUMMY;

   440

			v->current_order.flags = 0;

   441

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

   442

		}

   443

	} else {

   444

		bool next_airport_has_hangar = true;

   445

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

   446

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

   447

		const Station *st = GetStation(next_airport_index);

   448

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

   449

		// it surely doesn't have any hangars

   450

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

   451

			StationID station;

   452

   453

			if (p2 != 0) return CMD_ERROR;

   454

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

   455

			station = FindNearestHangar(v);

   456

   457

			next_airport_has_hangar = false;

   458

			if (station == INVALID_STATION) return CMD_ERROR;

   459

			st = GetStation(station);

   460

			next_airport_index = station;

   461

   462

		}

   463

   464

		if (flags & DC_EXEC) {

   465

			v->current_order.type = OT_GOTO_DEPOT;

   466

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

   467

			v->current_order.station = next_airport_index;

   468

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

   469

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

   470

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

   471

				AircraftNextAirportPos_and_Order(v);

   472

				v->u.air.targetairport = next_airport_index;

   473

			}

   474

		}

   475

	}

   476

   477

	return 0;

   478

}

   479

   480

   481

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

   482

 * @param tile unused

   483

 * @param p1 vehicle ID of the aircraft to refit

   484

 * @param p2 various bitstuffed elements

   485

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

   486

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

   487

 */

   488

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

   489

{

   490

	Vehicle *v;

   491

	int pass, mail;

   492

	int32 cost;

   493

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

   494

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

   495

	const AircraftVehicleInfo *avi;

   496