newgrf_railtype.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 "core/container_func.hpp"
#include "debug.h"
#include "newgrf_railtype.h"
#include "timer/timer_game_calendar.h"
#include "depot_base.h"
#include "town.h"
#include "tunnelbridge_map.h"
 
#include "safeguards.h"
 
/* virtual */ uint32_t RailTypeScopeResolver::GetRandomBits() const
{
  uint tmp = CountBits(this->tile.base() + (TileX(this->tile) + TileY(this->tile)) * TILE_SIZE);
  return GB(tmp, 0, 2);
}
 
/* virtual */ uint32_t RailTypeScopeResolver::GetVariable(uint8_t variable, [[maybe_unused]] uint32_t parameter, bool &available) const
{
  if (this->tile == INVALID_TILE) {
    switch (variable) {
      case 0x40: return 0;
      case 0x41: return 0;
      case 0x42: return 0;
      case 0x43: return TimerGameCalendar::date.base();
      case 0x44: return HZB_TOWN_EDGE;
    }
  }
 
  switch (variable) {
    case 0x40: return GetTerrainType(this->tile, this->context);
    case 0x41: return 0;
    case 0x42: return IsLevelCrossingTile(this->tile) && IsCrossingBarred(this->tile);
    case 0x43:
      if (IsRailDepotTile(this->tile)) return Depot::GetByTile(this->tile)->build_date.base();
      return TimerGameCalendar::date.base();
    case 0x44: {
      const Town *t = nullptr;
      if (IsRailDepotTile(this->tile)) {
        t = Depot::GetByTile(this->tile)->town;
      } else if (IsLevelCrossingTile(this->tile)) {
        t = ClosestTownFromTile(this->tile, UINT_MAX);
      }
      return t != nullptr ? GetTownRadiusGroup(t, this->tile) : HZB_TOWN_EDGE;
    }
  }
 
  Debug(grf, 1, "Unhandled rail type tile variable 0x{:X}", variable);
 
  available = false;
  return UINT_MAX;
}
 
GrfSpecFeature RailTypeResolverObject::GetFeature() const
{
  return GSF_RAILTYPES;
}
 
uint32_t RailTypeResolverObject::GetDebugID() const
{
  return this->railtype_scope.rti->label;
}
 
RailTypeResolverObject::RailTypeResolverObject(const RailTypeInfo *rti, TileIndex tile, TileContext context, RailTypeSpriteGroup rtsg, uint32_t param1, uint32_t param2)
  : ResolverObject(rti != nullptr ? rti->grffile[rtsg] : nullptr, CBID_NO_CALLBACK, param1, param2), railtype_scope(*this, rti, tile, context)
{
  this->root_spritegroup = rti != nullptr ? rti->group[rtsg] : nullptr;
}
 
SpriteID GetCustomRailSprite(const RailTypeInfo *rti, TileIndex tile, RailTypeSpriteGroup rtsg, TileContext context, uint *num_results)
{
  assert(rtsg < RTSG_END);
 
  if (rti->group[rtsg] == nullptr) return 0;
 
  RailTypeResolverObject object(rti, tile, context, rtsg);
  const SpriteGroup *group = object.Resolve();
  if (group == nullptr || group->GetNumResults() == 0) return 0;
 
  if (num_results) *num_results = group->GetNumResults();
 
  return group->GetResult();
}
 
SpriteID GetCustomSignalSprite(const RailTypeInfo *rti, TileIndex tile, SignalType type, SignalVariant var, SignalState state, bool gui)
{
  if (rti->group[RTSG_SIGNALS] == nullptr) return 0;
 
  uint32_t param1 = gui ? 0x10 : 0x00;
  uint32_t param2 = (type << 16) | (var << 8) | state;
  RailTypeResolverObject object(rti, tile, TCX_NORMAL, RTSG_SIGNALS, param1, param2);
 
  const SpriteGroup *group = object.Resolve();
  if (group == nullptr || group->GetNumResults() == 0) return 0;
 
  return group->GetResult();
}
 
RailType GetRailTypeTranslation(uint8_t railtype, const GRFFile *grffile)
{
  if (grffile == nullptr || grffile->railtype_list.empty()) {
    /* No railtype table present. Return railtype as-is (if valid), so it works for original railtypes. */
    if (railtype >= RAILTYPE_END || GetRailTypeInfo(static_cast<RailType>(railtype))->label == 0) return INVALID_RAILTYPE;
 
    return static_cast<RailType>(railtype);
  } else {
    /* Railtype table present, but invalid index, return invalid type. */
    if (railtype >= grffile->railtype_list.size()) return INVALID_RAILTYPE;
 
    /* Look up railtype including alternate labels. */
    return GetRailTypeByLabel(grffile->railtype_list[railtype]);
  }
}
 
uint8_t GetReverseRailTypeTranslation(RailType railtype, const GRFFile *grffile)
{
  /* No rail type table present, return rail type as-is */
  if (grffile == nullptr || grffile->railtype_list.empty()) return railtype;
 
  /* Look for a matching rail type label in the table */
  RailTypeLabel label = GetRailTypeInfo(railtype)->label;
 
  int idx = find_index(grffile->railtype_list, label);
  if (idx >= 0) return idx;
 
  /* If not found, return as invalid */
  return 0xFF;
}
 
std::vector<LabelObject<RailTypeLabel>> _railtype_list;
 
void ConvertRailTypes()
{
  std::vector<RailType> railtype_conversion_map;
  bool needs_conversion = false;
 
  for (auto it = std::begin(_railtype_list); it != std::end(_railtype_list); ++it) {
    RailType rt = GetRailTypeByLabel(it->label);
    if (rt == INVALID_RAILTYPE) {
      rt = RAILTYPE_RAIL;
    }
 
    railtype_conversion_map.push_back(rt);
 
    /* Conversion is needed if the rail type is in a different position than the list. */
    if (it->label != 0 && rt != std::distance(std::begin(_railtype_list), it)) needs_conversion = true;
  }
 
  if (!needs_conversion) return;
 
  for (const auto t : Map::Iterate()) {
    switch (GetTileType(t)) {
      case MP_RAILWAY:
        SetRailType(t, railtype_conversion_map[GetRailType(t)]);
        break;
 
      case MP_ROAD:
        if (IsLevelCrossing(t)) {
          SetRailType(t, railtype_conversion_map[GetRailType(t)]);
        }
        break;
 
      case MP_STATION:
        if (HasStationRail(t)) {
          SetRailType(t, railtype_conversion_map[GetRailType(t)]);
        }
        break;
 
      case MP_TUNNELBRIDGE:
        if (GetTunnelBridgeTransportType(t) == TRANSPORT_RAIL) {
          SetRailType(t, railtype_conversion_map[GetRailType(t)]);
        }
        break;
 
      default:
        break;
    }
  }
}
 
void SetCurrentRailTypeLabelList()
{
  _railtype_list.clear();
 
  for (RailType rt = RAILTYPE_BEGIN; rt != RAILTYPE_END; rt++) {
    _railtype_list.push_back({GetRailTypeInfo(rt)->label, 0});
  }
}
 
void ClearRailTypeLabelList()
{
  _railtype_list.clear();
}