celestar@2254: * 1) All the sprites in a railset MUST be in the same order. This order celestar@2254: * is determined by normal rail. Check sprites 1005 and following for this order
celestar@2254: * 2) The position where the railtype is loaded must always be the same, otherwise celestar@2254: * the offset will fail.
celestar@2254: * @note: Something more flexible might be desirable in the future. celestar@2254: */ celestar@2254: SpriteID total_offset; celestar@2536: celestar@2536: /** tron@4077: * Bridge offset tron@4077: */ celestar@2536: SpriteID bridge_offset; peter1138@3503: peter1138@3503: /** peter1138@3503: * Offset to add to ground sprite when drawing custom waypoints / stations peter1138@3503: */ peter1138@3503: byte custom_ground_offset; celestar@2233: } RailtypeInfo; celestar@2233: celestar@3890: extern RailtypeInfo _railtypes[RAILTYPE_END]; celestar@2233: hackykid@2008: // these are the maximums used for updating signal blocks, and checking if a depot is in a pbs block hackykid@2008: enum { hackykid@2008: NUM_SSD_ENTRY = 256, // max amount of blocks rubidium@4344: NUM_SSD_STACK = 32, // max amount of blocks to check recursively hackykid@2008: }; matthijs@1942: matthijs@1948: /** matthijs@1948: * Maps a Trackdir to the corresponding TrackdirBits value matthijs@1948: */ matthijs@1948: static inline TrackdirBits TrackdirToTrackdirBits(Trackdir trackdir) { return (TrackdirBits)(1 << trackdir); } matthijs@1948: celestar@2232: /** matthijs@1942: * These functions check the validity of Tracks and Trackdirs. assert against matthijs@1942: * them when convenient. matthijs@1942: */ matthijs@1942: static inline bool IsValidTrack(Track track) { return track < TRACK_END; } matthijs@1948: static inline bool IsValidTrackdir(Trackdir trackdir) { return (TrackdirToTrackdirBits(trackdir) & TRACKDIR_BIT_MASK) != 0; } matthijs@1942: celestar@2232: /** matthijs@1942: * Functions to map tracks to the corresponding bits in the signal matthijs@1942: * presence/status bytes in the map. You should not use these directly, but matthijs@1942: * wrapper functions below instead. XXX: Which are these? matthijs@1942: */ 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 along with the trackdir. matthijs@1942: */ matthijs@1947: extern const byte _signal_along_trackdir[TRACKDIR_END]; matthijs@1942: static inline byte SignalAlongTrackdir(Trackdir trackdir) {return _signal_along_trackdir[trackdir];} 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. matthijs@1942: */ matthijs@1948: static inline byte SignalAgainstTrackdir(Trackdir trackdir) { matthijs@1948: extern const byte _signal_against_trackdir[TRACKDIR_END]; matthijs@1948: return _signal_against_trackdir[trackdir]; matthijs@1948: } 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. matthijs@1942: */ matthijs@1948: static inline byte SignalOnTrack(Track track) { matthijs@1948: extern const byte _signal_on_track[TRACK_END]; matthijs@1948: return _signal_on_track[track]; matthijs@1948: } matthijs@1942: matthijs@1942: matthijs@1942: /* matthijs@1942: * Functions describing logical relations between Tracks, TrackBits, Trackdirs matthijs@1942: * TrackdirBits, Direction and DiagDirections. matthijs@1942: * matthijs@1942: * TODO: Add #unndefs or something similar to remove the arrays used below matthijs@1942: * from the global scope and expose direct uses of them. matthijs@1942: */ matthijs@1942: matthijs@1942: /** matthijs@1944: * Maps a trackdir to the reverse trackdir. matthijs@1944: */ matthijs@1948: static inline Trackdir ReverseTrackdir(Trackdir trackdir) { tron@3500: return (Trackdir)(trackdir ^ 8); matthijs@1948: } matthijs@1944: matthijs@2782: /** matthijs@2782: * Returns the Track that a given Trackdir represents matthijs@2782: */ matthijs@1944: static inline Track TrackdirToTrack(Trackdir trackdir) { return (Track)(trackdir & 0x7); } matthijs@1944: matthijs@2782: /** matthijs@2782: * Returns a Trackdir for the given Track. Since every Track corresponds to matthijs@1944: * two Trackdirs, we choose the one which points between NE and S. matthijs@1944: * Note that the actual implementation is quite futile, but this might change matthijs@1944: * in the future. matthijs@1944: */ matthijs@1944: static inline Trackdir TrackToTrackdir(Track track) { return (Trackdir)track; } matthijs@1944: matthijs@2782: /** matthijs@2782: * Returns a TrackdirBit mask that contains the two TrackdirBits that matthijs@1944: * correspond with the given Track (one for each direction). matthijs@1944: */ tron@4077: static inline TrackdirBits TrackToTrackdirBits(Track track) tron@4077: { tron@4077: Trackdir td = TrackToTrackdir(track); tron@4077: return (TrackdirBits)(TrackdirToTrackdirBits(td) | TrackdirToTrackdirBits(ReverseTrackdir(td))); tron@4077: } matthijs@1944: matthijs@1944: /** matthijs@2782: * Discards all directional information from the given TrackdirBits. Any matthijs@2782: * Track which is present in either direction will be present in the result. matthijs@2782: */ tron@4077: static inline TrackBits TrackdirBitsToTrackBits(TrackdirBits bits) tron@4077: { matthijs@4281: return (TrackBits)((bits | (bits >> 8)) & TRACK_BIT_MASK); tron@4077: } matthijs@2782: matthijs@2782: /** matthijs@1942: * Maps a trackdir to the trackdir that you will end up on if you go straight matthijs@1942: * ahead. This will be the same trackdir for diagonal trackdirs, but a matthijs@1942: * different (alternating) one for straight trackdirs matthijs@1942: */ tron@4077: static inline Trackdir NextTrackdir(Trackdir trackdir) tron@4077: { matthijs@1948: extern const Trackdir _next_trackdir[TRACKDIR_END]; matthijs@1948: return _next_trackdir[trackdir]; matthijs@1948: } matthijs@1942: matthijs@1942: /** matthijs@1942: * Maps a track to all tracks that make 90 deg turns with it. matthijs@1942: */ tron@4077: static inline TrackBits TrackCrossesTracks(Track track) tron@4077: { matthijs@1948: extern const TrackBits _track_crosses_tracks[TRACK_END]; matthijs@1948: return _track_crosses_tracks[track]; matthijs@1948: } matthijs@1942: matthijs@1942: /** matthijs@1942: * Maps a trackdir to the (4-way) direction the tile is exited when following matthijs@1942: * that trackdir. matthijs@1942: */ tron@4077: static inline DiagDirection TrackdirToExitdir(Trackdir trackdir) tron@4077: { matthijs@1948: extern const DiagDirection _trackdir_to_exitdir[TRACKDIR_END]; matthijs@1948: return _trackdir_to_exitdir[trackdir]; matthijs@1948: } matthijs@1942: matthijs@1942: /** matthijs@1942: * Maps a track and an (4-way) dir to the trackdir that represents the track matthijs@1942: * with the exit in the given direction. matthijs@1942: */ tron@4077: static inline Trackdir TrackExitdirToTrackdir(Track track, DiagDirection diagdir) tron@4077: { matthijs@1948: extern const Trackdir _track_exitdir_to_trackdir[TRACK_END][DIAGDIR_END]; matthijs@1948: return _track_exitdir_to_trackdir[track][diagdir]; matthijs@1948: } matthijs@1942: matthijs@1942: /** hackykid@2008: * Maps a track and an (4-way) dir to the trackdir that represents the track hackykid@2008: * with the exit in the given direction. hackykid@2008: */ tron@4077: static inline Trackdir TrackEnterdirToTrackdir(Track track, DiagDirection diagdir) tron@4077: { hackykid@2008: extern const Trackdir _track_enterdir_to_trackdir[TRACK_END][DIAGDIR_END]; hackykid@2008: return _track_enterdir_to_trackdir[track][diagdir]; hackykid@2008: } hackykid@2008: hackykid@2008: /** matthijs@1942: * Maps a track and a full (8-way) direction to the trackdir that represents matthijs@1942: * the track running in the given direction. matthijs@1942: */ tron@4077: static inline Trackdir TrackDirectionToTrackdir(Track track, Direction dir) tron@4077: { matthijs@1948: extern const Trackdir _track_direction_to_trackdir[TRACK_END][DIR_END]; matthijs@1948: return _track_direction_to_trackdir[track][dir]; matthijs@1948: } matthijs@1942: matthijs@1942: /** matthijs@1942: * Maps a (4-way) direction to the diagonal trackdir that runs in that matthijs@1942: * direction. matthijs@1942: */ tron@4077: static inline Trackdir DiagdirToDiagTrackdir(DiagDirection diagdir) tron@4077: { matthijs@1948: extern const Trackdir _dir_to_diag_trackdir[DIAGDIR_END]; matthijs@1948: return _dir_to_diag_trackdir[diagdir]; matthijs@1948: } matthijs@1942: matthijs@2782: extern const TrackdirBits _exitdir_reaches_trackdirs[DIAGDIR_END]; matthijs@2782: matthijs@2782: /** matthijs@2782: * Returns all trackdirs that can be reached when entering a tile from a given matthijs@2782: * (diagonal) direction. This will obviously include 90 degree turns, since no matthijs@2782: * information is available about the exact angle of entering */ matthijs@2782: static inline TrackdirBits DiagdirReachesTrackdirs(DiagDirection diagdir) { return _exitdir_reaches_trackdirs[diagdir]; } matthijs@2782: matthijs@2782: /** matthijs@2782: * Returns all tracks that can be reached when entering a tile from a given matthijs@2782: * (diagonal) direction. This will obviously include 90 degree turns, since no matthijs@2782: * information is available about the exact angle of entering */ matthijs@2782: static inline TrackBits DiagdirReachesTracks(DiagDirection diagdir) { return TrackdirBitsToTrackBits(DiagdirReachesTrackdirs(diagdir)); } matthijs@2782: matthijs@1942: /** matthijs@1942: * Maps a trackdir to the trackdirs that can be reached from it (ie, when matthijs@2782: * entering the next tile. This will include 90 degree turns! matthijs@1942: */ matthijs@2782: static inline TrackdirBits TrackdirReachesTrackdirs(Trackdir trackdir) { return _exitdir_reaches_trackdirs[TrackdirToExitdir(trackdir)]; } matthijs@1942: /* Note that there is no direct table for this function (there used to be), matthijs@1942: * but it uses two simpeler tables to achieve the result */ matthijs@2782: matthijs@1942: matthijs@1942: /** matthijs@1942: * Maps a trackdir to all trackdirs that make 90 deg turns with it. matthijs@1942: */ matthijs@1948: static inline TrackdirBits TrackdirCrossesTrackdirs(Trackdir trackdir) { matthijs@1948: extern const TrackdirBits _track_crosses_trackdirs[TRACKDIR_END]; matthijs@1948: return _track_crosses_trackdirs[TrackdirToTrack(trackdir)]; matthijs@1948: } matthijs@1942: hackykid@2008: matthijs@1942: /* Checks if a given Track is diagonal */ tron@3102: static inline bool IsDiagonalTrack(Track track) { return (track == TRACK_X) || (track == TRACK_Y); } matthijs@1942: matthijs@1942: /* Checks if a given Trackdir is diagonal. */ matthijs@1942: static inline bool IsDiagonalTrackdir(Trackdir trackdir) { return IsDiagonalTrack(TrackdirToTrack(trackdir)); } matthijs@1942: matthijs@1967: matthijs@1967: /** celestar@2233: * Returns a pointer to the Railtype information for a given railtype celestar@2233: * @param railtype the rail type which the information is requested for celestar@2233: * @return The pointer to the RailtypeInfo celestar@2233: */ ludde@2236: static inline const RailtypeInfo *GetRailTypeInfo(RailType railtype) celestar@2233: { celestar@2233: assert(railtype < RAILTYPE_END); ludde@2236: return &_railtypes[railtype]; celestar@2233: } celestar@2233: celestar@2233: /** matthijs@2006: * Checks if an engine of the given RailType can drive on a tile with a given matthijs@2006: * RailType. This would normally just be an equality check, but for electric matthijs@2006: * rails (which also support non-electric engines). matthijs@2006: * @return Whether the engine can drive on this tile. matthijs@2006: * @param enginetype The RailType of the engine we are considering. matthijs@2006: * @param tiletype The RailType of the tile we are considering. matthijs@2006: */ matthijs@2006: static inline bool IsCompatibleRail(RailType enginetype, RailType tiletype) matthijs@2006: { celestar@2233: return HASBIT(GetRailTypeInfo(enginetype)->compatible_railtypes, tiletype); matthijs@2006: } matthijs@2006: celestar@3355: static inline bool HasPowerOnRail(RailType enginetype, RailType tiletype) celestar@3355: { celestar@3355: return HASBIT(GetRailTypeInfo(enginetype)->powered_railtypes, tiletype); celestar@3355: } celestar@3355: matthijs@2782: /** matthijs@2782: * Checks if the given tracks overlap, ie form a crossing. Basically this matthijs@2782: * means when there is more than one track on the tile, exept when there are matthijs@2782: * two parallel tracks. matthijs@2782: * @param bits The tracks present. matthijs@2782: * @return Whether the tracks present overlap in any way. matthijs@2782: */ matthijs@2782: static inline bool TracksOverlap(TrackBits bits) matthijs@2782: { tron@4077: /* With no, or only one track, there is no overlap */ tron@4077: if (bits == 0 || KILL_FIRST_BIT(bits) == 0) return false; tron@4077: /* We know that there are at least two tracks present. When there are more tron@4077: * than 2 tracks, they will surely overlap. When there are two, they will tron@4077: * always overlap unless they are lower & upper or right & left. */ tron@3258: return bits != TRACK_BIT_HORZ && bits != TRACK_BIT_VERT; matthijs@2782: } matthijs@2782: tron@2520: void DrawTrainDepotSprite(int x, int y, int image, RailType railtype); tron@2520: void DrawDefaultWaypointSprite(int x, int y, RailType railtype); celestar@3355: celestar@3355: /** celestar@3355: * Draws overhead wires and pylons for electric railways. celestar@3355: * @param ti The TileInfo struct of the tile being drawn celestar@3355: * @see DrawCatenaryRailway celestar@3355: */ celestar@3355: void DrawCatenary(const TileInfo *ti); celestar@3355: tron@3636: uint GetRailFoundation(Slope tileh, TrackBits bits); celestar@5599: void DrawTile_Track(TileInfo *ti); celestar@5598: uint32 GetTileTrackStatus_Track(TileIndex tile, TransportType mode); celestar@5632: void DrawSignals(TileIndex tile, TrackBits rails); KUDr@5116: KUDr@5116: int32 SettingsDisableElrail(int32 p1); ///< _patches.disable_elrail callback KUDr@5116: celestar@2536: #endif /* RAIL_H */