aircraft.h

Go to the documentation of this file.

/* $Id: aircraft.h 14343 2008-09-16 15:15:41Z smatz $ */

#ifndef AIRCRAFT_H
#define AIRCRAFT_H

#include "station_map.h"
#include "station_base.h"
#include "vehicle_base.h"
#include "engine_func.h"
#include "engine_base.h"

enum AircraftSubType {
  AIR_HELICOPTER = 0, 
  AIR_AIRCRAFT   = 2, 
  AIR_SHADOW     = 4, 
  AIR_ROTOR      = 6  
};


static inline bool IsNormalAircraft(const Vehicle *v)
{
  assert(v->type == VEH_AIRCRAFT);
  /* To be fully correct the commented out functionality is the proper one,
   * but since value can only be 0 or 2, it is sufficient to only check <= 2
   * return (v->subtype == AIR_HELICOPTER) || (v->subtype == AIR_AIRCRAFT); */
  return v->subtype <= AIR_AIRCRAFT;
}

static inline bool CanAircraftUseStation(EngineID engine, const Station *st)
{
  const AirportFTAClass *apc = st->Airport();
  const AircraftVehicleInfo *avi = AircraftVehInfo(engine);

  return (apc->flags & (avi->subtype & AIR_CTOL ? AirportFTAClass::AIRPLANES : AirportFTAClass::HELICOPTERS)) != 0;
}

static inline bool CanAircraftUseStation(EngineID engine, TileIndex tile)
{
  return CanAircraftUseStation(engine, GetStationByTile(tile));
}

uint16 AircraftDefaultCargoCapacity(CargoID cid, const AircraftVehicleInfo *avi);

void CcBuildAircraft(bool success, TileIndex tile, uint32 p1, uint32 p2);

void HandleAircraftEnterHangar(Vehicle *v);

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

void UpdateAirplanesOnNewStation(const Station *st);

void UpdateAircraftCache(Vehicle *v);

struct Aircraft : public Vehicle {
  Aircraft() { this->type = VEH_AIRCRAFT; }

  virtual ~Aircraft() { this->PreDestructor(); }

  const char *GetTypeString() const { return "aircraft"; }
  void MarkDirty();
  void UpdateDeltaXY(Direction direction);
  ExpensesType GetExpenseType(bool income) const { return income ? EXPENSES_AIRCRAFT_INC : EXPENSES_AIRCRAFT_RUN; }
  bool IsPrimaryVehicle() const { return IsNormalAircraft(this); }
  SpriteID GetImage(Direction direction) const;
  int GetDisplaySpeed() const { return this->cur_speed * 10 / 16; }
  int GetDisplayMaxSpeed() const { return this->max_speed * 10 / 16; }
  Money GetRunningCost() const { return AircraftVehInfo(this->engine_type)->running_cost * _price.aircraft_running; }
  bool IsInDepot() const { return (this->vehstatus & VS_HIDDEN) != 0 && IsHangarTile(this->tile); }
  void Tick();
  void OnNewDay();
  TileIndex GetOrderStationLocation(StationID station);
  bool FindClosestDepot(TileIndex *location, DestinationID *destination, bool *reverse);
};

Station *GetTargetAirportIfValid(const Vehicle *v);

#endif /* AIRCRAFT_H */