2005-07-24 14:12:37 +00:00
|
|
|
/* $Id$ */
|
|
|
|
|
2009-08-21 20:21:05 +00:00
|
|
|
/*
|
|
|
|
* This file is part of OpenTTD.
|
|
|
|
* 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.
|
|
|
|
* 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.
|
|
|
|
* 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/>.
|
|
|
|
*/
|
|
|
|
|
2008-05-06 15:11:33 +00:00
|
|
|
/** @file rail.h Rail specific functions. */
|
2005-07-29 19:35:23 +00:00
|
|
|
|
(svn r2448) General cleanup of rail related code, more to follow.
* Add: rail.[ch] for rail-related enums and wrapper functions.
* Codechange: Removed dozens of magic numbers with below enums.
* Codechange: Rewrote CheckTrackCombination().
* Add: TILE_SIZE, TILE_PIXELS and TILE_HEIGHT constants.
* Add: enums RailTileType, RailTileSubtype, SignalType to mask against the map arrays.
* Add: enums Track, TrackBits, Trackdir, TrackdirBits for railway track data. (Note that the old RAIL_BIT constants are replaced by TRACK_BIT ones).
* Add: enums Direction and DiagDirection
* Codechange: Moved a bunch of track(dir) related lookup arrays from npf.[ch] to rail.[ch].
* Codechange: move RailType enum from tile.h to rail.h.
* Add: Wrapper functions for masking signal status in the map arrays: SignalAlongTrackdir, SignalAgainstTrackdir and SignalOnTrack.
* Add: Wrapper functions to access rail tiles, using above enums
* Add: Wrapper functions to modify tracks, trackdirs, directions, etc.
* Add: Wrapper functions for all lookup arrays in rail.[ch] (Arrays are still used in parts of the code)
* Codechange: Renamed some variables and arguments to better represent what they contain (railbit -> track, bits -> trackdirbits, etc.).
* Codechange: Don't use FindLandscapeHeight() in CmdRemoveSingleRail(), since it returns way too much info. Use GetTileSlope() instead.
* Codechange: [NPF] Removed some unused globals and code from npf.c.
2005-06-16 18:04:02 +00:00
|
|
|
#ifndef RAIL_H
|
|
|
|
#define RAIL_H
|
|
|
|
|
2007-12-18 20:10:21 +00:00
|
|
|
#include "rail_type.h"
|
|
|
|
#include "track_type.h"
|
2007-12-21 22:50:51 +00:00
|
|
|
#include "vehicle_type.h"
|
2007-12-23 10:56:02 +00:00
|
|
|
#include "gfx_type.h"
|
2007-12-21 19:21:21 +00:00
|
|
|
#include "core/bitmath_func.hpp"
|
2007-12-21 21:50:46 +00:00
|
|
|
#include "economy_func.h"
|
2008-05-08 16:48:29 +00:00
|
|
|
#include "slope_type.h"
|
2009-06-24 17:39:54 +00:00
|
|
|
#include "strings_type.h"
|
(svn r2448) General cleanup of rail related code, more to follow.
* Add: rail.[ch] for rail-related enums and wrapper functions.
* Codechange: Removed dozens of magic numbers with below enums.
* Codechange: Rewrote CheckTrackCombination().
* Add: TILE_SIZE, TILE_PIXELS and TILE_HEIGHT constants.
* Add: enums RailTileType, RailTileSubtype, SignalType to mask against the map arrays.
* Add: enums Track, TrackBits, Trackdir, TrackdirBits for railway track data. (Note that the old RAIL_BIT constants are replaced by TRACK_BIT ones).
* Add: enums Direction and DiagDirection
* Codechange: Moved a bunch of track(dir) related lookup arrays from npf.[ch] to rail.[ch].
* Codechange: move RailType enum from tile.h to rail.h.
* Add: Wrapper functions for masking signal status in the map arrays: SignalAlongTrackdir, SignalAgainstTrackdir and SignalOnTrack.
* Add: Wrapper functions to access rail tiles, using above enums
* Add: Wrapper functions to modify tracks, trackdirs, directions, etc.
* Add: Wrapper functions for all lookup arrays in rail.[ch] (Arrays are still used in parts of the code)
* Codechange: Renamed some variables and arguments to better represent what they contain (railbit -> track, bits -> trackdirbits, etc.).
* Codechange: Don't use FindLandscapeHeight() in CmdRemoveSingleRail(), since it returns way too much info. Use GetTileSlope() instead.
* Codechange: [NPF] Removed some unused globals and code from npf.c.
2005-06-16 18:04:02 +00:00
|
|
|
|
2008-04-08 07:19:29 +00:00
|
|
|
enum RailTypeFlag {
|
|
|
|
RTF_CATENARY = 0, ///< Set if the rail type should have catenary drawn
|
|
|
|
};
|
|
|
|
|
|
|
|
enum RailTypeFlags {
|
|
|
|
RTFB_NONE = 0,
|
|
|
|
RTFB_CATENARY = 1 << RTF_CATENARY,
|
|
|
|
};
|
|
|
|
DECLARE_ENUM_AS_BIT_SET(RailTypeFlags);
|
|
|
|
|
2009-01-13 08:39:25 +00:00
|
|
|
/** Offsets from base sprite for fence sprites. These are in the order of
|
|
|
|
* the sprites in the original data files.
|
|
|
|
*/
|
|
|
|
enum RailFenceOffset {
|
|
|
|
RFO_FLAT_X,
|
|
|
|
RFO_FLAT_Y,
|
|
|
|
RFO_FLAT_VERT,
|
|
|
|
RFO_FLAT_HORZ,
|
|
|
|
RFO_SLOPE_SW,
|
|
|
|
RFO_SLOPE_SE,
|
|
|
|
RFO_SLOPE_NE,
|
|
|
|
RFO_SLOPE_NW,
|
|
|
|
};
|
|
|
|
|
2005-07-29 21:36:02 +00:00
|
|
|
/** This struct contains all the info that is needed to draw and construct tracks.
|
|
|
|
*/
|
2007-03-07 12:11:48 +00:00
|
|
|
struct RailtypeInfo {
|
2005-08-03 11:08:13 +00:00
|
|
|
/** Struct containing the main sprites. @note not all sprites are listed, but only
|
|
|
|
* the ones used directly in the code */
|
2005-07-29 21:36:02 +00:00
|
|
|
struct {
|
|
|
|
SpriteID track_y; ///< single piece of rail in Y direction, with ground
|
|
|
|
SpriteID track_ns; ///< two pieces of rail in North and South corner (East-West direction)
|
|
|
|
SpriteID ground; ///< ground sprite for a 3-way switch
|
|
|
|
SpriteID single_y; ///< single piece of rail in Y direction, without ground
|
|
|
|
SpriteID single_x; ///< single piece of rail in X direction
|
|
|
|
SpriteID single_n; ///< single piece of rail in the northern corner
|
|
|
|
SpriteID single_s; ///< single piece of rail in the southern corner
|
|
|
|
SpriteID single_e; ///< single piece of rail in the eastern corner
|
|
|
|
SpriteID single_w; ///< single piece of rail in the western corner
|
2008-06-11 14:55:02 +00:00
|
|
|
SpriteID single_sloped;///< single piecs of rail for slopes
|
2005-10-13 16:00:14 +00:00
|
|
|
SpriteID crossing; ///< level crossing, rail in X direction
|
|
|
|
SpriteID tunnel; ///< tunnel sprites base
|
2005-07-29 21:36:02 +00:00
|
|
|
} base_sprites;
|
|
|
|
|
2005-08-03 11:08:13 +00:00
|
|
|
/** struct containing the sprites for the rail GUI. @note only sprites referred to
|
|
|
|
* directly in the code are listed */
|
|
|
|
struct {
|
|
|
|
SpriteID build_ns_rail; ///< button for building single rail in N-S direction
|
|
|
|
SpriteID build_x_rail; ///< button for building single rail in X direction
|
|
|
|
SpriteID build_ew_rail; ///< button for building single rail in E-W direction
|
|
|
|
SpriteID build_y_rail; ///< button for building single rail in Y direction
|
|
|
|
SpriteID auto_rail; ///< button for the autorail construction
|
|
|
|
SpriteID build_depot; ///< button for building depots
|
|
|
|
SpriteID build_tunnel; ///< button for building a tunnel
|
|
|
|
SpriteID convert_rail; ///< button for converting rail
|
|
|
|
} gui_sprites;
|
|
|
|
|
2005-10-14 08:11:18 +00:00
|
|
|
struct {
|
2007-08-03 12:29:56 +00:00
|
|
|
CursorID rail_ns; ///< Cursor for building rail in N-S direction
|
|
|
|
CursorID rail_swne; ///< Cursor for building rail in X direction
|
|
|
|
CursorID rail_ew; ///< Cursor for building rail in E-W direction
|
|
|
|
CursorID rail_nwse; ///< Cursor for building rail in Y direction
|
|
|
|
CursorID autorail; ///< Cursor for autorail tool
|
|
|
|
CursorID depot; ///< Cursor for building a depot
|
|
|
|
CursorID tunnel; ///< Cursor for building a tunnel
|
|
|
|
CursorID convert; ///< Cursor for converting track
|
2005-10-14 08:11:18 +00:00
|
|
|
} cursor;
|
|
|
|
|
2005-08-03 11:08:13 +00:00
|
|
|
struct {
|
|
|
|
StringID toolbar_caption;
|
2008-08-24 21:31:24 +00:00
|
|
|
StringID menu_text;
|
|
|
|
StringID build_caption;
|
|
|
|
StringID replace_text;
|
|
|
|
StringID new_loco;
|
2005-08-03 11:08:13 +00:00
|
|
|
} strings;
|
|
|
|
|
2005-07-29 21:36:02 +00:00
|
|
|
/** sprite number difference between a piece of track on a snowy ground and the corresponding one on normal ground */
|
|
|
|
SpriteID snow_offset;
|
|
|
|
|
2006-03-29 16:30:26 +00:00
|
|
|
/** bitmask to the OTHER railtypes on which an engine of THIS railtype generates power */
|
2008-01-09 21:05:03 +00:00
|
|
|
RailTypes powered_railtypes;
|
2006-03-29 16:30:26 +00:00
|
|
|
|
|
|
|
/** bitmask to the OTHER railtypes on which an engine of THIS railtype can physically travel */
|
2008-01-09 21:05:03 +00:00
|
|
|
RailTypes compatible_railtypes;
|
2005-07-31 22:53:57 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Offset between the current railtype and normal rail. This means that:<p>
|
|
|
|
* 1) All the sprites in a railset MUST be in the same order. This order
|
|
|
|
* is determined by normal rail. Check sprites 1005 and following for this order<p>
|
|
|
|
* 2) The position where the railtype is loaded must always be the same, otherwise
|
2007-04-04 01:35:16 +00:00
|
|
|
* the offset will fail.
|
2005-07-31 22:53:57 +00:00
|
|
|
* @note: Something more flexible might be desirable in the future.
|
|
|
|
*/
|
|
|
|
SpriteID total_offset;
|
2005-10-19 08:34:37 +00:00
|
|
|
|
|
|
|
/**
|
2006-06-27 21:25:53 +00:00
|
|
|
* Bridge offset
|
|
|
|
*/
|
2005-10-19 08:34:37 +00:00
|
|
|
SpriteID bridge_offset;
|
2006-04-11 10:45:06 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Offset to add to ground sprite when drawing custom waypoints / stations
|
|
|
|
*/
|
|
|
|
byte custom_ground_offset;
|
2008-01-01 14:00:31 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Multiplier for curve maximum speed advantage
|
|
|
|
*/
|
|
|
|
byte curve_speed;
|
2008-04-08 07:19:29 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Bit mask of rail type flags
|
|
|
|
*/
|
|
|
|
RailTypeFlags flags;
|
2008-08-24 23:10:23 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Cost multiplier for building this rail type
|
|
|
|
*/
|
|
|
|
uint8 cost_multiplier;
|
2009-02-08 18:11:06 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Unique 32 bit rail type identifier
|
|
|
|
*/
|
|
|
|
RailTypeLabel label;
|
2007-03-07 12:11:48 +00:00
|
|
|
};
|
2005-07-29 21:36:02 +00:00
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns a pointer to the Railtype information for a given railtype
|
|
|
|
* @param railtype the rail type which the information is requested for
|
|
|
|
* @return The pointer to the RailtypeInfo
|
|
|
|
*/
|
2005-07-29 22:13:04 +00:00
|
|
|
static inline const RailtypeInfo *GetRailTypeInfo(RailType railtype)
|
2005-07-29 21:36:02 +00:00
|
|
|
{
|
2007-02-26 22:32:21 +00:00
|
|
|
extern RailtypeInfo _railtypes[RAILTYPE_END];
|
2005-07-29 21:36:02 +00:00
|
|
|
assert(railtype < RAILTYPE_END);
|
2005-07-29 22:13:04 +00:00
|
|
|
return &_railtypes[railtype];
|
2005-07-29 21:36:02 +00:00
|
|
|
}
|
|
|
|
|
2005-07-03 13:02:54 +00:00
|
|
|
/**
|
|
|
|
* Checks if an engine of the given RailType can drive on a tile with a given
|
|
|
|
* RailType. This would normally just be an equality check, but for electric
|
|
|
|
* rails (which also support non-electric engines).
|
|
|
|
* @return Whether the engine can drive on this tile.
|
|
|
|
* @param enginetype The RailType of the engine we are considering.
|
|
|
|
* @param tiletype The RailType of the tile we are considering.
|
|
|
|
*/
|
|
|
|
static inline bool IsCompatibleRail(RailType enginetype, RailType tiletype)
|
|
|
|
{
|
2007-11-19 21:02:30 +00:00
|
|
|
return HasBit(GetRailTypeInfo(enginetype)->compatible_railtypes, tiletype);
|
2005-07-03 13:02:54 +00:00
|
|
|
}
|
|
|
|
|
2007-08-03 12:29:56 +00:00
|
|
|
/**
|
|
|
|
* Checks if an engine of the given RailType got power on a tile with a given
|
|
|
|
* RailType. This would normally just be an equality check, but for electric
|
|
|
|
* rails (which also support non-electric engines).
|
|
|
|
* @return Whether the engine got power on this tile.
|
|
|
|
* @param enginetype The RailType of the engine we are considering.
|
|
|
|
* @param tiletype The RailType of the tile we are considering.
|
|
|
|
*/
|
2006-03-29 16:30:26 +00:00
|
|
|
static inline bool HasPowerOnRail(RailType enginetype, RailType tiletype)
|
|
|
|
{
|
2007-11-19 21:02:30 +00:00
|
|
|
return HasBit(GetRailTypeInfo(enginetype)->powered_railtypes, tiletype);
|
2006-03-29 16:30:26 +00:00
|
|
|
}
|
|
|
|
|
2007-10-14 21:20:12 +00:00
|
|
|
/**
|
|
|
|
* Returns the cost of building the specified railtype.
|
|
|
|
* @param railtype The railtype being built.
|
|
|
|
* @return The cost multiplier.
|
|
|
|
*/
|
|
|
|
static inline Money RailBuildCost(RailType railtype)
|
|
|
|
{
|
|
|
|
assert(railtype < RAILTYPE_END);
|
2008-08-24 23:10:23 +00:00
|
|
|
return (_price.build_rail * GetRailTypeInfo(railtype)->cost_multiplier) >> 3;
|
2007-10-14 21:20:12 +00:00
|
|
|
}
|
|
|
|
|
2007-12-08 19:53:30 +00:00
|
|
|
/**
|
|
|
|
* Calculates the cost of rail conversion
|
|
|
|
* @param from The railtype we are converting from
|
|
|
|
* @param to The railtype we are converting to
|
|
|
|
* @return Cost per TrackBit
|
|
|
|
*/
|
|
|
|
static inline Money RailConvertCost(RailType from, RailType to)
|
|
|
|
{
|
|
|
|
/* rail -> el. rail
|
|
|
|
* calculate the price as 5 / 4 of (cost build el. rail) - (cost build rail)
|
|
|
|
* (the price of workers to get to place is that 1/4)
|
|
|
|
*/
|
|
|
|
if (HasPowerOnRail(from, to)) {
|
2008-08-24 23:29:58 +00:00
|
|
|
Money cost = ((RailBuildCost(to) - RailBuildCost(from)) * 5) >> 2;
|
|
|
|
if (cost != 0) return cost;
|
2007-12-08 19:53:30 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/* el. rail -> rail
|
|
|
|
* calculate the price as 1 / 4 of (cost build el. rail) - (cost build rail)
|
|
|
|
* (the price of workers is 1 / 4 + price of copper sold to a recycle center)
|
|
|
|
*/
|
|
|
|
if (HasPowerOnRail(to, from)) {
|
2008-08-24 23:29:58 +00:00
|
|
|
Money cost = (RailBuildCost(from) - RailBuildCost(to)) >> 2;
|
|
|
|
if (cost != 0) return cost;
|
2007-12-08 19:53:30 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/* make the price the same as remove + build new type */
|
|
|
|
return RailBuildCost(to) + _price.remove_rail;
|
|
|
|
}
|
|
|
|
|
2008-08-01 15:07:31 +00:00
|
|
|
Vehicle *UpdateTrainPowerProc(Vehicle *v, void *data);
|
2005-10-16 09:13:04 +00:00
|
|
|
void DrawTrainDepotSprite(int x, int y, int image, RailType railtype);
|
2008-08-01 15:07:31 +00:00
|
|
|
Vehicle *EnsureNoTrainOnTrackProc(Vehicle *v, void *data);
|
2009-05-22 22:55:41 +00:00
|
|
|
int TicksToLeaveDepot(const Train *v);
|
2006-03-29 16:30:26 +00:00
|
|
|
|
2007-07-26 16:51:10 +00:00
|
|
|
Foundation GetRailFoundation(Slope tileh, TrackBits bits);
|
2006-11-17 19:31:44 +00:00
|
|
|
|
|
|
|
|
2008-01-09 21:05:03 +00:00
|
|
|
/**
|
2008-09-30 20:39:50 +00:00
|
|
|
* Finds out if a company has a certain railtype available
|
|
|
|
* @param company the company in question
|
2008-01-09 21:05:03 +00:00
|
|
|
* @param railtype requested RailType
|
2008-09-30 20:39:50 +00:00
|
|
|
* @return true if company has requested RailType available
|
2008-01-09 21:05:03 +00:00
|
|
|
*/
|
2008-09-30 20:39:50 +00:00
|
|
|
bool HasRailtypeAvail(const CompanyID company, const RailType railtype);
|
2008-01-09 21:05:03 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Validate functions for rail building.
|
|
|
|
* @param rail the railtype to check.
|
2008-09-30 20:39:50 +00:00
|
|
|
* @return true if the current company may build the rail.
|
2008-01-09 21:05:03 +00:00
|
|
|
*/
|
|
|
|
bool ValParamRailtype(const RailType rail);
|
|
|
|
|
|
|
|
/**
|
2008-09-30 20:39:50 +00:00
|
|
|
* Returns the "best" railtype a company can build.
|
2008-01-09 21:05:03 +00:00
|
|
|
* As the AI doesn't know what the BEST one is, we have our own priority list
|
|
|
|
* here. When adding new railtypes, modify this function
|
2008-09-30 20:39:50 +00:00
|
|
|
* @param company the company "in action"
|
|
|
|
* @return The "best" railtype a company has available
|
2008-01-09 21:05:03 +00:00
|
|
|
*/
|
2008-09-30 20:39:50 +00:00
|
|
|
RailType GetBestRailtype(const CompanyID company);
|
2008-01-09 21:05:03 +00:00
|
|
|
|
|
|
|
/**
|
2008-09-30 20:39:50 +00:00
|
|
|
* Get the rail types the given company can build.
|
|
|
|
* @param company the company to get the rail types for.
|
2008-01-09 21:05:03 +00:00
|
|
|
* @return the rail types.
|
|
|
|
*/
|
2008-10-07 20:57:41 +00:00
|
|
|
RailTypes GetCompanyRailtypes(const CompanyID c);
|
2008-01-09 21:05:03 +00:00
|
|
|
|
2009-02-08 18:11:06 +00:00
|
|
|
/**
|
|
|
|
* Get the rail type for a given label.
|
|
|
|
* @param label the railtype label.
|
|
|
|
* @return the railtype.
|
|
|
|
*/
|
|
|
|
RailType GetRailTypeByLabel(RailTypeLabel label);
|
|
|
|
|
2008-08-24 23:00:11 +00:00
|
|
|
/**
|
|
|
|
* Reset all rail type information to its default values.
|
|
|
|
*/
|
|
|
|
void ResetRailTypes();
|
|
|
|
|
2005-09-18 20:56:44 +00:00
|
|
|
#endif /* RAIL_H */
|