OpenTTD Source: src/bridge.h Source File

OpenTTD Source 15.0-beta1

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#include "timer/timer_game_calendar.h"
16
22 enum BridgePieces {
23 BRIDGE_PIECE_NORTH = 0,
24 BRIDGE_PIECE_SOUTH,
25 BRIDGE_PIECE_INNER_NORTH,
26 BRIDGE_PIECE_INNER_SOUTH,
27 BRIDGE_PIECE_MIDDLE_ODD,
28 BRIDGE_PIECE_MIDDLE_EVEN,
29 BRIDGE_PIECE_HEAD,
30 NUM_BRIDGE_PIECES,
31};
32
33 DECLARE_POSTFIX_INCREMENT(BridgePieces)
34
35static const uint MAX_BRIDGES = 13;
36constexpr uint SPRITES_PER_BRIDGE_PIECE = 32;
37
38typedef uint BridgeType;
39
43struct BridgeSpec {
44 TimerGameCalendar::Year avail_year;
45 uint8_t min_length;
46 uint16_t max_length;
47 uint16_t price;
48 uint16_t speed;
49 SpriteID sprite;
50 PaletteID pal;
51 StringID material;
52 StringID transport_name[2];
53 PalSpriteID **sprite_table;
54 uint8_t flags;
55};
56
57extern BridgeSpec _bridge[MAX_BRIDGES];
58
59 Foundation GetBridgeFoundation(Slope tileh, Axis axis);
60bool HasBridgeFlatRamp(Slope tileh, Axis axis);
61
67 inline const BridgeSpec *GetBridgeSpec(BridgeType i)
68{
69 assert(i < lengthof(_bridge));
70 return &_bridge[i];
71}
72
73void DrawBridgeMiddle(const TileInfo *ti);
74
75 CommandCost CheckBridgeAvailability(BridgeType bridge_type, uint bridge_len, DoCommandFlag flags = DC_NONE);
76int CalcBridgeLenCostFactor(int x);
77
78void ResetBridges();
79
80#endif /* BRIDGE_H */
CalcBridgeLenCostFactor
int CalcBridgeLenCostFactor(int x)
Calculate the price factor for building a long bridge.
Definition tunnelbridge_cmd.cpp:108
GetBridgeSpec
const BridgeSpec * GetBridgeSpec(BridgeType i)
Get the specification of a bridge type.
Definition bridge.h:67
DrawBridgeMiddle
void DrawBridgeMiddle(const TileInfo *ti)
Draw the middle bits of a bridge.
Definition tunnelbridge_cmd.cpp:1542
GetBridgeFoundation
Foundation GetBridgeFoundation(Slope tileh, Axis axis)
Get the foundation for a bridge.
Definition tunnelbridge_cmd.cpp:129
SPRITES_PER_BRIDGE_PIECE
constexpr uint SPRITES_PER_BRIDGE_PIECE
Number of sprites there are per bridge piece.
Definition bridge.h:36
BridgePieces
BridgePieces
This enum is related to the definition of bridge pieces, which is used to determine the proper sprite...
Definition bridge.h:22
BridgeType
uint BridgeType
Bridge spec number.
Definition bridge.h:38
MAX_BRIDGES
static const uint MAX_BRIDGES
Maximal number of available bridge specs.
Definition bridge.h:35
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:145
_bridge
BridgeSpec _bridge[MAX_BRIDGES]
The specification of all bridges.
Definition tunnelbridge_cmd.cpp:52
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:200
ResetBridges
void ResetBridges()
Reset the data been eventually changed by the grf loaded.
Definition tunnelbridge_cmd.cpp:86
CommandCost
Common return value for all commands.
Definition command_type.h:23
DoCommandFlag
DoCommandFlag
List of flags for a command.
Definition command_type.h:374
DC_NONE
@ DC_NONE
no flag is set
Definition command_type.h:375
Axis
Axis
Allow incrementing of DiagDirDiff variables.
Definition direction_type.h:116
DECLARE_POSTFIX_INCREMENT
#define DECLARE_POSTFIX_INCREMENT(enum_type)
Some enums need to have allowed incrementing (i.e.
Definition enum_type.hpp:18
gfx_type.h
Types related to the graphics and/or input devices.
SpriteID
uint32_t SpriteID
The number of a sprite, without mapping bits and colourtables.
Definition gfx_type.h:18
PaletteID
uint32_t PaletteID
The number of the palette.
Definition gfx_type.h:19
Slope
Slope
Enumeration for the slope-type.
Definition slope_type.h:48
Foundation
Foundation
Enumeration for Foundations.
Definition slope_type.h:93
lengthof
#define lengthof(array)
Return the length of an fixed size array.
Definition stdafx.h:280
StringID
uint32_t StringID
Numeric value that represents a string, independent of the selected language.
Definition strings_type.h:16
BridgeSpec
Struct containing information about a single bridge type.
Definition bridge.h:43
BridgeSpec::price
uint16_t price
the price multiplier
Definition bridge.h:47
BridgeSpec::pal
PaletteID pal
the palette which is used in the GUI
Definition bridge.h:50
BridgeSpec::min_length
uint8_t min_length
the minimum length (not counting start and end tile)
Definition bridge.h:45
BridgeSpec::material
StringID material
the string that contains the bridge description
Definition bridge.h:51
BridgeSpec::avail_year
TimerGameCalendar::Year avail_year
the year where it becomes available
Definition bridge.h:44
BridgeSpec::sprite_table
PalSpriteID ** sprite_table
table of sprites for drawing the bridge
Definition bridge.h:53
BridgeSpec::sprite
SpriteID sprite
the sprite which is used in the GUI
Definition bridge.h:49
BridgeSpec::flags
uint8_t flags
bit 0 set: disable drawing of far pillars.
Definition bridge.h:54
BridgeSpec::speed
uint16_t speed
maximum travel speed (1 unit = 1/1.6 mph = 1 km-ish/h)
Definition bridge.h:48
BridgeSpec::max_length
uint16_t max_length
the maximum length (not counting start and end tile)
Definition bridge.h:46
PalSpriteID
Combination of a palette sprite and a 'real' sprite.
Definition gfx_type.h:23
StrongType::Typedef
Templated helper to make a type-safe 'typedef' representing a single POD value.
Definition strong_typedef_type.hpp:150
TileInfo
Tile information, used while rendering the tile.
Definition tile_cmd.h:43
tile_cmd.h
Generic 'commands' that can be performed on all tiles.
timer_game_calendar.h
Definition of the game-calendar-timer.