1

/* $Id$ */

     2

     3

/** @file waypoint.h Base of waypoints. */

     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

#include "viewport_type.h"

    15

    16

DECLARE_OLD_POOL(Waypoint, Waypoint, 3, 8000)

    17

    18

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

    19

	TileIndex xy;      ///< Tile of waypoint

    20

    21

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

    22

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

    23

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

    24

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

    25

    26

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

    27

	Date build_date;   ///< Date of construction

    28

	OwnerByte owner;   ///< Whom this waypoint belongs to

    29

    30

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

    31

	uint32 grfid;      ///< ID of GRF file

    32

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

    33

    34

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

    35

    36

	Waypoint(TileIndex tile = 0);

    37

	~Waypoint();

    38

    39

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

    40

};

    41

    42

static inline bool IsValidWaypointID(WaypointID index)

    43

{

    44

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

    45

}

    46

    47

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

    48

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

    49

    50

    51

/**

    52

 * Fetch a waypoint by tile

    53

 * @param tile Tile of waypoint

    54

 * @return Waypoint

    55

 */

    56

static inline Waypoint *GetWaypointByTile(TileIndex tile)

    57

{

    58

	assert(IsRailWaypointTile(tile));

    59

	return GetWaypoint(GetWaypointIndex(tile));

    60

}

    61

    62

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

    63

Station *ComposeWaypointStation(TileIndex tile);

    64

void ShowWaypointWindow(const Waypoint *wp);

    65

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

    66

void FixOldWaypoints();

    67

void UpdateAllWaypointSigns();

    68

void AfterLoadWaypoints();

    69

    70

#endif /* WAYPOINT_H */