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 ResetVehiclePosHash();
00048 void ResetVehicleColourMap();
00049 
00050 byte GetBestFittingSubType(Vehicle *v_from, Vehicle *v_for, CargoID dest_cargo_type = INVALID_CARGO);
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 VehicleMove(Vehicle *v, bool update_viewport);
00063 void MarkSingleVehicleDirty(const Vehicle *v);
00064 
00065 UnitID GetFreeUnitNumber(VehicleType type);
00066 
00067 void VehicleEnterDepot(Vehicle *v);
00068 
00069 bool CanBuildVehicleInfrastructure(VehicleType type);
00070 
00072 struct GetNewVehiclePosResult {
00073   int x, y;  
00074   TileIndex old_tile; 
00075   TileIndex new_tile; 
00076 };
00077 
00078 GetNewVehiclePosResult GetNewVehiclePos(const Vehicle *v);
00079 Direction GetDirectionTowards(const Vehicle *v, int x, int y);
00080 
00086 static inline bool IsCompanyBuildableVehicleType(VehicleType type)
00087 {
00088   switch (type) {
00089     case VEH_TRAIN:
00090     case VEH_ROAD:
00091     case VEH_SHIP:
00092     case VEH_AIRCRAFT:
00093       return true;
00094 
00095     default: return false;
00096   }
00097 }
00098 
00104 static inline bool IsCompanyBuildableVehicleType(const BaseVehicle *v)
00105 {
00106   return IsCompanyBuildableVehicleType(v->type);
00107 }
00108 
00109 LiveryScheme GetEngineLiveryScheme(EngineID engine_type, EngineID parent_engine_type, const Vehicle *v);
00110 const struct Livery *GetEngineLivery(EngineID engine_type, CompanyID company, EngineID parent_engine_type, const Vehicle *v, byte livery_setting);
00111 
00112 SpriteID GetEnginePalette(EngineID engine_type, CompanyID company);
00113 SpriteID GetVehiclePalette(const Vehicle *v);
00114 
00115 extern const uint32 _veh_build_proc_table[];
00116 extern const uint32 _veh_sell_proc_table[];
00117 extern const uint32 _veh_refit_proc_table[];
00118 extern const uint32 _send_to_depot_proc_table[];
00119 
00120 /* Functions to find the right command for certain vehicle type */
00121 static inline uint32 GetCmdBuildVeh(VehicleType type)
00122 {
00123   return _veh_build_proc_table[type];
00124 }
00125 
00126 static inline uint32 GetCmdBuildVeh(const BaseVehicle *v)
00127 {
00128   return GetCmdBuildVeh(v->type);
00129 }
00130 
00131 static inline uint32 GetCmdSellVeh(VehicleType type)
00132 {
00133   return _veh_sell_proc_table[type];
00134 }
00135 
00136 static inline uint32 GetCmdSellVeh(const BaseVehicle *v)
00137 {
00138   return GetCmdSellVeh(v->type);
00139 }
00140 
00141 static inline uint32 GetCmdRefitVeh(VehicleType type)
00142 {
00143   return _veh_refit_proc_table[type];
00144 }
00145 
00146 static inline uint32 GetCmdRefitVeh(const BaseVehicle *v)
00147 {
00148   return GetCmdRefitVeh(v->type);
00149 }
00150 
00151 static inline uint32 GetCmdSendToDepot(VehicleType type)
00152 {
00153   return _send_to_depot_proc_table[type];
00154 }
00155 
00156 static inline uint32 GetCmdSendToDepot(const BaseVehicle *v)
00157 {
00158   return GetCmdSendToDepot(v->type);
00159 }
00160 
00161 CommandCost EnsureNoVehicleOnGround(TileIndex tile);
00162 CommandCost EnsureNoTrainOnTrackBits(TileIndex tile, TrackBits track_bits);
00163 
00164 extern VehicleID _new_vehicle_id;
00165 extern uint16 _returned_refit_capacity;
00166 extern uint16 _returned_mail_refit_capacity;
00167 
00168 bool CanVehicleUseStation(EngineID engine_type, const struct Station *st);
00169 bool CanVehicleUseStation(const Vehicle *v, const struct Station *st);
00170 
00171 void ReleaseDisastersTargetingVehicle(VehicleID vehicle);
00172 
00173 typedef SmallVector<VehicleID, 2> VehicleSet;
00174 void GetVehicleSet(VehicleSet &set, Vehicle *v, uint8 num_vehicles);
00175 
00176 #endif /* VEHICLE_FUNC_H */