road.cpp

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/>.
 */
 
#include "stdafx.h"
#include "rail_map.h"
#include "road_map.h"
#include "water_map.h"
#include "genworld.h"
#include "company_func.h"
#include "company_base.h"
#include "engine_base.h"
#include "timer/timer_game_calendar.h"
#include "landscape.h"
#include "road.h"
#include "road_func.h"
#include "roadveh.h"
 
#include "safeguards.h"
 
RoadType RoadTypeInfo::Index() const
{
  extern RoadTypeInfo _roadtypes[ROADTYPE_END];
  size_t index = this - _roadtypes;
  assert(index < ROADTYPE_END);
  return static_cast<RoadType>(index);
}
 
static bool IsPossibleCrossing(const TileIndex tile, Axis ax)
{
  return (IsTileType(tile, MP_RAILWAY) &&
    GetRailTileType(tile) == RAIL_TILE_NORMAL &&
    GetTrackBits(tile) == (ax == AXIS_X ? TRACK_BIT_Y : TRACK_BIT_X) &&
    std::get<0>(GetFoundationSlope(tile)) == SLOPE_FLAT);
}
 
RoadBits CleanUpRoadBits(const TileIndex tile, RoadBits org_rb)
{
  if (!IsValidTile(tile)) return ROAD_NONE;
  for (DiagDirection dir = DIAGDIR_BEGIN; dir < DIAGDIR_END; dir++) {
    const TileIndex neighbour_tile = TileAddByDiagDir(tile, dir);
 
    /* Get the Roadbit pointing to the neighbour_tile */
    const RoadBits target_rb = DiagDirToRoadBits(dir);
 
    /* If the roadbit is in the current plan */
    if (org_rb & target_rb) {
      bool connective = false;
      const RoadBits mirrored_rb = MirrorRoadBits(target_rb);
 
      if (IsValidTile(neighbour_tile)) {
        switch (GetTileType(neighbour_tile)) {
          /* Always connective ones */
          case MP_CLEAR: case MP_TREES:
            connective = true;
            break;
 
          /* The conditionally connective ones */
          case MP_TUNNELBRIDGE:
          case MP_STATION:
          case MP_ROAD:
            if (IsNormalRoadTile(neighbour_tile)) {
              /* Always connective */
              connective = true;
            } else {
              const RoadBits neighbour_rb = GetAnyRoadBits(neighbour_tile, RTT_ROAD) | GetAnyRoadBits(neighbour_tile, RTT_TRAM);
 
              /* Accept only connective tiles */
              connective = (neighbour_rb & mirrored_rb) != ROAD_NONE;
            }
            break;
 
          case MP_RAILWAY:
            connective = IsPossibleCrossing(neighbour_tile, DiagDirToAxis(dir));
            break;
 
          case MP_WATER:
            /* Check for real water tile */
            connective = !IsWater(neighbour_tile);
            break;
 
          /* The definitely not connective ones */
          default: break;
        }
      }
 
      /* If the neighbour tile is inconnective, remove the planned road connection to it */
      if (!connective) org_rb ^= target_rb;
    }
  }
 
  return org_rb;
}
 
bool HasRoadTypeAvail(const CompanyID company, RoadType roadtype)
{
  if (company == OWNER_DEITY || company == OWNER_TOWN || _game_mode == GM_EDITOR || _generating_world) {
    const RoadTypeInfo *rti = GetRoadTypeInfo(roadtype);
    if (rti->label == 0) return false;
 
    /* Not yet introduced at this date. */
    if (IsInsideMM(rti->introduction_date, 0, CalendarTime::MAX_DATE.base()) && rti->introduction_date > TimerGameCalendar::date) return false;
 
    /*
     * Do not allow building hidden road types, except when a town may build it.
     * The GS under deity mode, as well as anybody in the editor builds roads that are
     * owned by towns. So if a town may build it, it should be buildable by them too.
     */
    return !rti->flags.Test( RoadTypeFlag::Hidden) || rti->flags.Test( RoadTypeFlag::TownBuild);
  } else {
    const Company *c = Company::GetIfValid(company);
    if (c == nullptr) return false;
    RoadTypes avail = c->avail_roadtypes;
    avail.Reset(_roadtypes_hidden_mask);
    return avail.Test(roadtype);
  }
}
 
