road_func.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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
 */

 
#ifndef ROAD_FUNC_H
#define ROAD_FUNC_H
 
#include "core/bitmath_func.hpp"
#include "road.h"
#include "economy_func.h"
#include "transparency.h"

inline bool IsValidRoadBits(RoadBits r)
{
  return r < ROAD_END;
}

inline RoadBits ComplementRoadBits(RoadBits r)
{
  assert(IsValidRoadBits(r));
  return (RoadBits)(ROAD_ALL ^ r);
}

inline RoadBits MirrorRoadBits(RoadBits r)
{
  assert(IsValidRoadBits(r));
  return (RoadBits)(GB(r, 0, 2) << 2 | GB(r, 2, 2));
}

inline RoadBits RotateRoadBits(RoadBits r, DiagDirDiff rot)
{
  assert(IsValidRoadBits(r));
  for (; rot > (DiagDirDiff)0; rot--) {
    r = (RoadBits)(GB(r, 0, 1) << 3 | GB(r, 1, 3));
  }
  return r;
}

inline bool IsStraightRoad(RoadBits r)
{
  assert(IsValidRoadBits(r));
  return (r == ROAD_X || r == ROAD_Y);
}

inline RoadBits DiagDirToRoadBits(DiagDirection d)
{
  assert(IsValidDiagDirection(d));
  return (RoadBits)(ROAD_NW << (3 ^ d));
}

inline RoadBits AxisToRoadBits(Axis a)
{
  assert(IsValidAxis(a));
  return a == AXIS_X ? ROAD_X : ROAD_Y;
}
 

inline Money RoadMaintenanceCost(RoadType roadtype, uint32_t num, uint32_t total_num)
{
  assert(roadtype < ROADTYPE_END);
  return (_price[Price::InfrastructureRoad] * GetRoadTypeInfo(roadtype)->maintenance_multiplier * num * (1 + IntSqrt(total_num))) >> 12;
}

inline bool HasRoadCatenary(RoadType roadtype)
{
  assert(roadtype < ROADTYPE_END);
  return GetRoadTypeInfo(roadtype)->flags.Test(RoadTypeFlag::Catenary);
}

inline bool HasRoadCatenaryDrawn(RoadType roadtype)
{
  return HasRoadCatenary(roadtype) && !IsInvisibilitySet(TO_CATENARY);
}
 
bool HasRoadTypeAvail(CompanyID company, RoadType roadtype);
bool ValParamRoadType(RoadType roadtype);
RoadTypes GetCompanyRoadTypes(CompanyID company, bool introduces = true);
RoadTypes GetRoadTypes(bool introduces);
RoadTypes AddDateIntroducedRoadTypes(RoadTypes current, TimerGameCalendar::Date date);
 
void UpdateLevelCrossing(TileIndex tile, bool sound = true, bool force_bar = false);
void MarkDirtyAdjacentLevelCrossingTiles(TileIndex tile, Axis road_axis);
void UpdateAdjacentLevelCrossingTilesOnLevelCrossingRemoval(TileIndex tile, Axis road_axis);
void UpdateCompanyRoadInfrastructure(RoadType rt, Owner o, int count);
 
struct TileInfo;
enum class Roadside : uint8_t;
void DrawRoadOverlays(const TileInfo *ti, PaletteID pal, const RoadTypeInfo *road_rti, const RoadTypeInfo *tram_rit, uint road_offset, uint tram_offset, bool draw_underlay = true);
void DrawRoadGroundSprites(const TileInfo *ti, RoadBits road, RoadBits tram, const RoadTypeInfo *road_rti, const RoadTypeInfo *tram_rti, Roadside roadside, bool snow_or_desert);
 
#endif /* ROAD_FUNC_H */