rail.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 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 #include "core/math_func.hpp"
00024 
00026 enum RailTypeFlags {
00027   RTF_CATENARY          = 0,                           
00028   RTF_NO_LEVEL_CROSSING = 1,                           
00029 
00030   RTFB_NONE              = 0,                          
00031   RTFB_CATENARY          = 1 << RTF_CATENARY,          
00032   RTFB_NO_LEVEL_CROSSING = 1 << RTF_NO_LEVEL_CROSSING, 
00033 };
00034 DECLARE_ENUM_AS_BIT_SET(RailTypeFlags)
00035 
00036 struct SpriteGroup;
00037 
00039 enum RailTypeSpriteGroup {
00040   RTSG_CURSORS,     
00041   RTSG_OVERLAY,     
00042   RTSG_GROUND,      
00043   RTSG_TUNNEL,      
00044   RTSG_WIRES,       
00045   RTSG_PYLONS,      
00046   RTSG_BRIDGE,      
00047   RTSG_CROSSING,    
00048   RTSG_DEPOT,       
00049   RTSG_FENCES,      
00050   RTSG_END,
00051 };
00052 
00057 enum RailTrackOffset {
00058   RTO_X,            
00059   RTO_Y,            
00060   RTO_N,            
00061   RTO_S,            
00062   RTO_E,            
00063   RTO_W,            
00064   RTO_SLOPE_NE,     
00065   RTO_SLOPE_SE,     
00066   RTO_SLOPE_SW,     
00067   RTO_SLOPE_NW,     
00068   RTO_CROSSING_XY,  
00069   RTO_JUNCTION_SW,  
00070   RTO_JUNCTION_NE,  
00071   RTO_JUNCTION_SE,  
00072   RTO_JUNCTION_NW,  
00073   RTO_JUNCTION_NSEW,
00074 };
00075 
00079 enum RailTrackBridgeOffset {
00080   RTBO_X,     
00081   RTBO_Y,     
00082   RTBO_SLOPE, 
00083 };
00084 
00089 enum RailFenceOffset {
00090   RFO_FLAT_X,
00091   RFO_FLAT_Y,
00092   RFO_FLAT_VERT,
00093   RFO_FLAT_HORZ,
00094   RFO_SLOPE_SW,
00095   RFO_SLOPE_SE,
00096   RFO_SLOPE_NE,
00097   RFO_SLOPE_NW,
00098 };
00099 
00103 struct RailtypeInfo {
00108   struct {
00109     SpriteID track_y;      
00110     SpriteID track_ns;     
00111     SpriteID ground;       
00112     SpriteID single_x;     
00113     SpriteID single_y;     
00114     SpriteID single_n;     
00115     SpriteID single_s;     
00116     SpriteID single_e;     
00117     SpriteID single_w;     
00118     SpriteID single_sloped;
00119     SpriteID crossing;     
00120     SpriteID tunnel;       
00121   } base_sprites;
00122 
00127   struct {
00128     SpriteID build_ns_rail;      
00129     SpriteID build_x_rail;       
00130     SpriteID build_ew_rail;      
00131     SpriteID build_y_rail;       
00132     SpriteID auto_rail;          
00133     SpriteID build_depot;        
00134     SpriteID build_tunnel;       
00135     SpriteID convert_rail;       
00136   } gui_sprites;
00137 
00138   struct {
00139     CursorID rail_ns;    
00140     CursorID rail_swne;  
00141     CursorID rail_ew;    
00142     CursorID rail_nwse;  
00143     CursorID autorail;   
00144     CursorID depot;      
00145     CursorID tunnel;     
00146     CursorID convert;    
00147   } cursor;
00148 
00149   struct {
00150     StringID toolbar_caption;
00151     StringID menu_text;
00152     StringID build_caption;
00153     StringID replace_text;
00154     StringID new_loco;
00155   } strings;
00156 
00158   SpriteID snow_offset;
00159 
00161   RailTypes powered_railtypes;
00162 
00164   RailTypes compatible_railtypes;
00165 
00169   SpriteID bridge_offset;
00170 
00174   byte fallback_railtype;
00175 
00179   byte curve_speed;
00180 
00184   RailTypeFlags flags;
00185 
00189   uint16 cost_multiplier;
00190 
00194   uint16 maintenance_multiplier;
00195 
00199   uint8 acceleration_type;
00200 
00204   uint16 max_speed;
00205 
00209   RailTypeLabel label;
00210 
00214   byte map_colour;
00215 
00223   Date introduction_date;
00224 
00229   RailTypes introduction_required_railtypes;
00230 
00234   RailTypes introduces_railtypes;
00235 
00239   byte sorting_order;
00240 
00244   const SpriteGroup *group[RTSG_END];
00245 
00246   inline bool UsesOverlay() const
00247   {
00248     return this->group[RTSG_GROUND] != NULL;
00249   }
00250 
00258   inline uint GetRailtypeSpriteOffset() const
00259   {
00260     return 82 * this->fallback_railtype;
00261   }
00262 };
00263 
00264 
00270 static inline const RailtypeInfo *GetRailTypeInfo(RailType railtype)
00271 {
00272   extern RailtypeInfo _railtypes[RAILTYPE_END];
00273   assert(railtype < RAILTYPE_END);
00274   return &_railtypes[railtype];
00275 }
00276 
00285 static inline bool IsCompatibleRail(RailType enginetype, RailType tiletype)
00286 {
00287   return HasBit(GetRailTypeInfo(enginetype)->compatible_railtypes, tiletype);
00288 }
00289 
00298 static inline bool HasPowerOnRail(RailType enginetype, RailType tiletype)
00299 {
00300   return HasBit(GetRailTypeInfo(enginetype)->powered_railtypes, tiletype);
00301 }
00302 
00308 static inline bool RailNoLevelCrossings(RailType rt)
00309 {
00310   return HasBit(GetRailTypeInfo(rt)->flags, RTF_NO_LEVEL_CROSSING);
00311 }
00312 
00318 static inline Money RailBuildCost(RailType railtype)
00319 {
00320   assert(railtype < RAILTYPE_END);
00321   return (_price[PR_BUILD_RAIL] * GetRailTypeInfo(railtype)->cost_multiplier) >> 3;
00322 }
00323 
00329 static inline Money RailClearCost(RailType railtype)
00330 {
00331   /* Clearing rail in fact earns money, but if the build cost is set
00332    * very low then a loophole exists where money can be made.
00333    * In this case we limit the removal earnings to 3/4s of the build
00334    * cost.
00335    */
00336   assert(railtype < RAILTYPE_END);
00337   return max(_price[PR_CLEAR_RAIL], -RailBuildCost(railtype) * 3 / 4);
00338 }
00339 
00346 static inline Money RailConvertCost(RailType from, RailType to)
00347 {
00348   /* Get the costs for removing and building anew
00349    * A conversion can never be more costly */
00350   Money rebuildcost = RailBuildCost(to) + RailClearCost(from);
00351 
00352   /* Conversion between somewhat compatible railtypes:
00353    * Pay 1/8 of the target rail cost (labour costs) and additionally any difference in the
00354    * build costs, if the target type is more expensive (material upgrade costs).
00355    * Upgrade can never be more expensive than re-building. */
00356   if (HasPowerOnRail(from, to) || HasPowerOnRail(to, from)) {
00357     Money upgradecost = RailBuildCost(to) / 8 + max((Money)0, RailBuildCost(to) - RailBuildCost(from));
00358     return min(upgradecost, rebuildcost);
00359   }
00360 
00361   /* make the price the same as remove + build new type for rail types
00362    * which are not compatible in any way */
00363   return rebuildcost;
00364 }
00365 
00372 static inline Money RailMaintenanceCost(RailType railtype, uint32 num)
00373 {
00374   assert(railtype < RAILTYPE_END);
00375   return (_price[PR_INFRASTRUCTURE_RAIL] * GetRailTypeInfo(railtype)->maintenance_multiplier * num * (1 + IntSqrt(num))) >> 11; // 4 bits fraction for the multiplier and 7 bits scaling.
00376 }
00377 
00383 static inline Money SignalMaintenanceCost(uint32 num)
00384 {
00385   return (_price[PR_INFRASTRUCTURE_RAIL] * 15 * num * (1 + IntSqrt(num))) >> 8; // 1 bit fraction for the multiplier and 7 bits scaling.
00386 }
00387 
00388 void DrawTrainDepotSprite(int x, int y, int image, RailType railtype);
00389 int TicksToLeaveDepot(const Train *v);
00390 
00391 Foundation GetRailFoundation(Slope tileh, TrackBits bits);
00392 
00393 
00394 bool HasRailtypeAvail(const CompanyID company, const RailType railtype);
00395 bool ValParamRailtype(const RailType rail);
00396 
00397 RailTypes AddDateIntroducedRailTypes(RailTypes current, Date date);
00398 
00399 RailType GetBestRailtype(const CompanyID company);
00400 RailTypes GetCompanyRailtypes(const CompanyID c);
00401 
00402 RailType GetRailTypeByLabel(RailTypeLabel label);
00403 
00404 void ResetRailTypes();
00405 void InitRailTypes();
00406 RailType AllocateRailType(RailTypeLabel label);
00407 
00408 #endif /* RAIL_H */