tron@2186: /* $Id$ */
tron@2186: 
richk@10724: /** @file rail.cpp Implementation of rail specific functions. */
richk@6719: 
matthijs@1948: #include "stdafx.h"
matthijs@1948: #include "openttd.h"
tron@3234: #include "bridge_map.h"
matthijs@1942: #include "rail.h"
celestar@3442: #include "station_map.h"
tron@3184: #include "tunnel_map.h"
rubidium@6872: #include "tunnelbridge_map.h"
rubidium@6872: #include "settings_type.h"
rubidium@6872: #include "date_func.h"
rubidium@6872: #include "player_func.h"
rubidium@6872: #include "player_base.h"
richk@10184: #include "engine_func.h"
richk@10724: #include "engine_base.h"
rubidium@6872: 
matthijs@1942: 
matthijs@1944: /* XXX: Below 3 tables store duplicate data. Maybe remove some? */
matthijs@1942: /* Maps a trackdir to the bit that stores its status in the map arrays, in the
matthijs@1942:  * direction along with the trackdir */
rubidium@6872: extern const byte _signal_along_trackdir[TRACKDIR_END] = {
richk@6719: 	0x8, 0x8, 0x8, 0x2, 0x4, 0x1, 0, 0,
richk@6719: 	0x4, 0x4, 0x4, 0x1, 0x8, 0x2
matthijs@1942: };
matthijs@1942: 
matthijs@1942: /* Maps a trackdir to the bit that stores its status in the map arrays, in the
matthijs@1942:  * direction against the trackdir */
rubidium@6872: extern const byte _signal_against_trackdir[TRACKDIR_END] = {
richk@6719: 	0x4, 0x4, 0x4, 0x1, 0x8, 0x2, 0, 0,
richk@6719: 	0x8, 0x8, 0x8, 0x2, 0x4, 0x1
matthijs@1942: };
matthijs@1942: 
matthijs@1942: /* Maps a Track to the bits that store the status of the two signals that can
matthijs@1942:  * be present on the given track */
rubidium@5838: extern const byte _signal_on_track[] = {
richk@6719: 	0xC, 0xC, 0xC, 0x3, 0xC, 0x3
matthijs@1942: };
matthijs@1942: 
matthijs@1942: /* Maps a diagonal direction to the all trackdirs that are connected to any
matthijs@1942:  * track entering in this direction (including those making 90 degree turns)
matthijs@1942:  */
rubidium@5838: extern const TrackdirBits _exitdir_reaches_trackdirs[] = {
tron@3102: 	TRACKDIR_BIT_X_NE | TRACKDIR_BIT_LOWER_E | TRACKDIR_BIT_LEFT_N,  /* DIAGDIR_NE */
tron@3102: 	TRACKDIR_BIT_Y_SE | TRACKDIR_BIT_LEFT_S  | TRACKDIR_BIT_UPPER_E, /* DIAGDIR_SE */
tron@3102: 	TRACKDIR_BIT_X_SW | TRACKDIR_BIT_UPPER_W | TRACKDIR_BIT_RIGHT_S, /* DIAGDIR_SW */
tron@3102: 	TRACKDIR_BIT_Y_NW | TRACKDIR_BIT_RIGHT_N | TRACKDIR_BIT_LOWER_W  /* DIAGDIR_NW */
matthijs@1942: };
matthijs@1942: 
rubidium@6872: extern const Trackdir _next_trackdir[TRACKDIR_END] = {
tron@3102: 	TRACKDIR_X_NE,  TRACKDIR_Y_SE,  TRACKDIR_LOWER_E, TRACKDIR_UPPER_E, TRACKDIR_RIGHT_S, TRACKDIR_LEFT_S, INVALID_TRACKDIR, INVALID_TRACKDIR,
tron@3102: 	TRACKDIR_X_SW,  TRACKDIR_Y_NW,  TRACKDIR_LOWER_W, TRACKDIR_UPPER_W, TRACKDIR_RIGHT_N, TRACKDIR_LEFT_N
matthijs@1942: };
matthijs@1942: 
matthijs@1942: /* Maps a trackdir to all trackdirs that make 90 deg turns with it. */
rubidium@6872: extern const TrackdirBits _track_crosses_trackdirs[TRACKDIR_END] = {
tron@3102: 	TRACKDIR_BIT_Y_SE     | TRACKDIR_BIT_Y_NW,                                                   /* TRACK_X     */
tron@3102: 	TRACKDIR_BIT_X_NE     | TRACKDIR_BIT_X_SW,                                                   /* TRACK_Y     */
matthijs@1944: 	TRACKDIR_BIT_RIGHT_N  | TRACKDIR_BIT_RIGHT_S  | TRACKDIR_BIT_LEFT_N  | TRACKDIR_BIT_LEFT_S,  /* TRACK_UPPER */
matthijs@1944: 	TRACKDIR_BIT_RIGHT_N  | TRACKDIR_BIT_RIGHT_S  | TRACKDIR_BIT_LEFT_N  | TRACKDIR_BIT_LEFT_S,  /* TRACK_LOWER */
matthijs@1944: 	TRACKDIR_BIT_UPPER_W  | TRACKDIR_BIT_UPPER_E  | TRACKDIR_BIT_LOWER_W | TRACKDIR_BIT_LOWER_E, /* TRACK_LEFT  */
matthijs@1944: 	TRACKDIR_BIT_UPPER_W  | TRACKDIR_BIT_UPPER_E  | TRACKDIR_BIT_LOWER_W | TRACKDIR_BIT_LOWER_E  /* TRACK_RIGHT */
matthijs@1942: };
matthijs@1942: 
matthijs@1942: /* Maps a track to all tracks that make 90 deg turns with it. */
rubidium@5838: extern const TrackBits _track_crosses_tracks[] = {
tron@3258: 	TRACK_BIT_Y,    /* TRACK_X     */
tron@3258: 	TRACK_BIT_X,    /* TRACK_Y     */
tron@3258: 	TRACK_BIT_VERT, /* TRACK_UPPER */
tron@3258: 	TRACK_BIT_VERT, /* TRACK_LOWER */
tron@3258: 	TRACK_BIT_HORZ, /* TRACK_LEFT  */
tron@3258: 	TRACK_BIT_HORZ  /* TRACK_RIGHT */
matthijs@1942: };
matthijs@1942: 
matthijs@1942: /* Maps a trackdir to the (4-way) direction the tile is exited when following
matthijs@1942:  * that trackdir */
rubidium@6872: extern const DiagDirection _trackdir_to_exitdir[TRACKDIR_END] = {
richk@6719: 	DIAGDIR_NE, DIAGDIR_SE, DIAGDIR_NE, DIAGDIR_SE, DIAGDIR_SW, DIAGDIR_SE, DIAGDIR_NE, DIAGDIR_NE,
richk@6719: 	DIAGDIR_SW, DIAGDIR_NW, DIAGDIR_NW, DIAGDIR_SW, DIAGDIR_NW, DIAGDIR_NE,
matthijs@1942: };
matthijs@1942: 
rubidium@5838: extern const Trackdir _track_exitdir_to_trackdir[][DIAGDIR_END] = {
tron@3102: 	{TRACKDIR_X_NE,     INVALID_TRACKDIR,  TRACKDIR_X_SW,     INVALID_TRACKDIR},
tron@3102: 	{INVALID_TRACKDIR,  TRACKDIR_Y_SE,     INVALID_TRACKDIR,  TRACKDIR_Y_NW},
matthijs@1944: 	{TRACKDIR_UPPER_E,  INVALID_TRACKDIR,  INVALID_TRACKDIR,  TRACKDIR_UPPER_W},
matthijs@1944: 	{INVALID_TRACKDIR,  TRACKDIR_LOWER_E,  TRACKDIR_LOWER_W,  INVALID_TRACKDIR},
matthijs@1944: 	{INVALID_TRACKDIR,  INVALID_TRACKDIR,  TRACKDIR_LEFT_S,   TRACKDIR_LEFT_N},
matthijs@1944: 	{TRACKDIR_RIGHT_N,  TRACKDIR_RIGHT_S,  INVALID_TRACKDIR,  INVALID_TRACKDIR}
matthijs@1942: };
matthijs@1942: 
richk@6719: extern const Trackdir _track_enterdir_to_trackdir[][DIAGDIR_END] = {
tron@3102: 	{TRACKDIR_X_NE,     INVALID_TRACKDIR,  TRACKDIR_X_SW,     INVALID_TRACKDIR},
tron@3102: 	{INVALID_TRACKDIR,  TRACKDIR_Y_SE,     INVALID_TRACKDIR,  TRACKDIR_Y_NW},
hackykid@2008: 	{INVALID_TRACKDIR,  TRACKDIR_UPPER_E,  TRACKDIR_UPPER_W,  INVALID_TRACKDIR},
hackykid@2008: 	{TRACKDIR_LOWER_E,  INVALID_TRACKDIR,  INVALID_TRACKDIR,  TRACKDIR_LOWER_W},
hackykid@2008: 	{TRACKDIR_LEFT_N,   TRACKDIR_LEFT_S,   INVALID_TRACKDIR,  INVALID_TRACKDIR},
hackykid@2008: 	{INVALID_TRACKDIR,  INVALID_TRACKDIR,  TRACKDIR_RIGHT_S,  TRACKDIR_RIGHT_N}
hackykid@2008: };
hackykid@2008: 
rubidium@5838: extern const Trackdir _track_direction_to_trackdir[][DIR_END] = {
tron@3102: 	{INVALID_TRACKDIR, TRACKDIR_X_NE,     INVALID_TRACKDIR, INVALID_TRACKDIR,  INVALID_TRACKDIR, TRACKDIR_X_SW,     INVALID_TRACKDIR, INVALID_TRACKDIR},
tron@3102: 	{INVALID_TRACKDIR, INVALID_TRACKDIR,  INVALID_TRACKDIR, TRACKDIR_Y_SE,     INVALID_TRACKDIR, INVALID_TRACKDIR,  INVALID_TRACKDIR, TRACKDIR_Y_NW},
matthijs@1944: 	{INVALID_TRACKDIR, INVALID_TRACKDIR,  TRACKDIR_UPPER_E, INVALID_TRACKDIR,  INVALID_TRACKDIR, INVALID_TRACKDIR,  TRACKDIR_UPPER_W, INVALID_TRACKDIR},
matthijs@1944: 	{INVALID_TRACKDIR, INVALID_TRACKDIR,  TRACKDIR_LOWER_E, INVALID_TRACKDIR,  INVALID_TRACKDIR, INVALID_TRACKDIR,  TRACKDIR_LOWER_W, INVALID_TRACKDIR},
matthijs@1944: 	{TRACKDIR_LEFT_N,  INVALID_TRACKDIR,  INVALID_TRACKDIR, INVALID_TRACKDIR,  TRACKDIR_LEFT_S,  INVALID_TRACKDIR,  INVALID_TRACKDIR, INVALID_TRACKDIR},
matthijs@1944: 	{TRACKDIR_RIGHT_N, INVALID_TRACKDIR,  INVALID_TRACKDIR, INVALID_TRACKDIR,  TRACKDIR_RIGHT_S, INVALID_TRACKDIR,  INVALID_TRACKDIR, INVALID_TRACKDIR}
matthijs@1942: };
matthijs@1942: 
rubidium@5838: extern const Trackdir _dir_to_diag_trackdir[] = {
tron@3102: 	TRACKDIR_X_NE, TRACKDIR_Y_SE, TRACKDIR_X_SW, TRACKDIR_Y_NW,
matthijs@1942: };
matthijs@1942: 
rubidium@6871: extern const TrackBits _corner_to_trackbits[] = {
rubidium@6871: 	TRACK_BIT_LEFT, TRACK_BIT_LOWER, TRACK_BIT_RIGHT, TRACK_BIT_UPPER,
rubidium@6871: };
rubidium@6871: 
richk@6878: extern const TrackdirBits _uphill_trackdirs[] = {
richk@6878: 	TRACKDIR_BIT_NONE                    , ///<  0 SLOPE_FLAT
richk@6878: 	TRACKDIR_BIT_X_SW | TRACKDIR_BIT_Y_NW, ///<  1 SLOPE_W   -> inclined for diagonal track
richk@6878: 	TRACKDIR_BIT_X_SW | TRACKDIR_BIT_Y_SE, ///<  2 SLOPE_S   -> inclined for diagonal track
richk@6878: 	TRACKDIR_BIT_X_SW                    , ///<  3 SLOPE_SW
richk@6878: 	TRACKDIR_BIT_X_NE | TRACKDIR_BIT_Y_SE, ///<  4 SLOPE_E   -> inclined for diagonal track
richk@6878: 	TRACKDIR_BIT_NONE                    , ///<  5 SLOPE_EW
richk@6878: 	TRACKDIR_BIT_Y_SE                    , ///<  6 SLOPE_SE
richk@6878: 	TRACKDIR_BIT_NONE                    , ///<  7 SLOPE_WSE -> leveled
richk@6878: 	TRACKDIR_BIT_X_NE | TRACKDIR_BIT_Y_NW, ///<  8 SLOPE_N   -> inclined for diagonal track
richk@6878: 	TRACKDIR_BIT_Y_NW                    , ///<  9 SLOPE_NW
richk@6878: 	TRACKDIR_BIT_NONE                    , ///< 10 SLOPE_NS
richk@6878: 	TRACKDIR_BIT_NONE                    , ///< 11 SLOPE_NWS -> leveled
richk@6878: 	TRACKDIR_BIT_X_NE                    , ///< 12 SLOPE_NE
richk@6878: 	TRACKDIR_BIT_NONE                    , ///< 13 SLOPE_ENW -> leveled
richk@6878: 	TRACKDIR_BIT_NONE                    , ///< 14 SLOPE_SEN -> leveled
richk@6878: 	TRACKDIR_BIT_NONE                    , ///< 15 invalid
richk@6878: 	TRACKDIR_BIT_NONE                    , ///< 16 invalid
richk@6878: 	TRACKDIR_BIT_NONE                    , ///< 17 invalid
richk@6878: 	TRACKDIR_BIT_NONE                    , ///< 18 invalid
richk@6878: 	TRACKDIR_BIT_NONE                    , ///< 19 invalid
richk@6878: 	TRACKDIR_BIT_NONE                    , ///< 20 invalid
richk@6878: 	TRACKDIR_BIT_NONE                    , ///< 21 invalid
richk@6878: 	TRACKDIR_BIT_NONE                    , ///< 22 invalid
richk@6878: 	TRACKDIR_BIT_X_SW | TRACKDIR_BIT_Y_SE, ///< 23 SLOPE_STEEP_S -> inclined for diagonal track
richk@6878: 	TRACKDIR_BIT_NONE                    , ///< 24 invalid
richk@6878: 	TRACKDIR_BIT_NONE                    , ///< 25 invalid
richk@6878: 	TRACKDIR_BIT_NONE                    , ///< 26 invalid
richk@6878: 	TRACKDIR_BIT_X_SW | TRACKDIR_BIT_Y_NW, ///< 27 SLOPE_STEEP_W -> inclined for diagonal track
richk@6878: 	TRACKDIR_BIT_NONE                    , ///< 28 invalid
richk@6878: 	TRACKDIR_BIT_X_NE | TRACKDIR_BIT_Y_NW, ///< 29 SLOPE_STEEP_N -> inclined for diagonal track
richk@6878: 	TRACKDIR_BIT_X_NE | TRACKDIR_BIT_Y_SE, ///< 30 SLOPE_STEEP_E -> inclined for diagonal track
richk@6878: };
richk@6878: 
rubidium@6871: /* The default multiplier for the cost of building different types of railway
rubidium@6871:  * track, which will be divided by 8. Can be changed by newgrf files. */
rubidium@6871: const int _default_railtype_cost_multiplier[RAILTYPE_END] = {
rubidium@6871: 	8, 12, 16, 24,
rubidium@6871: };
rubidium@6871: int _railtype_cost_multiplier[RAILTYPE_END];
matthijs@1950: 
tron@6480: RailType GetTileRailType(TileIndex tile)
matthijs@1950: {
matthijs@1950: 	switch (GetTileType(tile)) {
matthijs@1950: 		case MP_RAILWAY:
tron@3242: 			return GetRailType(tile);
tron@3242: 
richk@6743: 		case MP_ROAD:
matthijs@1950: 			/* rail/road crossing */
rubidium@6498: 			if (IsLevelCrossing(tile)) return GetRailType(tile);
matthijs@1950: 			break;
tron@3242: 
matthijs@1950: 		case MP_STATION:
celestar@3442: 			if (IsRailwayStationTile(tile)) return GetRailType(tile);
matthijs@1950: 			break;
tron@3242: 
matthijs@1950: 		case MP_TUNNELBRIDGE:
rubidium@6872: 			if (GetTunnelBridgeTransportType(tile) == TRANSPORT_RAIL) return GetRailType(tile);
matthijs@1950: 			break;
tron@3234: 
matthijs@1950: 		default:
matthijs@1950: 			break;
matthijs@1950: 	}
tron@3242: 	return INVALID_RAILTYPE;
matthijs@1950: }
rubidium@6872: 
rubidium@6872: bool HasRailtypeAvail(const PlayerID p, const RailType railtype)
rubidium@6872: {
rubidium@6872: 	return HasBit(GetPlayer(p)->avail_railtypes, railtype);
rubidium@6872: }
rubidium@6872: 
rubidium@6872: bool ValParamRailtype(const RailType rail)
rubidium@6872: {
rubidium@6872: 	return HasRailtypeAvail(_current_player, rail);
rubidium@6872: }
rubidium@6872: 
rubidium@6872: RailType GetBestRailtype(const PlayerID p)
rubidium@6872: {
rubidium@6872: 	if (HasRailtypeAvail(p, RAILTYPE_MAGLEV)) return RAILTYPE_MAGLEV;
rubidium@6872: 	if (HasRailtypeAvail(p, RAILTYPE_MONO)) return RAILTYPE_MONO;
rubidium@6872: 	if (HasRailtypeAvail(p, RAILTYPE_ELECTRIC)) return RAILTYPE_ELECTRIC;
rubidium@6872: 	return RAILTYPE_RAIL;
rubidium@6872: }
rubidium@6872: 
rubidium@6872: RailTypes GetPlayerRailtypes(PlayerID p)
rubidium@6872: {
rubidium@6872: 	RailTypes rt = RAILTYPES_NONE;
rubidium@6872: 
richk@10724: 	Engine *e;
richk@10724: 	FOR_ALL_ENGINES_OF_TYPE(e, VEH_TRAIN) {
richk@10724: 		const EngineInfo *ei = &e->info;
rubidium@6872: 
richk@10991: 		if (HasBit(ei->climates, _settings_game.game_creation.landscape) &&
rubidium@6872: 				(HasBit(e->player_avail, p) || _date >= e->intro_date + 365)) {
richk@10724: 			const RailVehicleInfo *rvi = &e->u.rail;
rubidium@6872: 
rubidium@6872: 			if (rvi->railveh_type != RAILVEH_WAGON) {
rubidium@6872: 				assert(rvi->railtype < RAILTYPE_END);
rubidium@6872: 				SetBit(rt, rvi->railtype);
rubidium@6872: 			}
rubidium@6872: 		}
rubidium@6872: 	}
rubidium@6872: 
rubidium@6872: 	return rt;
rubidium@6872: }