OpenTTD Source  1.11.0-beta2
bridge.h
Go to the documentation of this file.
1 /*
2  * This file is part of OpenTTD.
3  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
4  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
5  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
6  */
7 
10 #ifndef BRIDGE_H
11 #define BRIDGE_H
12 
13 #include "gfx_type.h"
14 #include "tile_cmd.h"
15 
22  BRIDGE_PIECE_NORTH = 0,
23  BRIDGE_PIECE_SOUTH,
24  BRIDGE_PIECE_INNER_NORTH,
25  BRIDGE_PIECE_INNER_SOUTH,
26  BRIDGE_PIECE_MIDDLE_ODD,
27  BRIDGE_PIECE_MIDDLE_EVEN,
28  BRIDGE_PIECE_HEAD,
29  BRIDGE_PIECE_INVALID,
30 };
31 
33 
34 static const uint MAX_BRIDGES = 13;
35 
36 typedef uint BridgeType;
37 
41 struct BridgeSpec {
43  byte min_length;
44  uint16 max_length;
45  uint16 price;
46  uint16 speed;
50  StringID transport_name[2];
52  byte flags;
53 };
54 
56 
58 bool HasBridgeFlatRamp(Slope tileh, Axis axis);
59 
65 static inline const BridgeSpec *GetBridgeSpec(BridgeType i)
66 {
67  assert(i < lengthof(_bridge));
68  return &_bridge[i];
69 }
70 
71 void DrawBridgeMiddle(const TileInfo *ti);
72 
73 CommandCost CheckBridgeAvailability(BridgeType bridge_type, uint bridge_len, DoCommandFlag flags = DC_NONE);
74 int CalcBridgeLenCostFactor(int x);
75 
76 void ResetBridges();
77 
78 #endif /* BRIDGE_H */
CalcBridgeLenCostFactor
int CalcBridgeLenCostFactor(int x)
Calculate the price factor for building a long bridge.
Definition: tunnelbridge_cmd.cpp:105
GetBridgeFoundation
Foundation GetBridgeFoundation(Slope tileh, Axis axis)
Get the foundation for a bridge.
Definition: tunnelbridge_cmd.cpp:126
BridgeSpec::flags
byte flags
bit 0 set: disable drawing of far pillars.
Definition: bridge.h:52
BridgeSpec::avail_year
Year avail_year
the year where it becomes available
Definition: bridge.h:42
TileInfo
Tile information, used while rendering the tile.
Definition: tile_cmd.h:42
BridgeSpec::sprite_table
PalSpriteID ** sprite_table
table of sprites for drawing the bridge
Definition: bridge.h:51
_bridge
BridgeSpec _bridge[MAX_BRIDGES]
The specification of all bridges.
Definition: tunnelbridge_cmd.cpp:49
Year
int32 Year
Type for the year, note: 0 based, i.e. starts at the year 0.
Definition: date_type.h:18
DrawBridgeMiddle
void DrawBridgeMiddle(const TileInfo *ti)
Draw the middle bits of a bridge.
Definition: tunnelbridge_cmd.cpp:1540
BridgeSpec::speed
uint16 speed
maximum travel speed (1 unit = 1/1.6 mph = 1 km-ish/h)
Definition: bridge.h:46
DoCommandFlag
DoCommandFlag
List of flags for a command.
Definition: command_type.h:346
Foundation
Foundation
Enumeration for Foundations.
Definition: slope_type.h:93
tile_cmd.h
SpriteID
uint32 SpriteID
The number of a sprite, without mapping bits and colourtables.
Definition: gfx_type.h:17
BridgeSpec
Struct containing information about a single bridge type.
Definition: bridge.h:41
DECLARE_POSTFIX_INCREMENT
#define DECLARE_POSTFIX_INCREMENT(enum_type)
Some enums need to have allowed incrementing (i.e.
Definition: enum_type.hpp:14
GetBridgeSpec
static const BridgeSpec * GetBridgeSpec(BridgeType i)
Get the specification of a bridge type.
Definition: bridge.h:65
BridgeSpec::sprite
SpriteID sprite
the sprite which is used in the GUI
Definition: bridge.h:47
CommandCost
Common return value for all commands.
Definition: command_type.h:23
MAX_BRIDGES
static const uint MAX_BRIDGES
Maximal number of available bridge specs.
Definition: bridge.h:34
CheckBridgeAvailability
CommandCost CheckBridgeAvailability(BridgeType bridge_type, uint bridge_len, DoCommandFlag flags=DC_NONE)
Is a bridge of the specified type and length available?
Definition: tunnelbridge_cmd.cpp:197
BridgeSpec::pal
PaletteID pal
the palette which is used in the GUI
Definition: bridge.h:48
Slope
Slope
Enumeration for the slope-type.
Definition: slope_type.h:48
BridgeType
uint BridgeType
Bridge spec number.
Definition: bridge.h:36
BridgeSpec::min_length
byte min_length
the minimum length (not counting start and end tile)
Definition: bridge.h:43
StringID
uint32 StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:16
HasBridgeFlatRamp
bool HasBridgeFlatRamp(Slope tileh, Axis axis)
Determines if the track on a bridge ramp is flat or goes up/down.
Definition: tunnelbridge_cmd.cpp:142
BridgeSpec::max_length
uint16 max_length
the maximum length (not counting start and end tile)
Definition: bridge.h:44
BridgeSpec::price
uint16 price
the price multiplier
Definition: bridge.h:45
PaletteID
uint32 PaletteID
The number of the palette.
Definition: gfx_type.h:18
PalSpriteID
Combination of a palette sprite and a 'real' sprite.
Definition: gfx_type.h:22
lengthof
#define lengthof(x)
Return the length of an fixed size array.
Definition: stdafx.h:367
BridgeSpec::material
StringID material
the string that contains the bridge description
Definition: bridge.h:49
Axis
Axis
Allow incrementing of DiagDirDiff variables.
Definition: direction_type.h:123
DC_NONE
@ DC_NONE
no flag is set
Definition: command_type.h:347
ResetBridges
void ResetBridges()
Reset the data been eventually changed by the grf loaded.
Definition: tunnelbridge_cmd.cpp:83
gfx_type.h
BridgePieces
BridgePieces
This enum is related to the definition of bridge pieces, which is used to determine the proper sprite...
Definition: bridge.h:21