1

/* $Id$ */

     2

     3

/** @file waypoint.h */

     4

     5

#ifndef WAYPOINT_H

     6

#define WAYPOINT_H

     7

     8

#include "oldpool.h"

     9

#include "rail_map.h"

    10

    11

struct Waypoint;

    12

DECLARE_OLD_POOL(Waypoint, Waypoint, 3, 8000)

    13

    14

struct Waypoint : PoolItem<Waypoint, WaypointID, &_Waypoint_pool> {

    15

	TileIndex xy;      ///< Tile of waypoint

    16

    17

	TownID town_index; ///< Town associated with the waypoint

    18

	byte town_cn;      ///< The Nth waypoint for this town (consecutive number)

    19

	StringID string;   ///< If this is zero (i.e. no custom name), town + town_cn is used for naming

    20

    21

	ViewportSign sign; ///< Dimensions of sign (not saved)

    22

	Date build_date;   ///< Date of construction

    23

    24

	byte stat_id;      ///< ID of waypoint within the waypoint class (not saved)

    25

	uint32 grfid;      ///< ID of GRF file

    26

	byte localidx;     ///< Index of station within GRF file

    27

    28

	byte deleted;      ///< Delete counter. If greater than 0 then it is decremented until it reaches 0; the waypoint is then is deleted.

    29

    30

	Waypoint(TileIndex tile = 0);

    31

	~Waypoint();

    32

    33

	inline bool IsValid() const { return this->xy != 0; }

    34

};

    35

    36

static inline bool IsValidWaypointID(WaypointID index)

    37

{

    38

	return index < GetWaypointPoolSize() && GetWaypoint(index)->IsValid();

    39

}

    40

    41

static inline void DeleteWaypoint(Waypoint *wp)

    42

{

    43

	wp->~Waypoint();

    44

}

    45

    46

#define FOR_ALL_WAYPOINTS_FROM(wp, start) for (wp = GetWaypoint(start); wp != NULL; wp = (wp->index + 1U < GetWaypointPoolSize()) ? GetWaypoint(wp->index + 1U) : NULL) if (wp->IsValid())

    47

#define FOR_ALL_WAYPOINTS(wp) FOR_ALL_WAYPOINTS_FROM(wp, 0)

    48

    49

    50

/**

    51

 * Fetch a waypoint by tile

    52

 * @param tile Tile of waypoint

    53

 * @return Waypoint

    54

 */

    55

static inline Waypoint *GetWaypointByTile(TileIndex tile)

    56

{

    57

	assert(IsTileType(tile, MP_RAILWAY) && IsRailWaypoint(tile));

    58

	return GetWaypoint(GetWaypointIndex(tile));

    59

}

    60

    61

CommandCost RemoveTrainWaypoint(TileIndex tile, uint32 flags, bool justremove);

    62

Station *ComposeWaypointStation(TileIndex tile);

    63

void ShowRenameWaypointWindow(const Waypoint *cp);

    64

void DrawWaypointSprite(int x, int y, int stat_id, RailType railtype);

    65

void FixOldWaypoints();

    66

void UpdateAllWaypointSigns();

    67

void AfterLoadWaypoints();

    68

    69

#endif /* WAYPOINT_H */