annotate src/bridge.h @ 8532:b3bd4f1ed981 draft

(svn r12107) -Codechange: Add and use the typedef BridgeType
author belugas <belugas@openttd.org>
date Mon, 11 Feb 2008 04:12:30 +0000
parents cf57eb06b4d9
children c026695bee6c
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
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
3 /** @file bridge.h Header file for bridges */
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
4
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
5 #ifndef BRIDGE_H
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
6 #define BRIDGE_H
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
7
8123
c26c28875749 (svn r11684) -Codechange: split gfx.h in a type and functional header.
rubidium <rubidium@openttd.org>
parents: 8119
diff changeset
8 #include "gfx_type.h"
8222
927d1c80aab4 (svn r11785) -Codechange: remove some unneeded includes.
rubidium <rubidium@openttd.org>
parents: 8138
diff changeset
9 #include "direction_type.h"
8138
60ea0f95de91 (svn r11700) -Codechange: reduce the amount of unnecessary includes.
rubidium <rubidium@openttd.org>
parents: 8123
diff changeset
10 #include "tile_cmd.h"
8123
c26c28875749 (svn r11684) -Codechange: split gfx.h in a type and functional header.
rubidium <rubidium@openttd.org>
parents: 8119
diff changeset
11
5475
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
12 enum {
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
13 MAX_BRIDGES = 13
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
14 };
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
15
8532
b3bd4f1ed981 (svn r12107) -Codechange: Add and use the typedef BridgeType
belugas <belugas@openttd.org>
parents: 8491
diff changeset
16 typedef uint BridgeType;
b3bd4f1ed981 (svn r12107) -Codechange: Add and use the typedef BridgeType
belugas <belugas@openttd.org>
parents: 8491
diff changeset
17
5475
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
18 /** Struct containing information about a single bridge type
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
19 */
6248
0789677a15a0 (svn r9051) -Codechange: typedef [enum|struct] Y {} X; -> [enum|struct] X {};
rubidium <rubidium@openttd.org>
parents: 6160
diff changeset
20 struct Bridge {
8475
b4303c7799a1 (svn r12048) -Cleanup: Move some strings in the original bridge array, adjust documentation a bit.
belugas <belugas@openttd.org>
parents: 8398
diff changeset
21 Year avail_year; ///< the year where it becomes available
b4303c7799a1 (svn r12048) -Cleanup: Move some strings in the original bridge array, adjust documentation a bit.
belugas <belugas@openttd.org>
parents: 8398
diff changeset
22 byte min_length; ///< the minimum length (not counting start and end tile)
b4303c7799a1 (svn r12048) -Cleanup: Move some strings in the original bridge array, adjust documentation a bit.
belugas <belugas@openttd.org>
parents: 8398
diff changeset
23 byte max_length; ///< the maximum length (not counting start and end tile)
b4303c7799a1 (svn r12048) -Cleanup: Move some strings in the original bridge array, adjust documentation a bit.
belugas <belugas@openttd.org>
parents: 8398
diff changeset
24 uint16 price; ///< the price multiplier
5475
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
25 uint16 speed; ///< maximum travel speed
5668
3d6d9bff3dd8 (svn r8128) -Codechange: Split sprite and palette remap into separate 32 bit values.
peter1138 <peter1138@openttd.org>
parents: 5475
diff changeset
26 SpriteID sprite; ///< the sprite which is used in the GUI
3d6d9bff3dd8 (svn r8128) -Codechange: Split sprite and palette remap into separate 32 bit values.
peter1138 <peter1138@openttd.org>
parents: 5475
diff changeset
27 SpriteID pal; ///< the palette which is used in the GUI
5475
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
28 StringID material; ///< the string that contains the bridge description
8475
b4303c7799a1 (svn r12048) -Cleanup: Move some strings in the original bridge array, adjust documentation a bit.
belugas <belugas@openttd.org>
parents: 8398
diff changeset
29 StringID name_rail; ///< description of the bridge, when built for road
b4303c7799a1 (svn r12048) -Cleanup: Move some strings in the original bridge array, adjust documentation a bit.
belugas <belugas@openttd.org>
parents: 8398
diff changeset
30 StringID name_road; ///< description of the bridge, when built for road
5475
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
31 PalSpriteID **sprite_table; ///< table of sprites for drawing the bridge
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
32 byte flags; ///< bit 0 set: disable drawing of far pillars.
6248
0789677a15a0 (svn r9051) -Codechange: typedef [enum|struct] Y {} X; -> [enum|struct] X {};
rubidium <rubidium@openttd.org>
parents: 6160
diff changeset
33 };
5475
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 extern Bridge _bridge[MAX_BRIDGES];
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
36
7335
0090d1c6b978 (svn r10698) -Codechange [FS#1082]: simplify the code related to foundations. Primarily removal of (duplicated|magic) code and introduction of few helper functions to ease foundation determination. Patch by frosch.
rubidium <rubidium@openttd.org>
parents: 7318
diff changeset
37 Foundation GetBridgeFoundation(Slope tileh, Axis axis);
8379
bf751c81fa2f (svn r11946) -Fix: slope detection of bridge ramps.
frosch <frosch@openttd.org>
parents: 8222
diff changeset
38 bool HasBridgeFlatRamp(Slope tileh, Axis axis);
6141
4be07d3ba23b (svn r8884) -Fix
tron <tron@openttd.org>
parents: 5668
diff changeset
39
8532
b3bd4f1ed981 (svn r12107) -Codechange: Add and use the typedef BridgeType
belugas <belugas@openttd.org>
parents: 8491
diff changeset
40 static inline const Bridge *GetBridgeSpec(BridgeType i)
6141
4be07d3ba23b (svn r8884) -Fix
tron <tron@openttd.org>
parents: 5668
diff changeset
41 {
4be07d3ba23b (svn r8884) -Fix
tron <tron@openttd.org>
parents: 5668
diff changeset
42 assert(i < lengthof(_bridge));
4be07d3ba23b (svn r8884) -Fix
tron <tron@openttd.org>
parents: 5668
diff changeset
43 return &_bridge[i];
4be07d3ba23b (svn r8884) -Fix
tron <tron@openttd.org>
parents: 5668
diff changeset
44 }
5475
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
45
7318
5305f52bed67 (svn r10673) -Cleanup: some assorted style cleanups. Primarily type* var -> type *var.
rubidium <rubidium@openttd.org>
parents: 6248
diff changeset
46 void DrawBridgeMiddle(const TileInfo *ti);
6160
6bb39697173c (svn r8908) -Codechange: declaration of DrawBridgeMiddle does not belong in a map accessors header.
rubidium <rubidium@openttd.org>
parents: 6141
diff changeset
47
8532
b3bd4f1ed981 (svn r12107) -Codechange: Add and use the typedef BridgeType
belugas <belugas@openttd.org>
parents: 8491
diff changeset
48 bool CheckBridge_Stuff(BridgeType bridge_type, uint bridge_len);
8119
b6ec923e9fa8 (svn r11680) -Codechange: refactor more out of openttd.h and functions.h.
rubidium <rubidium@openttd.org>
parents: 7335
diff changeset
49 int CalcBridgeLenCostFactor(int x);
b6ec923e9fa8 (svn r11680) -Codechange: refactor more out of openttd.h and functions.h.
rubidium <rubidium@openttd.org>
parents: 7335
diff changeset
50
8489
bcc7ea0c669d (svn r12064) -Codechange : Give grf bridges their own ResetBridges function, and put bridge spec in table/bridge_land.h, where it should be.
belugas <belugas@openttd.org>
parents: 8475
diff changeset
51 void ResetBridges();
bcc7ea0c669d (svn r12064) -Codechange : Give grf bridges their own ResetBridges function, and put bridge spec in table/bridge_land.h, where it should be.
belugas <belugas@openttd.org>
parents: 8475
diff changeset
52
5475
eabf4b86aed6 (svn r7759) -Merge: makefile rewrite. This merge features:
rubidium <rubidium@openttd.org>
parents:
diff changeset
53 #endif /* BRIDGE_H */