vehicle_func.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 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 "track_type.h"
00023 #include "livery.h"
00024 #include "cargotype.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 static const int VEHICLE_PROFIT_MIN_AGE = DAYS_IN_YEAR * 2; 
00031 static const Money VEHICLE_PROFIT_THRESHOLD = 10000;        
00032 
00033 typedef Vehicle *VehicleFromPosProc(Vehicle *v, void *data);
00034 
00035 void VehicleServiceInDepot(Vehicle *v);
00036 uint CountVehiclesInChain(const Vehicle *v);
00037 void FindVehicleOnPos(TileIndex tile, void *data, VehicleFromPosProc *proc);
00038 void FindVehicleOnPosXY(int x, int y, void *data, VehicleFromPosProc *proc);
00039 bool HasVehicleOnPos(TileIndex tile, void *data, VehicleFromPosProc *proc);
00040 bool HasVehicleOnPosXY(int x, int y, void *data, VehicleFromPosProc *proc);
00041 void CallVehicleTicks();
00042 uint8 CalcPercentVehicleFilled(const Vehicle *v, StringID *colour);
00043 
00044 void VehicleLengthChanged(const Vehicle *u);
00045 
00046 byte VehicleRandomBits();
00047 void ResetVehicleHash();
00048 void ResetVehicleColourMap();
00049 
00050 byte GetBestFittingSubType(Vehicle *v_from, Vehicle *v_for, CargoID dest_cargo_type);
00051 
00052 void ViewportAddVehicles(DrawPixelInfo *dpi);
00053 
00054 void ShowNewGrfVehicleError(EngineID engine, StringID part1, StringID part2, GRFBugs bug_type, bool critical);
00055 CommandCost TunnelBridgeIsFree(TileIndex tile, TileIndex endtile, const Vehicle *ignore = NULL);
00056 
00057 void DecreaseVehicleValue(Vehicle *v);
00058 void CheckVehicleBreakdown(Vehicle *v);
00059 void AgeVehicle(Vehicle *v);
00060 void VehicleEnteredDepotThisTick(Vehicle *v);
00061 
00062 void VehicleUpdatePosition(Vehicle *v);
00063 void VehicleUpdateViewport(Vehicle *v, bool dirty);
00064 void VehicleUpdatePositionAndViewport(Vehicle *v);
00065 void MarkSingleVehicleDirty(const Vehicle *v);
00066 
00067 UnitID GetFreeUnitNumber(VehicleType type);
00068 
00069 void VehicleEnterDepot(Vehicle *v);
00070 
00071 bool CanBuildVehicleInfrastructure(VehicleType type);
00072 
00074 struct GetNewVehiclePosResult {
00075   int x, y;  
00076   TileIndex old_tile; 
00077   TileIndex new_tile; 
00078 };
00079 
00080 GetNewVehiclePosResult GetNewVehiclePos(const Vehicle *v);
00081 Direction GetDirectionTowards(const Vehicle *v, int x, int y);
00082 
00088 static inline bool IsCompanyBuildableVehicleType(VehicleType type)
00089 {
00090   switch (type) {
00091     case VEH_TRAIN:
00092     case VEH_ROAD:
00093     case VEH_SHIP:
00094     case VEH_AIRCRAFT:
00095       return true;
00096 
00097     default: return false;
00098   }
00099 }
00100 
00106 static inline bool IsCompanyBuildableVehicleType(const BaseVehicle *v)
00107 {
00108   return IsCompanyBuildableVehicleType(v->type);
00109 }
00110 
00111 LiveryScheme GetEngineLiveryScheme(EngineID engine_type, EngineID parent_engine_type, const Vehicle *v);
00112 const struct Livery *GetEngineLivery(EngineID engine_type, CompanyID company, EngineID parent_engine_type, const Vehicle *v, byte livery_setting);
00113 
00114 SpriteID GetEnginePalette(EngineID engine_type, CompanyID company);
00115 SpriteID GetVehiclePalette(const Vehicle *v);
00116 
00117 extern const uint32 _veh_build_proc_table[];
00118 extern const uint32 _veh_sell_proc_table[];
00119 extern const uint32 _veh_refit_proc_table[];
00120 extern const uint32 _send_to_depot_proc_table[];
00121 
00122 /* Functions to find the right command for certain vehicle type */
00123 static inline uint32 GetCmdBuildVeh(VehicleType type)
00124 {
00125   return _veh_build_proc_table[type];
00126 }
00127 
00128 static inline uint32 GetCmdBuildVeh(const BaseVehicle *v)
00129 {
00130   return GetCmdBuildVeh(v->type);
00131 }
00132 
00133 static inline uint32 GetCmdSellVeh(VehicleType type)
00134 {
00135   return _veh_sell_proc_table[type];
00136 }
00137 
00138 static inline uint32 GetCmdSellVeh(const BaseVehicle *v)
00139 {
00140   return GetCmdSellVeh(v->type);
00141 }
00142 
00143 static inline uint32 GetCmdRefitVeh(VehicleType type)
00144 {
00145   return _veh_refit_proc_table[type];
00146 }
00147 
00148 static inline uint32 GetCmdRefitVeh(const BaseVehicle *v)
00149 {
00150   return GetCmdRefitVeh(v->type);
00151 }
00152 
00153 static inline uint32 GetCmdSendToDepot(VehicleType type)
00154 {
00155   return _send_to_depot_proc_table[type];
00156 }
00157 
00158 static inline uint32 GetCmdSendToDepot(const BaseVehicle *v)
00159 {
00160   return GetCmdSendToDepot(v->type);
00161 }
00162 
00163 CommandCost EnsureNoVehicleOnGround(TileIndex tile);
00164 CommandCost EnsureNoTrainOnTrackBits(TileIndex tile, TrackBits track_bits);
00165 
00166 extern VehicleID _new_vehicle_id;
00167 extern uint16 _returned_refit_capacity;
00168 extern uint16 _returned_mail_refit_capacity;
00169 
00170 bool CanVehicleUseStation(EngineID engine_type, const struct Station *st);
00171 bool CanVehicleUseStation(const Vehicle *v, const struct Station *st);
00172 
00173 void ReleaseDisastersTargetingVehicle(VehicleID vehicle);
00174 
00175 typedef SmallVector<VehicleID, 2> VehicleSet;
00176 void GetVehicleSet(VehicleSet &set, Vehicle *v, uint8 num_vehicles);
00177 
00178 void CheckCargoCapacity(Vehicle *v);
00179 
00180 #endif /* VEHICLE_FUNC_H */