newgrf_generic.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_spritegroup.h"
#include "industrytype.h"
#include "core/random_func.hpp"
#include "newgrf_sound.h"
#include "water_map.h"
 
#include "safeguards.h"

struct GenericScopeResolver : public ScopeResolver {
  CargoType cargo_type;
  uint8_t default_selection;
  uint8_t src_industry;        
  uint8_t dst_industry;        
  uint8_t distance;
  AIConstructionEvent event;
  uint8_t count;
  uint8_t station_size;
 
  GrfSpecFeature feature;

  GenericScopeResolver(ResolverObject &ro, bool ai_callback)
    : ScopeResolver(ro), cargo_type(0), default_selection(0), src_industry(0), dst_industry(0), distance(0),
    event(), count(0), station_size(0), feature(GrfSpecFeature::Invalid), ai_callback(ai_callback)
  {
  }
 
  uint32_t GetVariable(uint8_t variable, [[maybe_unused]] uint32_t parameter, bool &available) const override;
 
private:
  bool ai_callback; 
};
 

struct GenericResolverObject : public ResolverObject {
  GenericScopeResolver generic_scope;
 
  GenericResolverObject(bool ai_callback, CallbackID callback = CBID_NO_CALLBACK);
 
  ScopeResolver *GetScope(VarSpriteGroupScope scope = VSG_SCOPE_SELF, uint8_t relative = 0) override
  {
    switch (scope) {
      case VSG_SCOPE_SELF: return &this->generic_scope;
      default: return ResolverObject::GetScope(scope, relative);
    }
  }
 
  GrfSpecFeature GetFeature() const override
  {
    return (GrfSpecFeature)this->generic_scope.feature;
  }
 
  uint32_t GetDebugID() const override
  {
    return 0;
  }
};
 
struct GenericCallback {
  const GRFFile *file;
  const SpriteGroup *group;
 
  GenericCallback(const GRFFile *file, const SpriteGroup *group) :
    file(file),
    group(group)
  { }
};
 
typedef std::list<GenericCallback> GenericCallbackList;

static EnumClassIndexContainer<std::array<GenericCallbackList, to_underlying(GrfSpecFeature::End)>, GrfSpecFeature> _gcl{};
 

void ResetGenericCallbacks()
{
  for (auto &gcl : _gcl) {
    gcl.clear();
  }
}
 

void AddGenericCallback(GrfSpecFeature feature, const GRFFile *file, const SpriteGroup *group)
{
  if (to_underlying(feature) >= std::size(_gcl)) {
    GrfMsg(5, "AddGenericCallback: Unsupported feature 0x{:02X}", feature);
    return;
  }
 
  /* Generic feature callbacks are evaluated in reverse (i.e. the last group
   * to be added is evaluated first, etc) thus we push the group to the
   * beginning of the list so a standard iterator will do the right thing. */
  _gcl[feature].push_front(GenericCallback(file, group));
}
 
/* virtual */ uint32_t GenericScopeResolver::GetVariable(uint8_t variable, [[maybe_unused]] uint32_t parameter, bool &available) const
{
  if (this->ai_callback) {
    switch (variable) {
      case 0x40: return this->ro.grffile->cargo_map[this->cargo_type];
 
      case 0x80: return this->cargo_type;
      case 0x81: return CargoSpec::Get(this->cargo_type)->bitnum;
      case 0x82: return this->default_selection;
      case 0x83: return this->src_industry;
      case 0x84: return this->dst_industry;
      case 0x85: return this->distance;
      case 0x86: return this->event;
      case 0x87: return this->count;
      case 0x88: return this->station_size;
 
      default: break;
    }
  }
 
  Debug(grf, 1, "Unhandled generic feature variable 0x{:02X}", variable);
 
  available = false;
  return UINT_MAX;
}

GenericResolverObject::GenericResolverObject(bool ai_callback, CallbackID callback) : ResolverObject(nullptr, callback), generic_scope(*this, ai_callback)
{
}
 

