bridge.h

Go to the documentation of this file.

/*
 * This file is part of OpenTTD.
 * 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.
 * 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.
 * 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/>.
 */
 
#ifndef BRIDGE_H
#define BRIDGE_H
 
#include "gfx_type.h"
#include "tile_cmd.h"
#include "timer/timer_game_calendar.h"
#include "bridge_type.h"
 
static const uint MAX_BRIDGES = 13; 
constexpr uint SPRITES_PER_BRIDGE_PIECE = 32; 
 
/* Container for Bridge pillar flags for each axis of each bridge middle piece. */
using BridgeMiddlePillarFlags = std::array<std::array<BridgePillarFlags, AXIS_END>, NUM_BRIDGE_MIDDLE_PIECES>;
 
struct BridgeSpec {
  enum class ControlFlag : uint8_t {
    CustomPillarFlags, 
    InvalidPillarFlags, 
  };
  using ControlFlags = EnumBitSet<ControlFlag, uint8_t>;
 
  TimerGameCalendar::Year avail_year; 
  uint8_t min_length;                    
  uint16_t max_length;                  
  uint16_t price;                       
  uint16_t speed;                       
  SpriteID sprite;                    
  PaletteID pal;                      
  StringID material;                  
  StringID transport_name[2];         
  std::vector<std::vector<PalSpriteID>> sprite_table; 
  uint8_t flags;                         
  ControlFlags ctrl_flags{}; 
  BridgeMiddlePillarFlags pillar_flags{}; 
};
 
extern BridgeSpec _bridge[MAX_BRIDGES];
 
Foundation GetBridgeFoundation(Slope tileh, Axis axis);
bool HasBridgeFlatRamp(Slope tileh, Axis axis);
 
inline const BridgeSpec *GetBridgeSpec(BridgeType i)
{
  assert(i < lengthof(_bridge));
  return &_bridge[i];
}
 
void DrawBridgeMiddle(const TileInfo *ti, BridgePillarFlags blocked_pillars);
 
CommandCost CheckBridgeAvailability(BridgeType bridge_type, uint bridge_len, DoCommandFlags flags = {});
int CalcBridgeLenCostFactor(int x);
 
void ResetBridges();
 
#endif /* BRIDGE_H */