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

#include "command_type.h"

    11

    12

struct Waypoint;

    13

DECLARE_OLD_POOL(Waypoint, Waypoint, 3, 8000)

    14

    15

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

    16

	TileIndex xy;      ///< Tile of waypoint

    17

    18

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

    19

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

    22

    23

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

    24

	Date build_date;   ///< Date of construction

    25

    26

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

    27

	uint32 grfid;      ///< ID of GRF file

    28

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

    29

    30

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

    31

    32

	Waypoint(TileIndex tile = 0);

    33

	~Waypoint();

    34

    35

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

    36

};

    37

    38

static inline bool IsValidWaypointID(WaypointID index)

    39

{

    40

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

    41

}

    42

    43

static inline void DeleteWaypoint(Waypoint *wp)

    44

{

    45

	wp->~Waypoint();

    46

}

    47

    48

#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())

    49

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

    50

    51

    52

/**

    53

 * Fetch a waypoint by tile

    54

 * @param tile Tile of waypoint

    55

 * @return Waypoint

    56

 */

    57

static inline Waypoint *GetWaypointByTile(TileIndex tile)

    58

{

    59

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

    60

	return GetWaypoint(GetWaypointIndex(tile));

    61

}

    62

    63

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

    64

Station *ComposeWaypointStation(TileIndex tile);

    65

void ShowRenameWaypointWindow(const Waypoint *cp);

    66

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

    67

void FixOldWaypoints();

    68

void UpdateAllWaypointSigns();

    69

void AfterLoadWaypoints();

    70

    71

#endif /* WAYPOINT_H */