1

/* $Id$ */

     2

     3

/** @file waypoint.h */

     4

     5

#ifndef WAYPOINT_H

     6

#define WAYPOINT_H

     7

     8

#include "waypoint_type.h"

     9

#include "oldpool.h"

    10

#include "rail_map.h"

    11

#include "command_type.h"

    12

#include "station_type.h"

    13

#include "town_type.h"

    14

    15

DECLARE_OLD_POOL(Waypoint, Waypoint, 3, 8000)

    16

    17

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

    18

	TileIndex xy;      ///< Tile of waypoint

    19

    20

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

    21

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

    22

	StringID string;   ///< C000-C03F have special meaning in old games

    23

	char *name;        ///< Custom name. If not set, town + town_cn is used for naming

    24

    25

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

    26

	Date build_date;   ///< Date of construction

    27

    28

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

    29

	uint32 grfid;      ///< ID of GRF file

    30

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

    31

    32

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

    33

    34

	Waypoint(TileIndex tile = 0);

    35

	~Waypoint();

    36

    37

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

    38

};

    39

    40

static inline bool IsValidWaypointID(WaypointID index)

    41

{

    42

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

    43

}

    44

    45

static inline void DeleteWaypoint(Waypoint *wp)

    46

{

    47

	wp->~Waypoint();

    48

}

    49

    50

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

    51

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

    52

    53

    54

/**

    55

 * Fetch a waypoint by tile

    56

 * @param tile Tile of waypoint

    57

 * @return Waypoint

    58

 */

    59

static inline Waypoint *GetWaypointByTile(TileIndex tile)

    60

{

    61

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

    62

	return GetWaypoint(GetWaypointIndex(tile));

    63

}

    64

    65

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

    66

Station *ComposeWaypointStation(TileIndex tile);

    67

void ShowRenameWaypointWindow(const Waypoint *cp);

    68

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

    69

void FixOldWaypoints();

    70

void UpdateAllWaypointSigns();

    71

void AfterLoadWaypoints();

    72

    73

#endif /* WAYPOINT_H */