annotate src/rail_map.h @ 8015:7ce9b4fdf0dc draft

(svn r11575) -Fix [FS#1502]: widget numbers of StationViewWindow were incorrect at some places
author smatz <smatz@openttd.org>
date Wed, 05 Dec 2007 16:55:33 +0000
parents 4e8dfd103163
children 6d739a5490a9
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5475
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
1 /* $Id$ */
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
2
6393
ffd35446c110 (svn r9523) -Cleanup: doxygen changes. Time to take care of "R"
belugas <belugas@openttd.org>
parents: 6248
diff changeset
3 /** @file rail_map.h Hides the direct accesses to the map array with map accessors */
ffd35446c110 (svn r9523) -Cleanup: doxygen changes. Time to take care of "R"
belugas <belugas@openttd.org>
parents: 6248
diff changeset
4
5475
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
5 #ifndef RAIL_MAP_H
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
6 #define RAIL_MAP_H
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
7
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
8 #include "direction.h"
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
9 #include "rail.h"
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
10 #include "tile.h"
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
11
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
12
6540
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
13 /** Different types of Rail-related tiles */
6248
0789677a15a0 (svn r9051) -Codechange: typedef [enum|struct] Y {} X; -> [enum|struct] X {};
rubidium <rubidium@openttd.org>
parents: 6182
diff changeset
14 enum RailTileType {
6540
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
15 RAIL_TILE_NORMAL = 0, ///< Normal rail tile without signals
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
16 RAIL_TILE_SIGNALS = 1, ///< Normal rail tile with signals
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
17 RAIL_TILE_WAYPOINT = 2, ///< Waypoint (X or Y direction)
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
18 RAIL_TILE_DEPOT = 3, ///< Depot (one entrance)
6248
0789677a15a0 (svn r9051) -Codechange: typedef [enum|struct] Y {} X; -> [enum|struct] X {};
rubidium <rubidium@openttd.org>
parents: 6182
diff changeset
19 };
5475
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
20
6540
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
21 /**
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
22 * Returns the RailTileType (normal with or without signals,
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
23 * waypoint or depot).
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
24 * @param t the tile to get the information from
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
25 * @pre IsTileType(t, MP_RAILWAY)
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
26 * @return the RailTileType
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
27 */
5475
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
28 static inline RailTileType GetRailTileType(TileIndex t)
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
29 {
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
30 assert(IsTileType(t, MP_RAILWAY));
6172
b3b8cbc5e854 (svn r8935) -Codechange: unification of track type between road and rail tiles, unification of ground type between normal rail tiles and depots/waypoints and removing the need for RailTileSubType.
rubidium <rubidium@openttd.org>
parents: 6154
diff changeset
31 return (RailTileType)GB(_m[t].m5, 6, 2);
5475
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
32 }
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
33
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
34 /**
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
35 * Returns whether this is plain rails, with or without signals. Iow, if this
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
36 * tiles RailTileType is RAIL_TILE_NORMAL or RAIL_TILE_SIGNALS.
6540
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
37 * @param t the tile to get the information from
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
38 * @pre IsTileType(t, MP_RAILWAY)
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
39 * @return true if and only if the tile is normal rail (with or without signals)
5475
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
40 */
6540
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
41 static inline bool IsPlainRailTile(TileIndex t)
5475
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
42 {
6540
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
43 RailTileType rtt = GetRailTileType(t);
5475
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
44 return rtt == RAIL_TILE_NORMAL || rtt == RAIL_TILE_SIGNALS;
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
45 }
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
46
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
47 /**
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
48 * Checks if a rail tile has signals.
6540
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
49 * @param t the tile to get the information from
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
50 * @pre IsTileType(t, MP_RAILWAY)
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
51 * @return true if and only if the tile has signals
5475
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
52 */
6540
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
53 static inline bool HasSignals(TileIndex t)
5475
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
54 {
6540
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
55 return GetRailTileType(t) == RAIL_TILE_SIGNALS;
5475
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
56 }
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
57
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
58 /**
6172
b3b8cbc5e854 (svn r8935) -Codechange: unification of track type between road and rail tiles, unification of ground type between normal rail tiles and depots/waypoints and removing the need for RailTileSubType.
rubidium <rubidium@openttd.org>
parents: 6154
diff changeset
59 * Add/remove the 'has signal' bit from the RailTileType
6540
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
60 * @param tile the tile to add/remove the signals to/from
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
61 * @param signals whether the rail tile should have signals or not
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
62 * @pre IsPlainRailTile(tile)
5475
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
63 */
6172
b3b8cbc5e854 (svn r8935) -Codechange: unification of track type between road and rail tiles, unification of ground type between normal rail tiles and depots/waypoints and removing the need for RailTileSubType.
rubidium <rubidium@openttd.org>
parents: 6154
diff changeset
64 static inline void SetHasSignals(TileIndex tile, bool signals)
5475
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
65 {
6172
b3b8cbc5e854 (svn r8935) -Codechange: unification of track type between road and rail tiles, unification of ground type between normal rail tiles and depots/waypoints and removing the need for RailTileSubType.
rubidium <rubidium@openttd.org>
parents: 6154
diff changeset
66 assert(IsPlainRailTile(tile));
b3b8cbc5e854 (svn r8935) -Codechange: unification of track type between road and rail tiles, unification of ground type between normal rail tiles and depots/waypoints and removing the need for RailTileSubType.
rubidium <rubidium@openttd.org>
parents: 6154
diff changeset
67 SB(_m[tile].m5, 6, 1, signals);
5475
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
68 }
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
69
6540
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
70 /**
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
71 * Is this tile a rail depot?
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
72 * @param t the tile to get the information from
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
73 * @pre IsTileType(t, MP_RAILWAY)
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
74 * @return true if and only if the tile is a rail depot
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
75 */
5475
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
76 static inline bool IsRailDepot(TileIndex t)
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
77 {
6172
b3b8cbc5e854 (svn r8935) -Codechange: unification of track type between road and rail tiles, unification of ground type between normal rail tiles and depots/waypoints and removing the need for RailTileSubType.
rubidium <rubidium@openttd.org>
parents: 6154
diff changeset
78 return GetRailTileType(t) == RAIL_TILE_DEPOT;
5475
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
79 }
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
80
6540
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
81 /**
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
82 * Is this tile a rail waypoint?
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
83 * @param t the tile to get the information from
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
84 * @pre IsTileType(t, MP_RAILWAY)
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
85 * @return true if and only if the tile is a rail waypoint
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
86 */
5475
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
87 static inline bool IsRailWaypoint(TileIndex t)
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
88 {
6172
b3b8cbc5e854 (svn r8935) -Codechange: unification of track type between road and rail tiles, unification of ground type between normal rail tiles and depots/waypoints and removing the need for RailTileSubType.
rubidium <rubidium@openttd.org>
parents: 6154
diff changeset
89 return GetRailTileType(t) == RAIL_TILE_WAYPOINT;
5475
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
90 }
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
91
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
92
6540
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
93 /**
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
94 * Gets the rail type of the given tile
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
95 * @param t the tile to get the rail type from
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
96 * @return the rail type of the tile
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
97 */
5475
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
98 static inline RailType GetRailType(TileIndex t)
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
99 {
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
100 return (RailType)GB(_m[t].m3, 0, 4);
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
101 }
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
102
6540
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
103 /**
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
104 * Sets the track bits of the given tile
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
105 * @param t the tile to set the track bits of
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
106 * @param r the new track bits for the tile
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
107 */
5475
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
108 static inline void SetRailType(TileIndex t, RailType r)
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
109 {
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
110 SB(_m[t].m3, 0, 4, r);
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
111 }
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
112
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
113
6540
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
114 /**
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
115 * Gets the rail type of the given tile
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
116 * @param t the tile to get the rail type from
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
117 * @return the rail type of the tile
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
118 */
5475
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
119 static inline TrackBits GetTrackBits(TileIndex tile)
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
120 {
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
121 return (TrackBits)GB(_m[tile].m5, 0, 6);
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
122 }
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
123
6540
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
124 /**
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
125 * Sets the track bits of the given tile
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
126 * @param t the tile to set the track bits of
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
127 * @param b the new track bits for the tile
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
128 */
5475
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
129 static inline void SetTrackBits(TileIndex t, TrackBits b)
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
130 {
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
131 SB(_m[t].m5, 0, 6, b);
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
132 }
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
133
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
134 /**
6540
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
135 * Returns whether the given track is present on the given tile.
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
136 * @param tile the tile to check the track presence of
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
137 * @param track the track to search for on the tile
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
138 * @pre IsPlainRailTile(tile)
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
139 * @return true if and only if the given track exists on the tile
5475
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
140 */
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
141 static inline bool HasTrack(TileIndex tile, Track track)
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
142 {
7928
4e8dfd103163 (svn r11481) -Codechange: Rename the HASBIT function to fit with the naming style
skidd13 <skidd13@openttd.org>
parents: 7771
diff changeset
143 return HasBit(GetTrackBits(tile), track);
5475
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
144 }
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
145
6540
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
146 /**
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
147 * Returns the direction the depot is facing to
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
148 * @param t the tile to get the depot facing from
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
149 * @pre IsRailDepotTile(t)
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
150 * @return the direction the depot is facing
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
151 */
5475
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
152 static inline DiagDirection GetRailDepotDirection(TileIndex t)
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
153 {
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
154 return (DiagDirection)GB(_m[t].m5, 0, 2);
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
155 }
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
156
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
157
6540
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
158 /**
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
159 * Returns the axis of the waypoint
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
160 * @param t the tile to get the waypoint axis from
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
161 * @pre IsRailWaypointTile(t)
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
162 * @return the axis of the waypoint
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
163 */
5475
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
164 static inline Axis GetWaypointAxis(TileIndex t)
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
165 {
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
166 return (Axis)GB(_m[t].m5, 0, 1);
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
167 }
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
168
6540
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
169 /**
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
170 * Returns the track of the waypoint
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
171 * @param t the tile to get the waypoint track from
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
172 * @pre IsRailWaypointTile(t)
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
173 * @return the track of the waypoint
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
174 */
5475
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
175 static inline Track GetRailWaypointTrack(TileIndex t)
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
176 {
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
177 return AxisToTrack(GetWaypointAxis(t));
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
178 }
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
179
6540
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
180 /**
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
181 * Returns the track bits of the waypoint
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
182 * @param t the tile to get the waypoint track bits from
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
183 * @pre IsRailWaypointTile(t)
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
184 * @return the track bits of the waypoint
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
185 */
5475
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
186 static inline TrackBits GetRailWaypointBits(TileIndex t)
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
187 {
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
188 return TrackToTrackBits(GetRailWaypointTrack(t));
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
189 }
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
190
6540
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
191 /**
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
192 * Returns waypoint index (for the waypoint pool)
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
193 * @param t the tile to get the waypoint index from
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
194 * @pre IsRailWaypointTile(t)
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
195 * @return the waypoint index
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
196 */
6182
e1626f2e63ad (svn r8954) -Codechange: remove direct map accesses from non-map-accessor headers.
rubidium <rubidium@openttd.org>
parents: 6172
diff changeset
197 static inline WaypointID GetWaypointIndex(TileIndex t)
e1626f2e63ad (svn r8954) -Codechange: remove direct map accesses from non-map-accessor headers.
rubidium <rubidium@openttd.org>
parents: 6172
diff changeset
198 {
e1626f2e63ad (svn r8954) -Codechange: remove direct map accesses from non-map-accessor headers.
rubidium <rubidium@openttd.org>
parents: 6172
diff changeset
199 return (WaypointID)_m[t].m2;
e1626f2e63ad (svn r8954) -Codechange: remove direct map accesses from non-map-accessor headers.
rubidium <rubidium@openttd.org>
parents: 6172
diff changeset
200 }
5475
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
201
6540
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
202 /** Type of signal, i.e. how does the signal behave? */
6248
0789677a15a0 (svn r9051) -Codechange: typedef [enum|struct] Y {} X; -> [enum|struct] X {};
rubidium <rubidium@openttd.org>
parents: 6182
diff changeset
203 enum SignalType {
6540
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
204 SIGTYPE_NORMAL = 0, ///< normal signal
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
205 SIGTYPE_ENTRY = 1, ///< presignal block entry
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
206 SIGTYPE_EXIT = 2, ///< presignal block exit
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
207 SIGTYPE_COMBO = 3 ///< presignal inter-block
6248
0789677a15a0 (svn r9051) -Codechange: typedef [enum|struct] Y {} X; -> [enum|struct] X {};
rubidium <rubidium@openttd.org>
parents: 6182
diff changeset
208 };
5475
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
209
6770
93b0e6996fcc (svn r10006) -Fix (FS#362): allow different signal types on one tile
glx <glx@openttd.org>
parents: 6753
diff changeset
210 static inline SignalType GetSignalType(TileIndex t, Track track)
5475
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
211 {
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
212 assert(GetRailTileType(t) == RAIL_TILE_SIGNALS);
6770
93b0e6996fcc (svn r10006) -Fix (FS#362): allow different signal types on one tile
glx <glx@openttd.org>
parents: 6753
diff changeset
213 byte pos = (track == TRACK_LOWER || track == TRACK_RIGHT) ? 4 : 0;
93b0e6996fcc (svn r10006) -Fix (FS#362): allow different signal types on one tile
glx <glx@openttd.org>
parents: 6753
diff changeset
214 return (SignalType)GB(_m[t].m2, pos, 2);
5475
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
215 }
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
216
6770
93b0e6996fcc (svn r10006) -Fix (FS#362): allow different signal types on one tile
glx <glx@openttd.org>
parents: 6753
diff changeset
217 static inline void SetSignalType(TileIndex t, Track track, SignalType s)
5475
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
218 {
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
219 assert(GetRailTileType(t) == RAIL_TILE_SIGNALS);
6770
93b0e6996fcc (svn r10006) -Fix (FS#362): allow different signal types on one tile
glx <glx@openttd.org>
parents: 6753
diff changeset
220 byte pos = (track == TRACK_LOWER || track == TRACK_RIGHT) ? 4 : 0;
93b0e6996fcc (svn r10006) -Fix (FS#362): allow different signal types on one tile
glx <glx@openttd.org>
parents: 6753
diff changeset
221 SB(_m[t].m2, pos, 2, s);
93b0e6996fcc (svn r10006) -Fix (FS#362): allow different signal types on one tile
glx <glx@openttd.org>
parents: 6753
diff changeset
222 if (track == INVALID_TRACK) SB(_m[t].m2, 4, 2, s);
5475
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
223 }
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
224
6770
93b0e6996fcc (svn r10006) -Fix (FS#362): allow different signal types on one tile
glx <glx@openttd.org>
parents: 6753
diff changeset
225 static inline bool IsPresignalEntry(TileIndex t, Track track)
5475
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
226 {
6770
93b0e6996fcc (svn r10006) -Fix (FS#362): allow different signal types on one tile
glx <glx@openttd.org>
parents: 6753
diff changeset
227 return GetSignalType(t, track) == SIGTYPE_ENTRY || GetSignalType(t, track) == SIGTYPE_COMBO;
5475
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
228 }
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
229
6770
93b0e6996fcc (svn r10006) -Fix (FS#362): allow different signal types on one tile
glx <glx@openttd.org>
parents: 6753
diff changeset
230 static inline bool IsPresignalExit(TileIndex t, Track track)
5475
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
231 {
6770
93b0e6996fcc (svn r10006) -Fix (FS#362): allow different signal types on one tile
glx <glx@openttd.org>
parents: 6753
diff changeset
232 return GetSignalType(t, track) == SIGTYPE_EXIT || GetSignalType(t, track) == SIGTYPE_COMBO;
5475
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
233 }
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
234
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
235 static inline void CycleSignalSide(TileIndex t, Track track)
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
236 {
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
237 byte sig;
6770
93b0e6996fcc (svn r10006) -Fix (FS#362): allow different signal types on one tile
glx <glx@openttd.org>
parents: 6753
diff changeset
238 byte pos = (track == TRACK_LOWER || track == TRACK_RIGHT) ? 4 : 6;
5475
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
239
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
240 sig = GB(_m[t].m3, pos, 2);
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
241 if (--sig == 0) sig = 3;
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
242 SB(_m[t].m3, pos, 2, sig);
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
243 }
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
244
6540
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
245 /** Variant of the signal, i.e. how does the signal look? */
6248
0789677a15a0 (svn r9051) -Codechange: typedef [enum|struct] Y {} X; -> [enum|struct] X {};
rubidium <rubidium@openttd.org>
parents: 6182
diff changeset
246 enum SignalVariant {
6540
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
247 SIG_ELECTRIC = 0, ///< Light signal
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
248 SIG_SEMAPHORE = 1 ///< Old-fashioned semaphore signal
6248
0789677a15a0 (svn r9051) -Codechange: typedef [enum|struct] Y {} X; -> [enum|struct] X {};
rubidium <rubidium@openttd.org>
parents: 6182
diff changeset
249 };
5475
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
250
6770
93b0e6996fcc (svn r10006) -Fix (FS#362): allow different signal types on one tile
glx <glx@openttd.org>
parents: 6753
diff changeset
251 static inline SignalVariant GetSignalVariant(TileIndex t, Track track)
5475
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
252 {
6770
93b0e6996fcc (svn r10006) -Fix (FS#362): allow different signal types on one tile
glx <glx@openttd.org>
parents: 6753
diff changeset
253 byte pos = (track == TRACK_LOWER || track == TRACK_RIGHT) ? 6 : 2;
93b0e6996fcc (svn r10006) -Fix (FS#362): allow different signal types on one tile
glx <glx@openttd.org>
parents: 6753
diff changeset
254 return (SignalVariant)GB(_m[t].m2, pos, 1);
5475
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
255 }
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
256
6770
93b0e6996fcc (svn r10006) -Fix (FS#362): allow different signal types on one tile
glx <glx@openttd.org>
parents: 6753
diff changeset
257 static inline void SetSignalVariant(TileIndex t, Track track, SignalVariant v)
5475
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
258 {
6770
93b0e6996fcc (svn r10006) -Fix (FS#362): allow different signal types on one tile
glx <glx@openttd.org>
parents: 6753
diff changeset
259 byte pos = (track == TRACK_LOWER || track == TRACK_RIGHT) ? 6 : 2;
93b0e6996fcc (svn r10006) -Fix (FS#362): allow different signal types on one tile
glx <glx@openttd.org>
parents: 6753
diff changeset
260 SB(_m[t].m2, pos, 1, v);
93b0e6996fcc (svn r10006) -Fix (FS#362): allow different signal types on one tile
glx <glx@openttd.org>
parents: 6753
diff changeset
261 if (track == INVALID_TRACK) SB(_m[t].m2, 6, 1, v);
5475
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
262 }
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
263
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
264 /** These are states in which a signal can be. Currently these are only two, so
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
265 * simple boolean logic will do. But do try to compare to this enum instead of
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
266 * normal boolean evaluation, since that will make future additions easier.
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
267 */
6248
0789677a15a0 (svn r9051) -Codechange: typedef [enum|struct] Y {} X; -> [enum|struct] X {};
rubidium <rubidium@openttd.org>
parents: 6182
diff changeset
268 enum SignalState {
6540
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
269 SIGNAL_STATE_RED = 0, ///< The signal is red
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
270 SIGNAL_STATE_GREEN = 1, ///< The signal is green
6248
0789677a15a0 (svn r9051) -Codechange: typedef [enum|struct] Y {} X; -> [enum|struct] X {};
rubidium <rubidium@openttd.org>
parents: 6182
diff changeset
271 };
5475
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
272
6753
72ae9d67f553 (svn r9988) -Codechange: remove the last direct map accesses, except the ones needed for the savegame saving/loading mechanisms.
rubidium <rubidium@openttd.org>
parents: 6540
diff changeset
273 /**
72ae9d67f553 (svn r9988) -Codechange: remove the last direct map accesses, except the ones needed for the savegame saving/loading mechanisms.
rubidium <rubidium@openttd.org>
parents: 6540
diff changeset
274 * Set the states of the signals (Along/AgainstTrackDir)
72ae9d67f553 (svn r9988) -Codechange: remove the last direct map accesses, except the ones needed for the savegame saving/loading mechanisms.
rubidium <rubidium@openttd.org>
parents: 6540
diff changeset
275 * @param tile the tile to set the states for
72ae9d67f553 (svn r9988) -Codechange: remove the last direct map accesses, except the ones needed for the savegame saving/loading mechanisms.
rubidium <rubidium@openttd.org>
parents: 6540
diff changeset
276 * @param state the new state
72ae9d67f553 (svn r9988) -Codechange: remove the last direct map accesses, except the ones needed for the savegame saving/loading mechanisms.
rubidium <rubidium@openttd.org>
parents: 6540
diff changeset
277 */
72ae9d67f553 (svn r9988) -Codechange: remove the last direct map accesses, except the ones needed for the savegame saving/loading mechanisms.
rubidium <rubidium@openttd.org>
parents: 6540
diff changeset
278 static inline void SetSignalStates(TileIndex tile, uint state)
72ae9d67f553 (svn r9988) -Codechange: remove the last direct map accesses, except the ones needed for the savegame saving/loading mechanisms.
rubidium <rubidium@openttd.org>
parents: 6540
diff changeset
279 {
6770
93b0e6996fcc (svn r10006) -Fix (FS#362): allow different signal types on one tile
glx <glx@openttd.org>
parents: 6753
diff changeset
280 SB(_m[tile].m4, 4, 4, state);
6753
72ae9d67f553 (svn r9988) -Codechange: remove the last direct map accesses, except the ones needed for the savegame saving/loading mechanisms.
rubidium <rubidium@openttd.org>
parents: 6540
diff changeset
281 }
72ae9d67f553 (svn r9988) -Codechange: remove the last direct map accesses, except the ones needed for the savegame saving/loading mechanisms.
rubidium <rubidium@openttd.org>
parents: 6540
diff changeset
282
72ae9d67f553 (svn r9988) -Codechange: remove the last direct map accesses, except the ones needed for the savegame saving/loading mechanisms.
rubidium <rubidium@openttd.org>
parents: 6540
diff changeset
283 /**
72ae9d67f553 (svn r9988) -Codechange: remove the last direct map accesses, except the ones needed for the savegame saving/loading mechanisms.
rubidium <rubidium@openttd.org>
parents: 6540
diff changeset
284 * Set the states of the signals (Along/AgainstTrackDir)
72ae9d67f553 (svn r9988) -Codechange: remove the last direct map accesses, except the ones needed for the savegame saving/loading mechanisms.
rubidium <rubidium@openttd.org>
parents: 6540
diff changeset
285 * @param tile the tile to set the states for
72ae9d67f553 (svn r9988) -Codechange: remove the last direct map accesses, except the ones needed for the savegame saving/loading mechanisms.
rubidium <rubidium@openttd.org>
parents: 6540
diff changeset
286 * @param state the new state
72ae9d67f553 (svn r9988) -Codechange: remove the last direct map accesses, except the ones needed for the savegame saving/loading mechanisms.
rubidium <rubidium@openttd.org>
parents: 6540
diff changeset
287 */
72ae9d67f553 (svn r9988) -Codechange: remove the last direct map accesses, except the ones needed for the savegame saving/loading mechanisms.
rubidium <rubidium@openttd.org>
parents: 6540
diff changeset
288 static inline uint GetSignalStates(TileIndex tile)
72ae9d67f553 (svn r9988) -Codechange: remove the last direct map accesses, except the ones needed for the savegame saving/loading mechanisms.
rubidium <rubidium@openttd.org>
parents: 6540
diff changeset
289 {
6770
93b0e6996fcc (svn r10006) -Fix (FS#362): allow different signal types on one tile
glx <glx@openttd.org>
parents: 6753
diff changeset
290 return GB(_m[tile].m4, 4, 4);
6753
72ae9d67f553 (svn r9988) -Codechange: remove the last direct map accesses, except the ones needed for the savegame saving/loading mechanisms.
rubidium <rubidium@openttd.org>
parents: 6540
diff changeset
291 }
72ae9d67f553 (svn r9988) -Codechange: remove the last direct map accesses, except the ones needed for the savegame saving/loading mechanisms.
rubidium <rubidium@openttd.org>
parents: 6540
diff changeset
292
72ae9d67f553 (svn r9988) -Codechange: remove the last direct map accesses, except the ones needed for the savegame saving/loading mechanisms.
rubidium <rubidium@openttd.org>
parents: 6540
diff changeset
293 /**
72ae9d67f553 (svn r9988) -Codechange: remove the last direct map accesses, except the ones needed for the savegame saving/loading mechanisms.
rubidium <rubidium@openttd.org>
parents: 6540
diff changeset
294 * Get the state of a single signal
72ae9d67f553 (svn r9988) -Codechange: remove the last direct map accesses, except the ones needed for the savegame saving/loading mechanisms.
rubidium <rubidium@openttd.org>
parents: 6540
diff changeset
295 * @param t the tile to get the signal state for
72ae9d67f553 (svn r9988) -Codechange: remove the last direct map accesses, except the ones needed for the savegame saving/loading mechanisms.
rubidium <rubidium@openttd.org>
parents: 6540
diff changeset
296 * @param signalbit the signal
72ae9d67f553 (svn r9988) -Codechange: remove the last direct map accesses, except the ones needed for the savegame saving/loading mechanisms.
rubidium <rubidium@openttd.org>
parents: 6540
diff changeset
297 * @return the state of the signal
72ae9d67f553 (svn r9988) -Codechange: remove the last direct map accesses, except the ones needed for the savegame saving/loading mechanisms.
rubidium <rubidium@openttd.org>
parents: 6540
diff changeset
298 */
5475
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
299 static inline SignalState GetSingleSignalState(TileIndex t, byte signalbit)
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
300 {
7928
4e8dfd103163 (svn r11481) -Codechange: Rename the HASBIT function to fit with the naming style
skidd13 <skidd13@openttd.org>
parents: 7771
diff changeset
301 return (SignalState)HasBit(GetSignalStates(t), signalbit);
6753
72ae9d67f553 (svn r9988) -Codechange: remove the last direct map accesses, except the ones needed for the savegame saving/loading mechanisms.
rubidium <rubidium@openttd.org>
parents: 6540
diff changeset
302 }
72ae9d67f553 (svn r9988) -Codechange: remove the last direct map accesses, except the ones needed for the savegame saving/loading mechanisms.
rubidium <rubidium@openttd.org>
parents: 6540
diff changeset
303
72ae9d67f553 (svn r9988) -Codechange: remove the last direct map accesses, except the ones needed for the savegame saving/loading mechanisms.
rubidium <rubidium@openttd.org>
parents: 6540
diff changeset
304 /**
72ae9d67f553 (svn r9988) -Codechange: remove the last direct map accesses, except the ones needed for the savegame saving/loading mechanisms.
rubidium <rubidium@openttd.org>
parents: 6540
diff changeset
305 * Set whether the given signals are present (Along/AgainstTrackDir)
72ae9d67f553 (svn r9988) -Codechange: remove the last direct map accesses, except the ones needed for the savegame saving/loading mechanisms.
rubidium <rubidium@openttd.org>
parents: 6540
diff changeset
306 * @param tile the tile to set the present signals for
72ae9d67f553 (svn r9988) -Codechange: remove the last direct map accesses, except the ones needed for the savegame saving/loading mechanisms.
rubidium <rubidium@openttd.org>
parents: 6540
diff changeset
307 * @param signals the signals that have to be present
72ae9d67f553 (svn r9988) -Codechange: remove the last direct map accesses, except the ones needed for the savegame saving/loading mechanisms.
rubidium <rubidium@openttd.org>
parents: 6540
diff changeset
308 */
72ae9d67f553 (svn r9988) -Codechange: remove the last direct map accesses, except the ones needed for the savegame saving/loading mechanisms.
rubidium <rubidium@openttd.org>
parents: 6540
diff changeset
309 static inline void SetPresentSignals(TileIndex tile, uint signals)
72ae9d67f553 (svn r9988) -Codechange: remove the last direct map accesses, except the ones needed for the savegame saving/loading mechanisms.
rubidium <rubidium@openttd.org>
parents: 6540
diff changeset
310 {
72ae9d67f553 (svn r9988) -Codechange: remove the last direct map accesses, except the ones needed for the savegame saving/loading mechanisms.
rubidium <rubidium@openttd.org>
parents: 6540
diff changeset
311 SB(_m[tile].m3, 4, 4, signals);
5475
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
312 }
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
313
6753
72ae9d67f553 (svn r9988) -Codechange: remove the last direct map accesses, except the ones needed for the savegame saving/loading mechanisms.
rubidium <rubidium@openttd.org>
parents: 6540
diff changeset
314 /**
72ae9d67f553 (svn r9988) -Codechange: remove the last direct map accesses, except the ones needed for the savegame saving/loading mechanisms.
rubidium <rubidium@openttd.org>
parents: 6540
diff changeset
315 * Get whether the given signals are present (Along/AgainstTrackDir)
72ae9d67f553 (svn r9988) -Codechange: remove the last direct map accesses, except the ones needed for the savegame saving/loading mechanisms.
rubidium <rubidium@openttd.org>
parents: 6540
diff changeset
316 * @param tile the tile to get the present signals for
72ae9d67f553 (svn r9988) -Codechange: remove the last direct map accesses, except the ones needed for the savegame saving/loading mechanisms.
rubidium <rubidium@openttd.org>
parents: 6540
diff changeset
317 * @return the signals that are present
72ae9d67f553 (svn r9988) -Codechange: remove the last direct map accesses, except the ones needed for the savegame saving/loading mechanisms.
rubidium <rubidium@openttd.org>
parents: 6540
diff changeset
318 */
72ae9d67f553 (svn r9988) -Codechange: remove the last direct map accesses, except the ones needed for the savegame saving/loading mechanisms.
rubidium <rubidium@openttd.org>
parents: 6540
diff changeset
319 static inline uint GetPresentSignals(TileIndex tile)
72ae9d67f553 (svn r9988) -Codechange: remove the last direct map accesses, except the ones needed for the savegame saving/loading mechanisms.
rubidium <rubidium@openttd.org>
parents: 6540
diff changeset
320 {
72ae9d67f553 (svn r9988) -Codechange: remove the last direct map accesses, except the ones needed for the savegame saving/loading mechanisms.
rubidium <rubidium@openttd.org>
parents: 6540
diff changeset
321 return GB(_m[tile].m3, 4, 4);
72ae9d67f553 (svn r9988) -Codechange: remove the last direct map accesses, except the ones needed for the savegame saving/loading mechanisms.
rubidium <rubidium@openttd.org>
parents: 6540
diff changeset
322 }
72ae9d67f553 (svn r9988) -Codechange: remove the last direct map accesses, except the ones needed for the savegame saving/loading mechanisms.
rubidium <rubidium@openttd.org>
parents: 6540
diff changeset
323
72ae9d67f553 (svn r9988) -Codechange: remove the last direct map accesses, except the ones needed for the savegame saving/loading mechanisms.
rubidium <rubidium@openttd.org>
parents: 6540
diff changeset
324 /**
72ae9d67f553 (svn r9988) -Codechange: remove the last direct map accesses, except the ones needed for the savegame saving/loading mechanisms.
rubidium <rubidium@openttd.org>
parents: 6540
diff changeset
325 * Checks whether the given signals is present
72ae9d67f553 (svn r9988) -Codechange: remove the last direct map accesses, except the ones needed for the savegame saving/loading mechanisms.
rubidium <rubidium@openttd.org>
parents: 6540
diff changeset
326 * @param t the tile to check on
72ae9d67f553 (svn r9988) -Codechange: remove the last direct map accesses, except the ones needed for the savegame saving/loading mechanisms.
rubidium <rubidium@openttd.org>
parents: 6540
diff changeset
327 * @param signalbit the signal
72ae9d67f553 (svn r9988) -Codechange: remove the last direct map accesses, except the ones needed for the savegame saving/loading mechanisms.
rubidium <rubidium@openttd.org>
parents: 6540
diff changeset
328 * @return true if and only if the signal is present
72ae9d67f553 (svn r9988) -Codechange: remove the last direct map accesses, except the ones needed for the savegame saving/loading mechanisms.
rubidium <rubidium@openttd.org>
parents: 6540
diff changeset
329 */
72ae9d67f553 (svn r9988) -Codechange: remove the last direct map accesses, except the ones needed for the savegame saving/loading mechanisms.
rubidium <rubidium@openttd.org>
parents: 6540
diff changeset
330 static inline bool IsSignalPresent(TileIndex t, byte signalbit)
72ae9d67f553 (svn r9988) -Codechange: remove the last direct map accesses, except the ones needed for the savegame saving/loading mechanisms.
rubidium <rubidium@openttd.org>
parents: 6540
diff changeset
331 {
7928
4e8dfd103163 (svn r11481) -Codechange: Rename the HASBIT function to fit with the naming style
skidd13 <skidd13@openttd.org>
parents: 7771
diff changeset
332 return HasBit(GetPresentSignals(t), signalbit);
6753
72ae9d67f553 (svn r9988) -Codechange: remove the last direct map accesses, except the ones needed for the savegame saving/loading mechanisms.
rubidium <rubidium@openttd.org>
parents: 6540
diff changeset
333 }
5475
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
334
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
335 /**
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
336 * Checks for the presence of signals (either way) on the given track on the
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
337 * given rail tile.
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
338 */
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
339 static inline bool HasSignalOnTrack(TileIndex tile, Track track)
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
340 {
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
341 assert(IsValidTrack(track));
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
342 return
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
343 GetRailTileType(tile) == RAIL_TILE_SIGNALS &&
6753
72ae9d67f553 (svn r9988) -Codechange: remove the last direct map accesses, except the ones needed for the savegame saving/loading mechanisms.
rubidium <rubidium@openttd.org>
parents: 6540
diff changeset
344 (GetPresentSignals(tile) & SignalOnTrack(track)) != 0;
5475
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
345 }
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
346
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
347 /**
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
348 * Checks for the presence of signals along the given trackdir on the given
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
349 * rail tile.
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
350 *
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
351 * Along meaning if you are currently driving on the given trackdir, this is
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
352 * the signal that is facing us (for which we stop when it's red).
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
353 */
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
354 static inline bool HasSignalOnTrackdir(TileIndex tile, Trackdir trackdir)
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
355 {
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
356 assert (IsValidTrackdir(trackdir));
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
357 return
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
358 GetRailTileType(tile) == RAIL_TILE_SIGNALS &&
6753
72ae9d67f553 (svn r9988) -Codechange: remove the last direct map accesses, except the ones needed for the savegame saving/loading mechanisms.
rubidium <rubidium@openttd.org>
parents: 6540
diff changeset
359 GetPresentSignals(tile) & SignalAlongTrackdir(trackdir);
5475
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
360 }
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
361
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
362 /**
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
363 * Gets the state of the signal along the given trackdir.
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
364 *
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
365 * Along meaning if you are currently driving on the given trackdir, this is
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
366 * the signal that is facing us (for which we stop when it's red).
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
367 */
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
368 static inline SignalState GetSignalStateByTrackdir(TileIndex tile, Trackdir trackdir)
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
369 {
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
370 assert(IsValidTrackdir(trackdir));
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
371 assert(HasSignalOnTrack(tile, TrackdirToTrack(trackdir)));
6753
72ae9d67f553 (svn r9988) -Codechange: remove the last direct map accesses, except the ones needed for the savegame saving/loading mechanisms.
rubidium <rubidium@openttd.org>
parents: 6540
diff changeset
372 return GetSignalStates(tile) & SignalAlongTrackdir(trackdir) ?
5475
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
373 SIGNAL_STATE_GREEN : SIGNAL_STATE_RED;
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
374 }
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
375
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
376
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
377 /**
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
378 * Return the rail type of tile, or INVALID_RAILTYPE if this is no rail tile.
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
379 */
6154
238db87ae59e (svn r8899) -Fix
tron <tron@openttd.org>
parents: 5587
diff changeset
380 RailType GetTileRailType(TileIndex tile);
5475
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
381
6540
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
382 /** The ground 'under' the rail */
6248
0789677a15a0 (svn r9051) -Codechange: typedef [enum|struct] Y {} X; -> [enum|struct] X {};
rubidium <rubidium@openttd.org>
parents: 6182
diff changeset
383 enum RailGroundType {
6540
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
384 RAIL_GROUND_BARREN = 0, ///< Nothing (dirt)
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
385 RAIL_GROUND_GRASS = 1, ///< Grassy
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
386 RAIL_GROUND_FENCE_NW = 2, ///< Grass with a fence at the NW edge
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
387 RAIL_GROUND_FENCE_SE = 3, ///< Grass with a fence at the SE edge
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
388 RAIL_GROUND_FENCE_SENW = 4, ///< Grass with a fence at the NW and SE edges
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
389 RAIL_GROUND_FENCE_NE = 5, ///< Grass with a fence at the NE edge
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
390 RAIL_GROUND_FENCE_SW = 6, ///< Grass with a fence at the SW edge
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
391 RAIL_GROUND_FENCE_NESW = 7, ///< Grass with a fence at the NE and SW edges
7307
cf51670909bb (svn r10659) -Codechange: updated documentation around RAIL_GROUND_FENCE_VERT[12] (frosch)
truelight <truelight@openttd.org>
parents: 6770
diff changeset
392 RAIL_GROUND_FENCE_VERT1 = 8, ///< Grass with a fence at the eastern side
cf51670909bb (svn r10659) -Codechange: updated documentation around RAIL_GROUND_FENCE_VERT[12] (frosch)
truelight <truelight@openttd.org>
parents: 6770
diff changeset
393 RAIL_GROUND_FENCE_VERT2 = 9, ///< Grass with a fence at the western side
6540
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
394 RAIL_GROUND_FENCE_HORIZ1 = 10, ///< Grass with a fence at the southern side
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
395 RAIL_GROUND_FENCE_HORIZ2 = 11, ///< Grass with a fence at the northern side
b71c1ad2239c (svn r9729) -Documentation: add some documentation in various places
rubidium <rubidium@openttd.org>
parents: 6393
diff changeset
396 RAIL_GROUND_ICE_DESERT = 12, ///< Icy or sandy
7771
004a597e91a1 (svn r11320) -Codechange: make lower halftiles at coast floodable. Patch by frosch.
rubidium <rubidium@openttd.org>
parents: 7307
diff changeset
397 RAIL_GROUND_WATER = 13, ///< Grass with a fence and water on the lower halftile
6248
0789677a15a0 (svn r9051) -Codechange: typedef [enum|struct] Y {} X; -> [enum|struct] X {};
rubidium <rubidium@openttd.org>
parents: 6182
diff changeset
398 };
5475
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
399
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
400 static inline void SetRailGroundType(TileIndex t, RailGroundType rgt)
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
401 {
6172
b3b8cbc5e854 (svn r8935) -Codechange: unification of track type between road and rail tiles, unification of ground type between normal rail tiles and depots/waypoints and removing the need for RailTileSubType.
rubidium <rubidium@openttd.org>
parents: 6154
diff changeset
402 SB(_m[t].m4, 0, 4, rgt);
5475
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
403 }
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
404
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
405 static inline RailGroundType GetRailGroundType(TileIndex t)
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
406 {
6172
b3b8cbc5e854 (svn r8935) -Codechange: unification of track type between road and rail tiles, unification of ground type between normal rail tiles and depots/waypoints and removing the need for RailTileSubType.
rubidium <rubidium@openttd.org>
parents: 6154
diff changeset
407 return (RailGroundType)GB(_m[t].m4, 0, 4);
5475
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
408 }
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
409
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
410 static inline bool IsSnowRailGround(TileIndex t)
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
411 {
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
412 return GetRailGroundType(t) == RAIL_GROUND_ICE_DESERT;
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
413 }
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
414
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
415
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
416 static inline void MakeRailNormal(TileIndex t, Owner o, TrackBits b, RailType r)
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
417 {
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
418 SetTileType(t, MP_RAILWAY);
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
419 SetTileOwner(t, o);
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
420 _m[t].m2 = 0;
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
421 _m[t].m3 = r;
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
422 _m[t].m4 = 0;
6172
b3b8cbc5e854 (svn r8935) -Codechange: unification of track type between road and rail tiles, unification of ground type between normal rail tiles and depots/waypoints and removing the need for RailTileSubType.
rubidium <rubidium@openttd.org>
parents: 6154
diff changeset
423 _m[t].m5 = RAIL_TILE_NORMAL << 6 | b;
5475
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
424 }
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
425
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
426
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
427 static inline void MakeRailDepot(TileIndex t, Owner o, DiagDirection d, RailType r)
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
428 {
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
429 SetTileType(t, MP_RAILWAY);
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
430 SetTileOwner(t, o);
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
431 _m[t].m2 = 0;
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
432 _m[t].m3 = r;
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
433 _m[t].m4 = 0;
6172
b3b8cbc5e854 (svn r8935) -Codechange: unification of track type between road and rail tiles, unification of ground type between normal rail tiles and depots/waypoints and removing the need for RailTileSubType.
rubidium <rubidium@openttd.org>
parents: 6154
diff changeset
434 _m[t].m5 = RAIL_TILE_DEPOT << 6 | d;
5475
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
435 }
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
436
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
437
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
438 static inline void MakeRailWaypoint(TileIndex t, Owner o, Axis a, RailType r, uint index)
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
439 {
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
440 SetTileType(t, MP_RAILWAY);
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
441 SetTileOwner(t, o);
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
442 _m[t].m2 = index;
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
443 _m[t].m3 = r;
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
444 _m[t].m4 = 0;
6172
b3b8cbc5e854 (svn r8935) -Codechange: unification of track type between road and rail tiles, unification of ground type between normal rail tiles and depots/waypoints and removing the need for RailTileSubType.
rubidium <rubidium@openttd.org>
parents: 6154
diff changeset
445 _m[t].m5 = RAIL_TILE_WAYPOINT << 6 | a;
5475
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
446 }
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
447
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
448 #endif /* RAIL_MAP_H */