articulated_vehicles.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 "core/bitmath_func.hpp"
#include "core/random_func.hpp"
#include "train.h"
#include "roadveh.h"
#include "vehicle_func.h"
#include "engine_func.h"
#include "company_func.h"
#include "newgrf.h"
 
#include "table/strings.h"
 
#include "safeguards.h"
 
static const uint MAX_ARTICULATED_PARTS = 100; 
 
static EngineID GetNextArticulatedPart(uint index, EngineID front_type, Vehicle *front = nullptr, bool *mirrored = nullptr)
{
  assert(front == nullptr || front->engine_type == front_type);
 
  const Engine *front_engine = Engine::Get(front_type);
 
  uint16_t callback = GetVehicleCallback(CBID_VEHICLE_ARTIC_ENGINE, index, 0, front_type, front);
  if (callback == CALLBACK_FAILED) return EngineID::Invalid();
 
  if (front_engine->GetGRF()->grf_version < 8) {
    /* 8 bits, bit 7 for mirroring */
    callback = GB(callback, 0, 8);
    if (callback == 0xFF) return EngineID::Invalid();
    if (mirrored != nullptr) *mirrored = HasBit(callback, 7);
    callback = GB(callback, 0, 7);
  } else {
    /* 15 bits, bit 14 for mirroring */
    if (callback == 0x7FFF) return EngineID::Invalid();
    if (mirrored != nullptr) *mirrored = HasBit(callback, 14);
    callback = GB(callback, 0, 14);
  }
 
  return GetNewEngineID(front_engine->GetGRF(), front_engine->type, callback);
}
 
bool IsArticulatedEngine(EngineID engine_type)
{
  return EngInfo(engine_type)->callback_mask.Test(VehicleCallbackMask::ArticEngine);
}
 
uint CountArticulatedParts(EngineID engine_type)
{
  if (!EngInfo(engine_type)->callback_mask.Test(VehicleCallbackMask::ArticEngine)) return 0;
 
  Vehicle v(VehicleID::Invalid());
  v.engine_type = engine_type;
  v.owner = _current_company;
 
  uint i;
  for (i = 1; i < MAX_ARTICULATED_PARTS; i++) {
    if (GetNextArticulatedPart(i, engine_type, &v) == EngineID::Invalid()) break;
  }
 
  return i - 1;
}
 
 
static inline std::pair<CargoType, uint16_t> GetVehicleDefaultCapacity(EngineID engine)
{
  const Engine *e = Engine::Get(engine);
  CargoType cargo = e->CanCarryCargo() ? e->GetDefaultCargoType() : INVALID_CARGO;
  return {cargo, IsValidCargoType(cargo) ? e->GetDisplayDefaultCapacity() : 0};
}
 
static inline CargoTypes GetAvailableVehicleCargoTypes(EngineID engine, bool include_initial_cargo_type)
{
  const Engine *e = Engine::Get(engine);
  if (!e->CanCarryCargo()) return 0;
 
  CargoTypes cargoes = e->info.refit_mask;
 
  if (include_initial_cargo_type) {
    SetBit(cargoes, e->GetDefaultCargoType());
  }
 
  return cargoes;
}
 
CargoArray GetCapacityOfArticulatedParts(EngineID engine)
{
  CargoArray capacity{};
  const Engine *e = Engine::Get(engine);
 
  if (auto [cargo, cap] = GetVehicleDefaultCapacity(engine); IsValidCargoType(cargo)) {
    capacity[cargo] = cap;
  }
 
  if (!e->IsGroundVehicle()) return capacity;
 
  if (!e->info.callback_mask.Test(VehicleCallbackMask::ArticEngine)) return capacity;
 
  for (uint i = 1; i < MAX_ARTICULATED_PARTS; i++) {
    EngineID artic_engine = GetNextArticulatedPart(i, engine);
    if (artic_engine == EngineID::Invalid()) break;
 
    if (auto [cargo, cap] = GetVehicleDefaultCapacity(artic_engine); IsValidCargoType(cargo)) {
      capacity[cargo] += cap;
    }
  }
 
  return capacity;
}
 
CargoTypes GetCargoTypesOfArticulatedParts(EngineID engine)
{
  CargoTypes cargoes = 0;
  const Engine *e = Engine::Get(engine);
 
  if (auto [cargo, cap] = GetVehicleDefaultCapacity(engine); IsValidCargoType(cargo) && cap > 0) {
    SetBit(cargoes, cargo);
  }
 
  if (!e->IsGroundVehicle()) return cargoes;
 
  if (!e->info.callback_mask.Test(VehicleCallbackMask::ArticEngine)) return cargoes;
 
  for (uint i = 1; i < MAX_ARTICULATED_PARTS; i++) {
    EngineID artic_engine = GetNextArticulatedPart(i, engine);
    if (artic_engine == EngineID::Invalid()) break;
 
    if (auto [cargo, cap] = GetVehicleDefaultCapacity(artic_engine); IsValidCargoType(cargo) && cap > 0) {
      SetBit(cargoes, cargo);
    }
  }
 
  return cargoes;
}
 