bool HasAnyRoadTypesAvail(CompanyID company, RoadTramType rtt)
{
  RoadTypes avail = Company::Get(company)->avail_roadtypes;
  avail.Reset(_roadtypes_hidden_mask);
  return avail.Any(GetMaskForRoadTramType(rtt));
}
 
bool ValParamRoadType(RoadType roadtype)
{
  return roadtype < ROADTYPE_END && HasRoadTypeAvail(_current_company, roadtype);
}
 
RoadTypes AddDateIntroducedRoadTypes(RoadTypes current, TimerGameCalendar::Date date)
{
  RoadTypes rts = current;
 
  for (RoadType rt = ROADTYPE_BEGIN; rt != ROADTYPE_END; rt++) {
    const RoadTypeInfo *rti = GetRoadTypeInfo(rt);
    /* Unused road type. */
    if (rti->label == 0) continue;
 
    /* Not date introduced. */
    if (!IsInsideMM(rti->introduction_date, 0, CalendarTime::MAX_DATE.base())) continue;
 
    /* Not yet introduced at this date. */
    if (rti->introduction_date > date) continue;
 
    /* Have we introduced all required roadtypes? */
    RoadTypes required = rti->introduction_required_roadtypes;
    if (!rts.All(required)) continue;
 
    rts.Set(rti->introduces_roadtypes);
  }
 
  /* When we added roadtypes we need to run this method again; the added
   * roadtypes might enable more rail types to become introduced. */
  return rts == current ? rts : AddDateIntroducedRoadTypes(rts, date);
}
 
RoadTypes GetCompanyRoadTypes(CompanyID company, bool introduces)
{
  RoadTypes rts{};
 
  for (const Engine *e : Engine::IterateType(VEH_ROAD)) {
    const EngineInfo *ei = &e->info;
 
    if (ei->climates.Test(_settings_game.game_creation.landscape) &&
        (e->company_avail.Test(company) || TimerGameCalendar::date >= e->intro_date + CalendarTime::DAYS_IN_YEAR)) {
      const RoadVehicleInfo *rvi = &e->VehInfo<RoadVehicleInfo>();
      assert(rvi->roadtype < ROADTYPE_END);
      if (introduces) {
        rts.Set(GetRoadTypeInfo(rvi->roadtype)->introduces_roadtypes);
      } else {
        rts.Set(rvi->roadtype);
      }
    }
  }
 
  if (introduces) return AddDateIntroducedRoadTypes(rts, TimerGameCalendar::date);
  return rts;
}
 
RoadTypes GetRoadTypes(bool introduces)
{
  RoadTypes rts{};
 
  for (const Engine *e : Engine::IterateType(VEH_ROAD)) {
    const EngineInfo *ei = &e->info;
    if (!ei->climates.Test(_settings_game.game_creation.landscape)) continue;
 
    const RoadVehicleInfo *rvi = &e->VehInfo<RoadVehicleInfo>();
    assert(rvi->roadtype < ROADTYPE_END);
    if (introduces) {
      rts.Set(GetRoadTypeInfo(rvi->roadtype)->introduces_roadtypes);
    } else {
      rts.Set(rvi->roadtype);
    }
  }
 
  if (introduces) return AddDateIntroducedRoadTypes(rts, CalendarTime::MAX_DATE);
  return rts;
}
 
RoadType GetRoadTypeByLabel(RoadTypeLabel label, bool allow_alternate_labels)
{
  extern RoadTypeInfo _roadtypes[ROADTYPE_END];
  if (label == 0) return INVALID_ROADTYPE;
 
  auto it = std::ranges::find(_roadtypes, label, &RoadTypeInfo::label);
  if (it == std::end(_roadtypes) && allow_alternate_labels) {
    /* Test if any road type defines the label as an alternate. */
    it = std::ranges::find_if(_roadtypes, [label](const RoadTypeInfo &rti) { return rti.alternate_labels.contains(label); });
  }
 
  if (it != std::end(_roadtypes)) return it->Index();
 
  /* No matching label was found, so it is invalid */
  return INVALID_ROADTYPE;
}