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

 
#include "../stdafx.h"
#include "../debug.h"
#include "../newgrf_engine.h"
#include "../newgrf_roadstop.h"
#include "newgrf_bytereader.h"
#include "newgrf_internal.h"
#include "newgrf_stringmapping.h"
 
#include "../safeguards.h"

static ChangeInfoResult IgnoreRoadStopProperty(uint prop, ByteReader &buf)
{
  ChangeInfoResult ret = ChangeInfoResult::Success;
 
  switch (prop) {
    case 0x09:
    case 0x0C:
    case 0x0F:
    case 0x11:
      buf.ReadByte();
      break;
 
    case 0x0A:
    case 0x0B:
    case 0x0E:
    case 0x10:
    case 0x15:
      buf.ReadWord();
      break;
 
    case 0x08:
    case 0x0D:
    case 0x12:
      buf.ReadDWord();
      break;
 
    case 0x13:
    case 0x14:
      buf.Skip(buf.ReadExtendedByte());
      break;
 
    case 0x16: // Badge list
      SkipBadgeList(buf);
      break;
 
    default:
      ret = ChangeInfoResult::Unknown;
      break;
  }
 
  return ret;
}
 
static ChangeInfoResult RoadStopChangeInfo(uint first, uint last, int prop, ByteReader &buf)
{
  ChangeInfoResult ret = ChangeInfoResult::Success;
 
  if (last > NUM_ROADSTOPS_PER_GRF) {
    GrfMsg(1, "RoadStopChangeInfo: RoadStop {} is invalid, max {}, ignoring", last, NUM_ROADSTOPS_PER_GRF);
    return ChangeInfoResult::InvalidId;
  }
 
  if (_cur_gps.grffile->roadstops.size() < last) _cur_gps.grffile->roadstops.resize(last);
 
  for (uint id = first; id < last; ++id) {
    auto &rs = _cur_gps.grffile->roadstops[id];
 
    if (rs == nullptr && prop != 0x08) {
      GrfMsg(1, "RoadStopChangeInfo: Attempt to modify undefined road stop {}, ignoring", id);
      ChangeInfoResult cir = IgnoreRoadStopProperty(prop, buf);
      if (cir > ret) ret = cir;
      continue;
    }
 
    switch (prop) {
      case 0x08: // Road Stop Class ID
        if (rs == nullptr) {
          rs = std::make_unique<RoadStopSpec>();
        }
 
        rs->class_index = RoadStopClass::Allocate(buf.ReadLabel<RoadStopClass::GlobalID>());
        break;
 
      case 0x09: // Road stop type
        rs->stop_type = (RoadStopAvailabilityType)buf.ReadByte();
        break;
 
      case 0x0A: // Road Stop Name
        AddStringForMapping(GRFStringID{buf.ReadWord()}, &rs->name);
        break;
 
      case 0x0B: // Road Stop Class name
        AddStringForMapping(GRFStringID{buf.ReadWord()}, [rs = rs.get()](StringID str) { RoadStopClass::Get(rs->class_index)->name = str; });
        break;
 
      case 0x0C: // The draw modes
        rs->draw_mode = static_cast<RoadStopDrawModes>(buf.ReadByte());
        break;
 
      case 0x0D: // Cargo types for random triggers
        rs->cargo_triggers = TranslateRefitMask(buf.ReadDWord());
        break;
 
      case 0x0E: // Animation info
        rs->animation.frames = buf.ReadByte();
        rs->animation.status = static_cast<AnimationStatus>(buf.ReadByte());
        break;
 
      case 0x0F: // Animation speed
        rs->animation.speed = buf.ReadByte();
        break;
 
      case 0x10: // Animation triggers
        rs->animation.triggers = static_cast<StationAnimationTriggers>(buf.ReadWord());
        break;
 
      case 0x11: // Callback mask
        rs->callback_mask = static_cast<RoadStopCallbackMasks>(buf.ReadByte());
        break;
 
      case 0x12: // General flags
        rs->flags = static_cast<RoadStopSpecFlags>(buf.ReadDWord()); // Future-proofing, size this as 4 bytes, but we only need two byte's worth of flags at present
        break;
 
      case 0x13: { // Minimum bridge height for each of the roadstop's tile layouts.
        uint16_t tiles = buf.ReadExtendedByte();
        for (uint j = 0; j != tiles; ++j) {
          if (j < std::size(rs->bridgeable_info)) {
            rs->bridgeable_info[j].height = buf.ReadByte();
          } else {
            buf.ReadByte();
          }
        }
        break;
      }
 
      case 0x14: { // Disallowed pillars for each of the roadstop's tile layouts.
        uint16_t tiles = buf.ReadExtendedByte();
        for (uint j = 0; j != tiles; ++j) {
          if (j < std::size(rs->bridgeable_info)) {
            rs->bridgeable_info[j].disallowed_pillars = BridgePillarFlags{buf.ReadByte()};
          } else {
            buf.ReadByte();
          }
        }
        break;
      }
 
      case 0x15: // Cost multipliers
        rs->build_cost_multiplier = buf.ReadByte();
        rs->clear_cost_multiplier = buf.ReadByte();
        break;
 
      case 0x16: // Badge list
        rs->badges = ReadBadgeList(buf, GrfSpecFeature::RoadStops);
        break;
 
      default:
        ret = ChangeInfoResult::Unknown;
        break;
    }
  }
 
  return ret;
}

template <> ChangeInfoResult GrfChangeInfoHandler<GrfSpecFeature::RoadStops>::Reserve(uint, uint, int, ByteReader &) { return ChangeInfoResult::Unhandled; }
template <> ChangeInfoResult GrfChangeInfoHandler<GrfSpecFeature::RoadStops>::Activation(uint first, uint last, int prop, ByteReader &buf) { return RoadStopChangeInfo(first, last, prop, buf); }