bool IsArticulatedVehicleRefittable(EngineID engine)
{
  if (IsEngineRefittable(engine)) return true;
 
  const Engine *e = Engine::Get(engine);
  if (!e->IsGroundVehicle()) return false;
 
  if (!e->info.callback_mask.Test(VehicleCallbackMask::ArticEngine)) return false;
 
  for (uint i = 1; i < MAX_ARTICULATED_PARTS; i++) {
    EngineID artic_engine = GetNextArticulatedPart(i, engine);
    if (artic_engine == EngineID::Invalid()) break;
 
    if (IsEngineRefittable(artic_engine)) return true;
  }
 
  return false;
}
 
void GetArticulatedRefitMasks(EngineID engine, bool include_initial_cargo_type, CargoTypes *union_mask, CargoTypes *intersection_mask)
{
  const Engine *e = Engine::Get(engine);
  CargoTypes veh_cargoes = GetAvailableVehicleCargoTypes(engine, include_initial_cargo_type);
  *union_mask = veh_cargoes;
  *intersection_mask = (veh_cargoes != 0) ? veh_cargoes : ALL_CARGOTYPES;
 
  if (!e->IsGroundVehicle()) return;
  if (!e->info.callback_mask.Test(VehicleCallbackMask::ArticEngine)) return;
 
  for (uint i = 1; i < MAX_ARTICULATED_PARTS; i++) {
    EngineID artic_engine = GetNextArticulatedPart(i, engine);
    if (artic_engine == EngineID::Invalid()) break;
 
    veh_cargoes = GetAvailableVehicleCargoTypes(artic_engine, include_initial_cargo_type);
    *union_mask |= veh_cargoes;
    if (veh_cargoes != 0) *intersection_mask &= veh_cargoes;
  }
}
 
CargoTypes GetUnionOfArticulatedRefitMasks(EngineID engine, bool include_initial_cargo_type)
{
  CargoTypes union_mask, intersection_mask;
  GetArticulatedRefitMasks(engine, include_initial_cargo_type, &union_mask, &intersection_mask);
  return union_mask;
}
 
CargoTypes GetCargoTypesOfArticulatedVehicle(const Vehicle *v, CargoType *cargo_type)
{
  CargoTypes cargoes = 0;
  CargoType first_cargo = INVALID_CARGO;
 
  do {
    if (IsValidCargoType(v->cargo_type) && v->GetEngine()->CanCarryCargo()) {
      SetBit(cargoes, v->cargo_type);
      if (!IsValidCargoType(first_cargo)) first_cargo = v->cargo_type;
      if (first_cargo != v->cargo_type) {
        if (cargo_type != nullptr) {
          *cargo_type = INVALID_CARGO;
          cargo_type = nullptr;
        }
      }
    }
 
    v = v->HasArticulatedPart() ? v->GetNextArticulatedPart() : nullptr;
  } while (v != nullptr);
 
  if (cargo_type != nullptr) *cargo_type = first_cargo;
  return cargoes;
}
 
void CheckConsistencyOfArticulatedVehicle(const Vehicle *v)
{
  const Engine *engine = v->GetEngine();
 
  CargoTypes purchase_refit_union, purchase_refit_intersection;
  GetArticulatedRefitMasks(v->engine_type, true, &purchase_refit_union, &purchase_refit_intersection);
  CargoArray purchase_default_capacity = GetCapacityOfArticulatedParts(v->engine_type);
 
  CargoTypes real_refit_union = 0;
  CargoTypes real_refit_intersection = ALL_CARGOTYPES;
  CargoTypes real_default_cargoes = 0;
 
  do {
    CargoTypes refit_mask = GetAvailableVehicleCargoTypes(v->engine_type, true);
    real_refit_union |= refit_mask;
    if (refit_mask != 0) real_refit_intersection &= refit_mask;
 
    assert(v->cargo_type < NUM_CARGO);
    if (v->cargo_cap > 0) SetBit(real_default_cargoes, v->cargo_type);
 
    v = v->HasArticulatedPart() ? v->GetNextArticulatedPart() : nullptr;
  } while (v != nullptr);
 
  /* Check whether the vehicle carries more cargoes than expected */
  bool carries_more = false;
  for (CargoType cargo_type : SetCargoBitIterator(real_default_cargoes)) {
    if (purchase_default_capacity[cargo_type] == 0) {
      carries_more = true;
      break;
    }
  }
 
  /* show a warning once for each GRF after each game load */
  if (real_refit_union != purchase_refit_union || real_refit_intersection != purchase_refit_intersection || carries_more) {
    ShowNewGrfVehicleError(engine->index, STR_NEWGRF_BUGGY, STR_NEWGRF_BUGGY_ARTICULATED_CARGO, GRFBug::VehRefit, false);
  }
}
 
