vehicle_func.h

Go to the documentation of this file.
00001 /* $Id: vehicle_func.h 21561 2010-12-21 13:52:10Z terkhen $ */
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 VEHICLE_FUNC_H
00013 #define VEHICLE_FUNC_H
00014 
00015 #include "gfx_type.h"
00016 #include "direction_type.h"
00017 #include "command_type.h"
00018 #include "vehicle_type.h"
00019 #include "engine_type.h"
00020 #include "transport_type.h"
00021 #include "newgrf_config.h"
00022 #include "company_type.h"
00023 #include "track_type.h"
00024 #include "livery.h"
00025 
00026 #define is_custom_sprite(x) (x >= 0xFD)
00027 #define IS_CUSTOM_FIRSTHEAD_SPRITE(x) (x == 0xFD)
00028 #define IS_CUSTOM_SECONDHEAD_SPRITE(x) (x == 0xFE)
00029 
00030 typedef Vehicle *VehicleFromPosProc(Vehicle *v, void *data);
00031 
00032 void VehicleServiceInDepot(Vehicle *v);
00033 uint CountVehiclesInChain(const Vehicle *v);
00034 void CountCompanyVehicles(CompanyID cid, uint counts[4]);
00035 void FindVehicleOnPos(TileIndex tile, void *data, VehicleFromPosProc *proc);
00036 void FindVehicleOnPosXY(int x, int y, void *data, VehicleFromPosProc *proc);
00037 bool HasVehicleOnPos(TileIndex tile, void *data, VehicleFromPosProc *proc);
00038 bool HasVehicleOnPosXY(int x, int y, void *data, VehicleFromPosProc *proc);
00039 void CallVehicleTicks();
00040 uint8 CalcPercentVehicleFilled(const Vehicle *v, StringID *colour);
00041 
00042 byte VehicleRandomBits();
00043 void ResetVehiclePosHash();
00044 void ResetVehicleColourMap();
00045 
00046 byte GetBestFittingSubType(Vehicle *v_from, Vehicle *v_for);
00047 
00048 void ViewportAddVehicles(DrawPixelInfo *dpi);
00049 
00050 void ShowNewGrfVehicleError(EngineID engine, StringID part1, StringID part2, GRFBugs bug_type, bool critical);
00051 CommandCost TunnelBridgeIsFree(TileIndex tile, TileIndex endtile, const Vehicle *ignore = NULL);
00052 
00053 void DecreaseVehicleValue(Vehicle *v);
00054 void CheckVehicleBreakdown(Vehicle *v);
00055 void AgeVehicle(Vehicle *v);
00056 void VehicleEnteredDepotThisTick(Vehicle *v);
00057 
00058 void VehicleMove(Vehicle *v, bool update_viewport);
00059 void MarkSingleVehicleDirty(const Vehicle *v);
00060 
00061 UnitID GetFreeUnitNumber(VehicleType type);
00062 
00063 void VehicleEnterDepot(Vehicle *v);
00064 
00065 bool CanBuildVehicleInfrastructure(VehicleType type);
00066 
00068 struct GetNewVehiclePosResult {
00069   int x, y;  
00070   TileIndex old_tile; 
00071   TileIndex new_tile; 
00072 };
00073 
00074 GetNewVehiclePosResult GetNewVehiclePos(const Vehicle *v);
00075 Direction GetDirectionTowards(const Vehicle *v, int x, int y);
00076 
00082 static inline bool IsCompanyBuildableVehicleType(VehicleType type)
00083 {
00084   switch (type) {
00085     case VEH_TRAIN:
00086     case VEH_ROAD:
00087     case VEH_SHIP:
00088     case VEH_AIRCRAFT:
00089       return true;
00090 
00091     default: return false;
00092   }
00093 }
00094 
00100 static inline bool IsCompanyBuildableVehicleType(const BaseVehicle *v)
00101 {
00102   return IsCompanyBuildableVehicleType(v->type);
00103 }
00104 
00105 LiveryScheme GetEngineLiveryScheme(EngineID engine_type, EngineID parent_engine_type, const Vehicle *v);
00106 const struct Livery *GetEngineLivery(EngineID engine_type, CompanyID company, EngineID parent_engine_type, const Vehicle *v, byte livery_setting);
00107 
00114 SpriteID GetEnginePalette(EngineID engine_type, CompanyID company);
00115 
00121 SpriteID GetVehiclePalette(const Vehicle *v);
00122 
00123 uint GetVehicleCapacity(const Vehicle *v, uint16 *mail_capacity = NULL);
00124 
00125 extern const uint32 _veh_build_proc_table[];
00126 extern const uint32 _veh_sell_proc_table[];
00127 extern const uint32 _veh_refit_proc_table[];
00128 extern const uint32 _send_to_depot_proc_table[];
00129 
00130 /* Functions to find the right command for certain vehicle type */
00131 static inline uint32 GetCmdBuildVeh(VehicleType type)
00132 {
00133   return _veh_build_proc_table[type];
00134 }
00135 
00136 static inline uint32 GetCmdBuildVeh(const BaseVehicle *v)
00137 {
00138   return GetCmdBuildVeh(v->type);
00139 }
00140 
00141 static inline uint32 GetCmdSellVeh(VehicleType type)
00142 {
00143   return _veh_sell_proc_table[type];
00144 }
00145 
00146 static inline uint32 GetCmdSellVeh(const BaseVehicle *v)
00147 {
00148   return GetCmdSellVeh(v->type);
00149 }
00150 
00151 static inline uint32 GetCmdRefitVeh(VehicleType type)
00152 {
00153   return _veh_refit_proc_table[type];
00154 }
00155 
00156 static inline uint32 GetCmdRefitVeh(const BaseVehicle *v)
00157 {
00158   return GetCmdRefitVeh(v->type);
00159 }
00160 
00161 static inline uint32 GetCmdSendToDepot(VehicleType type)
00162 {
00163   return _send_to_depot_proc_table[type];
00164 }
00165 
00166 static inline uint32 GetCmdSendToDepot(const BaseVehicle *v)
00167 {
00168   return GetCmdSendToDepot(v->type);
00169 }
00170 
00171 CommandCost EnsureNoVehicleOnGround(TileIndex tile);
00172 CommandCost EnsureNoTrainOnTrackBits(TileIndex tile, TrackBits track_bits);
00173 void StopAllVehicles();
00174 
00175 extern VehicleID _vehicle_id_ctr_day;
00176 extern VehicleID _new_vehicle_id;
00177 extern uint16 _returned_refit_capacity;
00178 extern uint16 _returned_mail_refit_capacity;
00179 extern byte _age_cargo_skip_counter;
00180 
00181 bool CanVehicleUseStation(EngineID engine_type, const struct Station *st);
00182 bool CanVehicleUseStation(const Vehicle *v, const struct Station *st);
00183 
00184 void ReleaseDisastersTargetingVehicle(VehicleID vehicle);
00185 
00186 typedef SmallVector<VehicleID, 2> VehicleSet;
00187 void GetVehicleSet(VehicleSet &set, Vehicle *v, uint8 num_vehicles);
00188 
00189 #endif /* VEHICLE_FUNC_H */

Generated on Sun Jan 9 16:02:04 2011 for OpenTTD by  doxygen 1.6.1