rail.h

Go to the documentation of this file.
00001 /* $Id: rail.h 22652 2011-07-10 20:25:59Z 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 RAIL_H
00013 #define RAIL_H
00014 
00015 #include "rail_type.h"
00016 #include "track_type.h"
00017 #include "gfx_type.h"
00018 #include "core/bitmath_func.hpp"
00019 #include "economy_func.h"
00020 #include "slope_type.h"
00021 #include "strings_type.h"
00022 #include "date_type.h"
00023 
00025 enum RailTypeFlags {
00026   RTF_CATENARY          = 0,                           
00027   RTF_NO_LEVEL_CROSSING = 1,                           
00028 
00029   RTFB_NONE              = 0,                          
00030   RTFB_CATENARY          = 1 << RTF_CATENARY,          
00031   RTFB_NO_LEVEL_CROSSING = 1 << RTF_NO_LEVEL_CROSSING, 
00032 };
00033 DECLARE_ENUM_AS_BIT_SET(RailTypeFlags)
00034 
00035 struct SpriteGroup;
00036 
00038 enum RailTypeSpriteGroup {
00039   RTSG_CURSORS,     
00040   RTSG_OVERLAY,     
00041   RTSG_GROUND,      
00042   RTSG_TUNNEL,      
00043   RTSG_WIRES,       
00044   RTSG_PYLONS,      
00045   RTSG_BRIDGE,      
00046   RTSG_CROSSING,    
00047   RTSG_DEPOT,       
00048   RTSG_FENCES,      
00049   RTSG_END,
00050 };
00051 
00056 enum RailTrackOffset {
00057   RTO_X,            
00058   RTO_Y,            
00059   RTO_N,            
00060   RTO_S,            
00061   RTO_E,            
00062   RTO_W,            
00063   RTO_SLOPE_NE,     
00064   RTO_SLOPE_SE,     
00065   RTO_SLOPE_SW,     
00066   RTO_SLOPE_NW,     
00067   RTO_CROSSING_XY,  
00068   RTO_JUNCTION_SW,  
00069   RTO_JUNCTION_NE,  
00070   RTO_JUNCTION_SE,  
00071   RTO_JUNCTION_NW,  
00072   RTO_JUNCTION_NSEW,
00073 };
00074 
00078 enum RailTrackBridgeOffset {
00079   RTBO_X,     
00080   RTBO_Y,     
00081   RTBO_SLOPE, 
00082 };
00083 
00088 enum RailFenceOffset {
00089   RFO_FLAT_X,
00090   RFO_FLAT_Y,
00091   RFO_FLAT_VERT,
00092   RFO_FLAT_HORZ,
00093   RFO_SLOPE_SW,
00094   RFO_SLOPE_SE,
00095   RFO_SLOPE_NE,
00096   RFO_SLOPE_NW,
00097 };
00098 
00102 struct RailtypeInfo {
00107   struct {
00108     SpriteID track_y;      
00109     SpriteID track_ns;     
00110     SpriteID ground;       
00111     SpriteID single_x;     
00112     SpriteID single_y;     
00113     SpriteID single_n;     
00114     SpriteID single_s;     
00115     SpriteID single_e;     
00116     SpriteID single_w;     
00117     SpriteID single_sloped;
00118     SpriteID crossing;     
00119     SpriteID tunnel;       
00120   } base_sprites;
00121 
00126   struct {
00127     SpriteID build_ns_rail;      
00128     SpriteID build_x_rail;       
00129     SpriteID build_ew_rail;      
00130     SpriteID build_y_rail;       
00131     SpriteID auto_rail;          
00132     SpriteID build_depot;        
00133     SpriteID build_tunnel;       
00134     SpriteID convert_rail;       
00135   } gui_sprites;
00136 
00137   struct {
00138     CursorID rail_ns;    
00139     CursorID rail_swne;  
00140     CursorID rail_ew;    
00141     CursorID rail_nwse;  
00142     CursorID autorail;   
00143     CursorID depot;      
00144     CursorID tunnel;     
00145     CursorID convert;    
00146   } cursor;
00147 
00148   struct {
00149     StringID toolbar_caption;
00150     StringID menu_text;
00151     StringID build_caption;
00152     StringID replace_text;
00153     StringID new_loco;
00154   } strings;
00155 
00157   SpriteID snow_offset;
00158 
00160   RailTypes powered_railtypes;
00161 
00163   RailTypes compatible_railtypes;
00164 
00168   SpriteID bridge_offset;
00169 
00173   byte fallback_railtype;
00174 
00178   byte curve_speed;
00179 
00183   RailTypeFlags flags;
00184 
00188   uint16 cost_multiplier;
00189 
00193   uint8 acceleration_type;
00194 
00198   uint16 max_speed;
00199 
00203   RailTypeLabel label;
00204 
00208   byte map_colour;
00209 
00217   Date introduction_date;
00218 
00223   RailTypes introduction_required_railtypes;
00224 
00228   RailTypes introduces_railtypes;
00229 
00233   byte sorting_order;
00234 
00238   const GRFFile *grffile[RTSG_END];
00239 
00243   const SpriteGroup *group[RTSG_END];
00244 
00245   inline bool UsesOverlay() const
00246   {
00247     return this->group[RTSG_GROUND] != NULL;
00248   }
00249 
00257   inline uint GetRailtypeSpriteOffset() const
00258   {
00259     return 82 * this->fallback_railtype;
00260   }
00261 };
00262 
00263 
00269 static inline const RailtypeInfo *GetRailTypeInfo(RailType railtype)
00270 {
00271   extern RailtypeInfo _railtypes[RAILTYPE_END];
00272   assert(railtype < RAILTYPE_END);
00273   return &_railtypes[railtype];
00274 }
00275 
00284 static inline bool IsCompatibleRail(RailType enginetype, RailType tiletype)
00285 {
00286   return HasBit(GetRailTypeInfo(enginetype)->compatible_railtypes, tiletype);
00287 }
00288 
00297 static inline bool HasPowerOnRail(RailType enginetype, RailType tiletype)
00298 {
00299   return HasBit(GetRailTypeInfo(enginetype)->powered_railtypes, tiletype);
00300 }
00301 
00307 static inline bool RailNoLevelCrossings(RailType rt)
00308 {
00309   return HasBit(GetRailTypeInfo(rt)->flags, RTF_NO_LEVEL_CROSSING);
00310 }
00311 
00317 static inline Money RailBuildCost(RailType railtype)
00318 {
00319   assert(railtype < RAILTYPE_END);
00320   return (_price[PR_BUILD_RAIL] * GetRailTypeInfo(railtype)->cost_multiplier) >> 3;
00321 }
00322 
00328 static inline Money RailClearCost(RailType railtype)
00329 {
00330   /* Clearing rail in fact earns money, but if the build cost is set
00331    * very low then a loophole exists where money can be made.
00332    * In this case we limit the removal earnings to 3/4s of the build
00333    * cost.
00334    */
00335   assert(railtype < RAILTYPE_END);
00336   return max(_price[PR_CLEAR_RAIL], -RailBuildCost(railtype) * 3 / 4);
00337 }
00338 
00345 static inline Money RailConvertCost(RailType from, RailType to)
00346 {
00347   /* Get the costs for removing and building anew
00348    * A conversion can never be more costly */
00349   Money rebuildcost = RailBuildCost(to) + RailClearCost(from);
00350 
00351   /* Conversion between somewhat compatible railtypes:
00352    * Pay 1/8 of the target rail cost (labour costs) and additionally any difference in the
00353    * build costs, if the target type is more expensive (material upgrade costs).
00354    * Upgrade can never be more expensive than re-building. */
00355   if (HasPowerOnRail(from, to) || HasPowerOnRail(to, from)) {
00356     Money upgradecost = RailBuildCost(to) / 8 + max((Money)0, RailBuildCost(to) - RailBuildCost(from));
00357     return min(upgradecost, rebuildcost);
00358   }
00359 
00360   /* make the price the same as remove + build new type for rail types
00361    * which are not compatible in any way */
00362   return rebuildcost;
00363 }
00364 
00365 void DrawTrainDepotSprite(int x, int y, int image, RailType railtype);
00366 int TicksToLeaveDepot(const Train *v);
00367 
00368 Foundation GetRailFoundation(Slope tileh, TrackBits bits);
00369 
00370 
00371 bool HasRailtypeAvail(const CompanyID company, const RailType railtype);
00372 bool ValParamRailtype(const RailType rail);
00373 
00374 RailTypes AddDateIntroducedRailTypes(RailTypes current, Date date);
00375 
00376 RailType GetBestRailtype(const CompanyID company);
00377 RailTypes GetCompanyRailtypes(const CompanyID c);
00378 
00379 RailType GetRailTypeByLabel(RailTypeLabel label);
00380 
00381 void ResetRailTypes();
00382 void InitRailTypes();
00383 RailType AllocateRailType(RailTypeLabel label);
00384 
00385 #endif /* RAIL_H */