summaryrefslogtreecommitdiff
path: root/src/waypoint.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/waypoint.h')
-rw-r--r--src/waypoint.h73
1 files changed, 73 insertions, 0 deletions
diff --git a/src/waypoint.h b/src/waypoint.h
new file mode 100644
index 000000000..75366fb18
--- /dev/null
+++ b/src/waypoint.h
@@ -0,0 +1,73 @@
+/* $Id$ */
+
+#ifndef WAYPOINT_H
+#define WAYPOINT_H
+
+#include "oldpool.h"
+#include "rail_map.h"
+
+struct Waypoint {
+ TileIndex xy; ///< Tile of waypoint
+ WaypointID index; ///< Index of waypoint
+
+ TownID 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)
+ Date 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.
+};
+
+DECLARE_OLD_POOL(Waypoint, Waypoint, 3, 8000)
+
+/**
+ * Check if a Waypoint really exists.
+ */
+static inline bool IsValidWaypoint(const Waypoint *wp)
+{
+ return wp->xy != 0;
+}
+
+static inline bool IsValidWaypointID(WaypointID index)
+{
+ return index < GetWaypointPoolSize() && IsValidWaypoint(GetWaypoint(index));
+}
+
+void DestroyWaypoint(Waypoint *wp);
+
+static inline void DeleteWaypoint(Waypoint *wp)
+{
+ DestroyWaypoint(wp);
+ wp->xy = 0;
+}
+
+#define FOR_ALL_WAYPOINTS_FROM(wp, start) for (wp = GetWaypoint(start); wp != NULL; wp = (wp->index + 1U < GetWaypointPoolSize()) ? GetWaypoint(wp->index + 1U) : NULL) if (IsValidWaypoint(wp))
+#define FOR_ALL_WAYPOINTS(wp) FOR_ALL_WAYPOINTS_FROM(wp, 0)
+
+
+/**
+ * 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 FixOldWaypoints(void);
+void UpdateAllWaypointSigns(void);
+void AfterLoadWaypoints(void);
+
+#endif /* WAYPOINT_H */