aircraft.h

Go to the documentation of this file.
00001 /* $Id: aircraft.h 21844 2011-01-18 22:17:15Z rubidium $ */
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 
00028 
00029 void HandleAircraftEnterHangar(Aircraft *v);
00030 void GetAircraftSpriteSize(EngineID engine, uint &width, uint &height);
00031 void UpdateAirplanesOnNewStation(const Station *st);
00032 void UpdateAircraftCache(Aircraft *v);
00033 
00034 void AircraftLeaveHangar(Aircraft *v);
00035 void AircraftNextAirportPos_and_Order(Aircraft *v);
00036 void SetAircraftPosition(Aircraft *v, int x, int y, int z);
00037 byte GetAircraftFlyingAltitude(const Aircraft *v);
00038 
00042 struct Aircraft : public SpecializedVehicle<Aircraft, VEH_AIRCRAFT> {
00043   uint16 crashed_counter;        
00044   byte pos;                      
00045   byte previous_pos;             
00046   StationID targetairport;       
00047   byte state;                    
00048   DirectionByte last_direction;
00049   byte number_consecutive_turns; 
00050   byte turn_counter;             
00051 
00053   Aircraft() : SpecializedVehicle<Aircraft, VEH_AIRCRAFT>() {}
00055   virtual ~Aircraft() { this->PreDestructor(); }
00056 
00057   const char *GetTypeString() const { return "aircraft"; }
00058   void MarkDirty();
00059   void UpdateDeltaXY(Direction direction);
00060   ExpensesType GetExpenseType(bool income) const { return income ? EXPENSES_AIRCRAFT_INC : EXPENSES_AIRCRAFT_RUN; }
00061   bool IsPrimaryVehicle() const                  { return this->IsNormalAircraft(); }
00062   SpriteID GetImage(Direction direction) const;
00063   int GetDisplaySpeed() const    { return this->cur_speed; }
00064   int GetDisplayMaxSpeed() const { return this->vcache.cached_max_speed; }
00065   int GetSpeedOldUnits() const   { return this->vcache.cached_max_speed * 10 / 128; }
00066   Money GetRunningCost() const;
00067   bool IsInDepot() const { return (this->vehstatus & VS_HIDDEN) != 0 && IsHangarTile(this->tile); }
00068   bool Tick();
00069   void OnNewDay();
00070   uint Crash(bool flooded = false);
00071   TileIndex GetOrderStationLocation(StationID station);
00072   bool FindClosestDepot(TileIndex *location, DestinationID *destination, bool *reverse);
00073 
00080   FORCEINLINE bool IsNormalAircraft() const
00081   {
00082     /* To be fully correct the commented out functionality is the proper one,
00083      * but since value can only be 0 or 2, it is sufficient to only check <= 2
00084      * return (this->subtype == AIR_HELICOPTER) || (this->subtype == AIR_AIRCRAFT); */
00085     return this->subtype <= AIR_AIRCRAFT;
00086   }
00087 };
00088 
00092 #define FOR_ALL_AIRCRAFT(var) FOR_ALL_VEHICLES_OF_TYPE(Aircraft, var)
00093 
00094 SpriteID GetRotorImage(const Aircraft *v);
00095 
00096 Station *GetTargetAirportIfValid(const Aircraft *v);
00097 
00098 #endif /* AIRCRAFT_H */

Generated on Thu Jan 20 22:57:31 2011 for OpenTTD by  doxygen 1.6.1