1

/* $Id$ */

     2

     3

#ifndef WAYPOINT_H

     4

#define WAYPOINT_H

     5

     6

#include "pool.h"

     7

     8

struct Waypoint {

     9

	TileIndex xy;

    10

	uint16 index;

    11

    12

	uint16 town_index;

    13

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

    14

	StringID string;       // If this is zero, town + town_cn is used for naming

    15

    16

	ViewportSign sign;

    17

	uint16 build_date;

    18

	byte stat_id;

    19

	byte deleted;          // this is a delete counter. when it reaches 0, the waypoint struct is deleted.

    20

};

    21

    22

enum {

    23

	RAIL_TYPE_WAYPOINT = 0xC4,

    24

	RAIL_WAYPOINT_TRACK_MASK = 1,

    25

};

    26

    27

extern MemoryPool _waypoint_pool;

    28

    29

/**

    30

 * Get the pointer to the waypoint with index 'index'

    31

 */

    32

static inline Waypoint *GetWaypoint(uint index)

    33

{

    34

	return (Waypoint*)GetItemFromPool(&_waypoint_pool, index);

    35

}

    36

    37

/**

    38

 * Get the current size of the WaypointPool

    39

 */

    40

static inline uint16 GetWaypointPoolSize(void)

    41

{

    42

	return _waypoint_pool.total_items;

    43

}

    44

    45

static inline bool IsWaypointIndex(uint index)

    46

{

    47

	return index < GetWaypointPoolSize();

    48

}

    49

    50

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

    51

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

    52

    53

static inline bool IsRailWaypoint(byte m5)

    54

{

    55

	return (m5 & 0xFC) == 0xC4;

    56

}

    57

    58

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

    59

Station *ComposeWaypointStation(TileIndex tile);

    60

Waypoint *GetWaypointByTile(TileIndex tile);

    61

void ShowRenameWaypointWindow(const Waypoint *cp);

    63

void UpdateWaypointSign(Waypoint *cp);

    64

void FixOldWaypoints(void);

    65

void UpdateAllWaypointSigns(void);

    66

    67

#endif /* WAYPOINT_H */