# aircraft.h

Go to the documentation of this file.

    00001 /* $Id$ */
    00002
    00003 /*
    00004  * This file is part of OpenTTD.
    00005  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
    00006  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
    00007  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
    00008  */
    00009
    00012 #ifndef AIRCRAFT_H
    00013 #define AIRCRAFT_H
    00014
    00015 #include "station_map.h"
    00016 #include "vehicle_base.h"
    00017
    00018 struct Aircraft;
    00019
    00021 enum AircraftSubType {
    00022   AIR_HELICOPTER = 0,
    00023   AIR_AIRCRAFT   = 2,
    00024   AIR_SHADOW     = 4,
    00025   AIR_ROTOR      = 6,
    00026 };
    00027
    00029 enum VehicleAirFlags {
    00030   VAF_DEST_TOO_FAR = 0,
    00031 };
    00032
    00033
    00034 void HandleAircraftEnterHangar(Aircraft *v);
    00035 void GetAircraftSpriteSize(EngineID engine, uint &width, uint &height, EngineImageType image_type);
    00036 void UpdateAirplanesOnNewStation(const Station *st);
    00037 void UpdateAircraftCache(Aircraft *v, bool update_range = false);
    00038
    00039 void AircraftLeaveHangar(Aircraft *v, Direction exit_dir);
    00040 void AircraftNextAirportPos_and_Order(Aircraft *v);
    00041 void SetAircraftPosition(Aircraft *v, int x, int y, int z);
    00042 int GetAircraftFlyingAltitude(const Aircraft *v);
    00043
    00045 struct AircraftCache {
    00046   uint32 cached_max_range_sqr;
    00047   uint16 cached_max_range;
    00048 };
    00049
    00053 struct Aircraft FINAL : public SpecializedVehicle<Aircraft, VEH_AIRCRAFT> {
    00054   uint16 crashed_counter;
    00055   byte pos;
    00056   byte previous_pos;
    00057   StationID targetairport;
    00058   byte state;
    00059   DirectionByte last_direction;
    00060   byte number_consecutive_turns;
    00061   byte turn_counter;
    00062   byte flags;
    00063
    00064   AircraftCache acache;
    00065
    00067   Aircraft() : SpecializedVehicleBase() {}
    00069   virtual ~Aircraft() { this->PreDestructor(); }
    00070
    00071   void MarkDirty();
    00072   void UpdateDeltaXY(Direction direction);
    00073   ExpensesType GetExpenseType(bool income) const { return income ? EXPENSES_AIRCRAFT_INC : EXPENSES_AIRCRAFT_RUN; }
    00074   bool IsPrimaryVehicle() const                  { return this->IsNormalAircraft(); }
    00075   SpriteID GetImage(Direction direction, EngineImageType image_type) const;
    00076   int GetDisplaySpeed() const    { return this->cur_speed; }
    00077   int GetDisplayMaxSpeed() const { return this->vcache.cached_max_speed; }
    00078   int GetSpeedOldUnits() const   { return this->vcache.cached_max_speed * 10 / 128; }
    00079   Money GetRunningCost() const;
    00080   bool IsInDepot() const { return (this->vehstatus & VS_HIDDEN) != 0 && IsHangarTile(this->tile); }
    00081   bool Tick();
    00082   void OnNewDay();
    00083   uint Crash(bool flooded = false);
    00084   TileIndex GetOrderStationLocation(StationID station);
    00085   bool FindClosestDepot(TileIndex *location, DestinationID *destination, bool *reverse);
    00086
    00093   inline bool IsNormalAircraft() const
    00094   {
    00095     /* To be fully correct the commented out functionality is the proper one,
    00096      * but since value can only be 0 or 2, it is sufficient to only check <= 2
    00097      * return (this->subtype == AIR_HELICOPTER) || (this->subtype == AIR_AIRCRAFT); */
    00098     return this->subtype <= AIR_AIRCRAFT;
    00099   }
    00100
    00105   uint16 GetRange() const
    00106   {
    00107     return this->acache.cached_max_range;
    00108   }
    00109 };
    00110
    00114 #define FOR_ALL_AIRCRAFT(var) FOR_ALL_VEHICLES_OF_TYPE(Aircraft, var)
    00115
    00116 SpriteID GetRotorImage(const Aircraft *v, EngineImageType image_type);
    00117
    00118 Station *GetTargetAirportIfValid(const Aircraft *v);
    00119
    00120 #endif /* AIRCRAFT_H */