static std::pair<const GRFFile *, uint16_t> GetGenericCallbackResult(GrfSpecFeature feature, ResolverObject &object, uint32_t param1_grfv7, uint32_t param1_grfv8, std::span<int32_t> regs100 = {})
{
  assert(to_underlying(feature) < std::size(_gcl));
 
  /* Test each feature callback sprite group. */
  for (const auto &it : _gcl[feature]) {
    object.grffile = it.file;
    object.root_spritegroup = it.group;
    /* Set callback param based on GRF version. */
    object.callback_param1 = it.file->grf_version >= 8 ? param1_grfv8 : param1_grfv7;
    uint16_t result = object.ResolveCallback(regs100);
    if (result == CALLBACK_FAILED) continue;
 
    return {it.file, result};
  }
 
  /* No callback returned a valid result, so we've failed. */
  return {nullptr, CALLBACK_FAILED};
}
 

std::pair<const GRFFile *, uint16_t> GetAiPurchaseCallbackResult(GrfSpecFeature feature, CargoType cargo_type, uint8_t default_selection, IndustryType src_industry, IndustryType dst_industry, uint8_t distance, AIConstructionEvent event, uint8_t count, uint8_t station_size)
{
  GenericResolverObject object(true, CBID_GENERIC_AI_PURCHASE_SELECTION);
 
  if (src_industry != IT_AI_UNKNOWN && src_industry != IT_AI_TOWN) {
    const IndustrySpec *is = GetIndustrySpec(src_industry);
    /* If this is no original industry, use the substitute type */
    if (is->grf_prop.subst_id != IT_INVALID) src_industry = is->grf_prop.subst_id;
  }
 
  if (dst_industry != IT_AI_UNKNOWN && dst_industry != IT_AI_TOWN) {
    const IndustrySpec *is = GetIndustrySpec(dst_industry);
    /* If this is no original industry, use the substitute type */
    if (is->grf_prop.subst_id != IT_INVALID) dst_industry = is->grf_prop.subst_id;
  }
 
  object.generic_scope.cargo_type        = cargo_type;
  object.generic_scope.default_selection = default_selection;
  object.generic_scope.src_industry      = src_industry;
  object.generic_scope.dst_industry      = dst_industry;
  object.generic_scope.distance          = distance;
  object.generic_scope.event             = event;
  object.generic_scope.count             = count;
  object.generic_scope.station_size      = station_size;
  object.generic_scope.feature           = feature;
 
  auto callback = GetGenericCallbackResult(feature, object, 0, 0);
  if (callback.second != CALLBACK_FAILED && callback.first->grf_version < 8) callback.second = GB(callback.second, 0, 8);
  return callback;
}
 

void AmbientSoundEffectCallback(TileIndex tile)
{
  assert(IsTileType(tile, TileType::Clear) || IsTileType(tile, TileType::Trees) || IsTileType(tile, TileType::Water));
 
  /* Only run every 1/200-th time. */
  uint32_t r; // Save for later
  if (!Chance16R(1, 200, r) || !_settings_client.sound.ambient) return;
 
  /* Prepare resolver object. */
  GenericResolverObject object(false, CBID_SOUNDS_AMBIENT_EFFECT);
  object.generic_scope.feature = GrfSpecFeature::SoundEffects;
 
  uint32_t param1_v7 = to_underlying(GetTileType(tile)) << 28 | Clamp(TileHeight(tile), 0, 15) << 24 | GB(r, 16, 8) << 16 | GetTerrainType(tile);
  uint32_t param1_v8 = to_underlying(GetTileType(tile)) << 24 | GetTileZ(tile) << 16 | GB(r, 16, 8) << 8 | (HasTileWaterClass(tile) ? to_underlying(GetWaterClass(tile)) : 0) << 3 | GetTerrainType(tile);
 
  /* Run callback. */
  auto callback = GetGenericCallbackResult(GrfSpecFeature::SoundEffects, object, param1_v7, param1_v8);
 
  if (callback.second != CALLBACK_FAILED) PlayTileSound(callback.first, callback.second, tile);
}