OpenTTD-patches/waypoint.h
peter1138 754d26407e (svn r3212) - Waypoints/Depots: Store waypoint index in m2 for waypoints. This moves the ground type bits from m2 to m4 for waypoints and depots (leaving room for depot index in m2 in future), and moves the custom graphics ID to the waypoint struct.
- Waypoints: Until now stat_id was saved but never assigned to. Instead we now save the GRFID/local index of the custom graphics so that GRF file changes can leave graphics intact.
2005-11-16 22:20:15 +00:00

83 lines
2.3 KiB
C

/* $Id$ */
#ifndef WAYPOINT_H
#define WAYPOINT_H
#include "pool.h"
struct Waypoint {
TileIndex xy; ///< Tile of waypoint
uint16 index; ///< Index of waypoint
uint16 town_index; ///< Town associated with the waypoint
byte town_cn; ///< The Nth waypoint for this town (consecutive number)
StringID string; ///< If this is zero (i.e. no custom name), town + town_cn is used for naming
ViewportSign sign; ///< Dimensions of sign (not saved)
uint16 build_date; ///< Date of construction
byte stat_id; ///< ID of waypoint within the waypoint class (not saved)
uint32 grfid; ///< ID of GRF file
byte localidx; ///< Index of station within GRF file
byte deleted; ///< Delete counter. If greater than 0 then it is decremented until it reaches 0; the waypoint is then is deleted.
};
enum {
RAIL_TYPE_WAYPOINT = 0xC4,
RAIL_WAYPOINT_TRACK_MASK = 1,
};
extern MemoryPool _waypoint_pool;
/**
* Get the pointer to the waypoint with index 'index'
*/
static inline Waypoint *GetWaypoint(uint index)
{
return (Waypoint*)GetItemFromPool(&_waypoint_pool, index);
}
/**
* Get the current size of the WaypointPool
*/
static inline uint16 GetWaypointPoolSize(void)
{
return _waypoint_pool.total_items;
}
static inline bool IsWaypointIndex(uint index)
{
return index < GetWaypointPoolSize();
}
#define FOR_ALL_WAYPOINTS_FROM(wp, start) for (wp = GetWaypoint(start); wp != NULL; wp = (wp->index + 1 < GetWaypointPoolSize()) ? GetWaypoint(wp->index + 1) : NULL)
#define FOR_ALL_WAYPOINTS(wp) FOR_ALL_WAYPOINTS_FROM(wp, 0)
static inline bool IsRailWaypoint(TileIndex tile)
{
return (_m[tile].m5 & 0xFC) == 0xC4;
}
/**
* Fetch a waypoint by tile
* @param tile Tile of waypoint
* @return Waypoint
*/
static inline Waypoint *GetWaypointByTile(TileIndex tile)
{
assert(IsTileType(tile, MP_RAILWAY) && IsRailWaypoint(tile));
return GetWaypoint(_m[tile].m2);
}
int32 RemoveTrainWaypoint(TileIndex tile, uint32 flags, bool justremove);
Station *ComposeWaypointStation(TileIndex tile);
void ShowRenameWaypointWindow(const Waypoint *cp);
void DrawWaypointSprite(int x, int y, int image, RailType railtype);
void UpdateWaypointSign(Waypoint *cp);
void FixOldWaypoints(void);
void UpdateAllWaypointSigns(void);
void UpdateAllWaypointCustomGraphics(void);
#endif /* WAYPOINT_H */