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;

    20

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

    21

};

    22

    23

enum {

    24

	RAIL_TYPE_WAYPOINT = 0xC4,

    25

	RAIL_WAYPOINT_TRACK_MASK = 1,

    26

};

    27

    28

extern MemoryPool _waypoint_pool;

    29

    30

/**

    31

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

    32

 */

    33

static inline Waypoint *GetWaypoint(uint index)

    34

{

    35

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

    36

}

    37

    38

/**

    39

 * Get the current size of the WaypointPool

    40

 */

    41

static inline uint16 GetWaypointPoolSize(void)

    42

{

    43

	return _waypoint_pool.total_items;

    44

}

    45

    46

static inline bool IsWaypointIndex(uint index)

    47

{

    48

	return index < GetWaypointPoolSize();

    49

}

    50

    51

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

    52

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

    53

    54

static inline bool IsRailWaypoint(byte m5)

    55

{

    56

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

    57

}

    58

    59

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

    60

Station *ComposeWaypointStation(TileIndex tile);

    61

Waypoint *GetWaypointByTile(TileIndex tile);

    62

void ShowRenameWaypointWindow(const Waypoint *cp);

    63

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

    64

void UpdateWaypointSign(Waypoint *cp);

    65

void FixOldWaypoints(void);

    66

void UpdateAllWaypointSigns(void);

    67

    68

#endif /* WAYPOINT_H */