void AddArticulatedParts(Vehicle *first)
{
  VehicleType type = first->type;
  if (!EngInfo(first->engine_type)->callback_mask.Test(VehicleCallbackMask::ArticEngine)) return;
 
  Vehicle *v = first;
  for (uint i = 1; i < MAX_ARTICULATED_PARTS; i++) {
    bool flip_image;
    EngineID engine_type = GetNextArticulatedPart(i, first->engine_type, first, &flip_image);
    if (engine_type == EngineID::Invalid()) return;
 
    /* In the (very rare) case the GRF reported wrong number of articulated parts
     * and we run out of available vehicles, bail out. */
    if (!Vehicle::CanAllocateItem()) return;
 
    GroundVehicleCache *gcache = v->GetGroundVehicleCache();
    gcache->first_engine = v->engine_type; // Needs to be set before first callback
 
    const Engine *e_artic = Engine::Get(engine_type);
    switch (type) {
      default: NOT_REACHED();
 
      case VEH_TRAIN: {
        Train *front = Train::From(first);
        Train *t = Train::Create();
        v->SetNext(t);
        v = t;
 
        t->subtype = 0;
        t->track = front->track;
        t->railtypes = front->railtypes;
 
        t->spritenum = e_artic->VehInfo<RailVehicleInfo>().image_index;
        if (e_artic->CanCarryCargo()) {
          t->cargo_type = e_artic->GetDefaultCargoType();
          t->cargo_cap = e_artic->VehInfo<RailVehicleInfo>().capacity;  // Callback 36 is called when the consist is finished
        } else {
          t->cargo_type = front->cargo_type; // Needed for livery selection
          t->cargo_cap = 0;
        }
        t->refit_cap = 0;
 
        t->SetArticulatedPart();
        break;
      }
 
      case VEH_ROAD: {
        RoadVehicle *front = RoadVehicle::From(first);
        RoadVehicle *rv = RoadVehicle::Create();
        v->SetNext(rv);
        v = rv;
 
        rv->subtype = 0;
        gcache->cached_veh_length = VEHICLE_LENGTH; // Callback is called when the consist is finished
        rv->state = RVSB_IN_DEPOT;
 
        rv->roadtype = front->roadtype;
        rv->compatible_roadtypes = front->compatible_roadtypes;
 
        rv->spritenum = e_artic->VehInfo<RoadVehicleInfo>().image_index;
        if (e_artic->CanCarryCargo()) {
          rv->cargo_type = e_artic->GetDefaultCargoType();
          assert(IsValidCargoType(rv->cargo_type));
          rv->cargo_cap = e_artic->VehInfo<RoadVehicleInfo>().capacity;  // Callback 36 is called when the consist is finished
        } else {
          rv->cargo_type = front->cargo_type; // Needed for livery selection
          rv->cargo_cap = 0;
        }
        rv->refit_cap = 0;
 
        rv->SetArticulatedPart();
        break;
      }
    }
 
    /* get common values from first engine */
    v->direction = first->direction;
    v->owner = first->owner;
    v->tile = first->tile;
    v->x_pos = first->x_pos;
    v->y_pos = first->y_pos;
    v->z_pos = first->z_pos;
    v->date_of_last_service = first->date_of_last_service;
    v->date_of_last_service_newgrf = first->date_of_last_service_newgrf;
    v->build_year = first->build_year;
    v->vehstatus = first->vehstatus;
    v->vehstatus.Reset(VehState::Stopped);
 
    v->cargo_subtype = 0;
    v->max_age = CalendarTime::MIN_DATE;
    v->engine_type = engine_type;
    v->value = 0;
    v->sprite_cache.sprite_seq.Set(SPR_IMG_QUERY);
    v->random_bits = Random();
 
    if (flip_image) v->spritenum++;
 
    if (v->type == VEH_TRAIN) {
      auto prob = TestVehicleBuildProbability(v, v->engine_type, BuildProbabilityType::Reversed);
      if (prob.has_value()) Train::From(v)->flags.Set(VehicleRailFlag::Flipped, prob.value());
    }
    v->UpdatePosition();
  }
}