newgrf_object.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 "company_base.h"
#include "company_func.h"
#include "debug.h"
#include "genworld.h"
#include "newgrf_badge.h"
#include "newgrf_object.h"
#include "newgrf_sound.h"
#include "object_base.h"
#include "object_map.h"
#include "timer/timer_game_calendar.h"
#include "tile_cmd.h"
#include "town.h"
#include "water.h"
#include "newgrf_animation_base.h"
 
#include "table/strings.h"
 
#include "newgrf_class_func.h"
 
#include "safeguards.h"

ObjectOverrideManager _object_mngr(NEW_OBJECT_OFFSET, NUM_OBJECTS, INVALID_OBJECT_TYPE);
 
extern const ObjectSpec _original_objects[NEW_OBJECT_OFFSET];
std::vector<ObjectSpec> _object_specs;
 
const std::vector<ObjectSpec> &ObjectSpec::Specs()
{
  return _object_specs;
}
 
size_t ObjectSpec::Count()
{
  return _object_specs.size();
}

/* static */ const ObjectSpec *ObjectSpec::Get(ObjectType index)
{
  /* Empty object if index is out of range -- this might happen if NewGRFs are changed. */
  static ObjectSpec empty = {};
 
  assert(index < NUM_OBJECTS);
  if (index >= _object_specs.size()) return &empty;
  return &_object_specs[index];
}

/* static */ const ObjectSpec *ObjectSpec::GetByTile(TileIndex tile)
{
  return ObjectSpec::Get(GetObjectType(tile));
}

bool ObjectSpec::IsEverAvailable() const
{
  return this->IsEnabled() && this->climate.Test(_settings_game.game_creation.landscape) &&
      !this->flags.Test((_game_mode != GM_EDITOR && !_generating_world) ? ObjectFlag::OnlyInScenedit : ObjectFlag::OnlyInGame);
}

bool ObjectSpec::WasEverAvailable() const
{
  return this->IsEverAvailable() && TimerGameCalendar::date >= this->introduction_date;
}

bool ObjectSpec::IsAvailable() const
{
  return this->WasEverAvailable() &&
      (TimerGameCalendar::date < this->end_of_life_date || this->end_of_life_date < this->introduction_date + 365);
}

uint ObjectSpec::Index() const
{
  return this - _object_specs.data();
}

/* static */ void ObjectSpec::BindToClasses()
{
  for (auto &spec : _object_specs) {
    if (spec.IsEnabled() && spec.class_index != INVALID_OBJECT_CLASS) {
      ObjectClass::Assign(&spec);
    }
  }
}

void ResetObjects()
{
  /* Clean the pool. */
  _object_specs.clear();
 
  /* And add our originals. */
  _object_specs.reserve(lengthof(_original_objects));
 
  for (uint16_t i = 0; i < lengthof(_original_objects); i++) {
    ObjectSpec &spec = _object_specs.emplace_back(_original_objects[i]);
    spec.grf_prop.local_id = i;
  }
 
  /* Set class for originals. */
  _object_specs[OBJECT_LIGHTHOUSE].class_index = ObjectClass::Allocate('LTHS');
  _object_specs[OBJECT_TRANSMITTER].class_index = ObjectClass::Allocate('TRNS');
}
 
template <>
/* static */ void ObjectClass::InsertDefaults()
{
  ObjectClass::Get(ObjectClass::Allocate('LTHS'))->name = STR_OBJECT_CLASS_LTHS;
  ObjectClass::Get(ObjectClass::Allocate('TRNS'))->name = STR_OBJECT_CLASS_TRNS;
}
 
template <>
bool ObjectClass::IsUIAvailable(uint index) const
{
  return this->GetSpec(index)->IsEverAvailable();
}
 
/* Instantiate ObjectClass. */
template class NewGRFClass<ObjectSpec, ObjectClassID, OBJECT_CLASS_MAX>;
 
/* virtual */ uint32_t ObjectScopeResolver::GetRandomBits() const
{
  return IsValidTile(this->tile) && IsTileType(this->tile, TileType::Object) ? GetObjectRandomBits(this->tile) : 0;
}

static uint32_t GetObjectIDAtOffset(TileIndex tile, uint32_t cur_grfid)
{
  if (!IsTileType(tile, TileType::Object)) {
    return 0xFFFF;
  }
 
  const Object *o = Object::GetByTile(tile);
  const ObjectSpec *spec = ObjectSpec::Get(o->type);
 
  /* Default objects have no associated NewGRF file */
  if (!spec->grf_prop.HasGrfFile()) {
    return 0xFFFE; // Defined in another grf file
  }
 
  if (spec->grf_prop.grfid == cur_grfid) { // same object, same grf ?
    return spec->grf_prop.local_id | o->view << 16;
  }
 
  return 0xFFFE; // Defined in another grf file
}

static uint32_t GetNearbyObjectTileInformation(uint8_t parameter, TileIndex tile, ObjectID index, bool grf_version8)
{
  if (parameter != 0) tile = GetNearbyTile(parameter, tile); // only perform if it is required
  bool is_same_object = (IsTileType(tile, TileType::Object) && GetObjectIndex(tile) == index);
 
  return GetNearbyTileInformation(tile, grf_version8) | (is_same_object ? 1 : 0) << 8;
}

static uint32_t GetClosestObject(TileIndex tile, ObjectType type, const Object *current)
{
  uint32_t best_dist = UINT32_MAX;
  for (const Object *o : Object::Iterate()) {
    if (o->type != type || o == current) continue;
 
    best_dist = std::min(best_dist, DistanceManhattan(tile, o->location.tile));
  }
 
  return best_dist;
}

static uint32_t GetCountAndDistanceOfClosestInstance(const ResolverObject &object, uint8_t local_id, uint32_t grfid, TileIndex tile, const Object *current)
{
  uint32_t grf_id = static_cast<uint32_t>(object.GetRegister(0x100)); // Get the GRFID of the definition to look for in register 100h
  uint32_t idx;
 
  /* Determine what will be the object type to look for */
  switch (grf_id) {
    case 0:  // this is a default object type
      idx = local_id;
      break;
 
    case 0xFFFFFFFF: // current grf
      grf_id = grfid;
      [[fallthrough]];
 
    default: // use the grfid specified in register 100h
      idx = _object_mngr.GetID(local_id, grf_id);
      break;
  }
 
  /* If the object type is invalid, there is none and the closest is far away. */
  if (idx >= NUM_OBJECTS) return 0 | 0xFFFF;
 
  return Object::GetTypeCount(idx) << 16 | ClampTo<uint16_t>(GetClosestObject(tile, idx, current));
}

/* virtual */ uint32_t ObjectScopeResolver::GetVariable(uint8_t variable, [[maybe_unused]] uint32_t parameter, bool &available) const
{
  /* We get the town from the object, or we calculate the closest
   * town if we need to when there's no object. */
  const Town *t = nullptr;
 
  if (this->obj == nullptr) {
    switch (variable) {
      /* Allow these when there's no object. */
      case 0x41:
      case 0x60:
      case 0x61:
      case 0x62:
      case 0x64:
        break;
 
      /* Allow these, but find the closest town. */
      case 0x45:
      case 0x46:
        if (!IsValidTile(this->tile)) goto unhandled;
        t = ClosestTownFromTile(this->tile, UINT_MAX);
        break;
 
      /* Construction date */
      case 0x42: return TimerGameCalendar::date.base();
 
      /* Object founder information */
      case 0x44: return _current_company.base();
 
      /* Object view */
      case 0x48: return this->view;
 
      case 0x7A: return GetBadgeVariableResult(*this->ro.grffile, this->spec->badges, parameter);
 
      /*
       * Disallow the rest:
       * 0x40: Relative position is passed as parameter during construction.
       * 0x43: Animation counter is only for actual tiles.
       * 0x47: Object colour is only valid when its built.
       * 0x63: Animation counter of nearby tile, see above.
       */
      default:
        goto unhandled;
    }
 
    /* If there's an invalid tile, then we don't have enough information at all. */
    if (!IsValidTile(this->tile)) goto unhandled;
  } else {
    t = this->obj->town;
  }
 
  switch (variable) {
    /* Relative position. */
    case 0x40: {
      TileIndex offset = this->tile - this->obj->location.tile;
      uint offset_x = TileX(offset);
      uint offset_y = TileY(offset);
      return offset_y << 20 | offset_x << 16 | offset_y << 8 | offset_x;
    }
 
    /* Tile information. */
    case 0x41: return GetTileSlope(this->tile) << 8 | GetTerrainType(this->tile);
 
    /* Construction date */
    case 0x42: return this->obj->build_date.base();
 
    /* Animation counter */
    case 0x43: return GetAnimationFrame(this->tile);
 
    /* Object founder information */
    case 0x44: return GetTileOwner(this->tile).base();
 
    /* Get town zone and Manhattan distance of closest town */
    case 0x45: return to_underlying(GetTownRadiusGroup(t, this->tile)) << 16 | ClampTo<uint16_t>(DistanceManhattan(this->tile, t->xy));
 
    /* Get square of Euclidean distance of closest town */
    case 0x46: return DistanceSquare(this->tile, t->xy);
 
    /* Object colour */
    case 0x47: return this->obj->colour;
 
    /* Object view */
    case 0x48: return this->obj->view;
 
    /* Get object ID at offset param */
    case 0x60: return GetObjectIDAtOffset(GetNearbyTile(parameter, this->tile), this->ro.grffile->grfid);
 
    /* Get random tile bits at offset param */
    case 0x61: {
      TileIndex tile = GetNearbyTile(parameter, this->tile);
      return (IsTileType(tile, TileType::Object) && Object::GetByTile(tile) == this->obj) ? GetObjectRandomBits(tile) : 0;
    }
 
    /* Land info of nearby tiles */
    case 0x62: return GetNearbyObjectTileInformation(parameter, this->tile, this->obj == nullptr ? ObjectID::Invalid() : this->obj->index, this->ro.grffile->grf_version >= 8);
 
    /* Animation counter of nearby tile */
    case 0x63: {
      TileIndex tile = GetNearbyTile(parameter, this->tile);
      return (IsTileType(tile, TileType::Object) && Object::GetByTile(tile) == this->obj) ? GetAnimationFrame(tile) : 0;
    }
 
    /* Count of object, distance of closest instance */
    case 0x64: return GetCountAndDistanceOfClosestInstance(this->ro, parameter, this->ro.grffile->grfid, this->tile, this->obj);
 
    case 0x7A: return GetBadgeVariableResult(*this->ro.grffile, this->spec->badges, parameter);
  }
 
unhandled:
  Debug(grf, 1, "Unhandled object variable 0x{:X}", variable);
 
  available = false;
  return UINT_MAX;
}

ObjectResolverObject::ObjectResolverObject(const ObjectSpec *spec, Object *obj, TileIndex tile, uint8_t view,
    CallbackID callback, uint32_t param1, uint32_t param2)
  : ResolverObject(spec->grf_prop.grffile, callback, param1, param2), object_scope(*this, obj, spec, tile, view)
{
  this->root_spritegroup = spec->grf_prop.GetSpriteGroup(obj != nullptr);
}

TownScopeResolver *ObjectResolverObject::GetTown()
{
  if (!this->town_scope.has_value()) {
    Town *t;
    if (this->object_scope.obj != nullptr) {
      t = this->object_scope.obj->town;
    } else {
      t = ClosestTownFromTile(this->object_scope.tile, UINT_MAX);
    }
    if (t == nullptr) return nullptr;
    this->town_scope.emplace(*this, t, this->object_scope.obj == nullptr);
  }
  return &*this->town_scope;
}
 
GrfSpecFeature ObjectResolverObject::GetFeature() const
{
  return GSF_OBJECTS;
}
 
uint32_t ObjectResolverObject::GetDebugID() const
{
  return this->object_scope.spec->grf_prop.local_id;
}

uint16_t GetObjectCallback(CallbackID callback, uint32_t param1, uint32_t param2, const ObjectSpec *spec, Object *o, TileIndex tile, std::span<int32_t> regs100, uint8_t view)
{
  ObjectResolverObject object(spec, o, tile, view, callback, param1, param2);
  return object.ResolveCallback(regs100);
}

static void DrawTileLayout(const TileInfo *ti, const DrawTileSpriteSpan &dts, const ObjectSpec *spec)
{
  PaletteID palette = (spec->flags.Test(ObjectFlag::Uses2CC) ? SPR_2CCMAP_BASE : PALETTE_RECOLOUR_START) + Object::GetByTile(ti->tile)->colour;
 
  SpriteID image = dts.ground.sprite;
  PaletteID pal = dts.ground.pal;
 
  if (GB(image, 0, SPRITE_WIDTH) != 0) {
    /* If the ground sprite is the default flat water sprite, draw also canal/river borders
     * Do not do this if the tile's WaterClass is 'land'. */
    if ((image == SPR_FLAT_WATER_TILE || spec->flags.Test(ObjectFlag::DrawWater)) && IsTileOnWater(ti->tile)) {
      DrawWaterClassGround(ti);
    } else {
      DrawGroundSprite(image, GroundSpritePaletteTransform(image, pal, palette));
    }
  }
 
  DrawNewGRFTileSeq(ti, &dts, TO_STRUCTURES, 0, palette);
}

void DrawNewObjectTile(TileInfo *ti, const ObjectSpec *spec)
{
  Object *o = Object::GetByTile(ti->tile);
  ObjectResolverObject object(spec, o, ti->tile);
 
  const auto *group = object.Resolve<TileLayoutSpriteGroup>();
  if (group == nullptr) return;
 
  auto processor = group->ProcessRegisters(object, nullptr);
  auto dts = processor.GetLayout();
  DrawTileLayout(ti, dts, spec);
}

void DrawNewObjectTileInGUI(int x, int y, const ObjectSpec *spec, uint8_t view)
{
  ObjectResolverObject object(spec, nullptr, INVALID_TILE, view);
  const auto *group = object.Resolve<TileLayoutSpriteGroup>();
  if (group == nullptr) return;
 
  auto processor = group->ProcessRegisters(object, nullptr);
  auto dts = processor.GetLayout();
 
  PaletteID palette;
  if (Company::IsValidID(_local_company)) {
    /* Get the colours of our company! */
    if (spec->flags.Test(ObjectFlag::Uses2CC)) {
      const Livery &l = Company::Get(_local_company)->livery[0];
      palette = SPR_2CCMAP_BASE + l.colour1 + l.colour2 * 16;
    } else {
      palette = GetCompanyPalette(_local_company);
    }
  } else {
    /* There's no company, so just take the base palette. */
    palette = spec->flags.Test(ObjectFlag::Uses2CC) ? SPR_2CCMAP_BASE : PALETTE_RECOLOUR_START;
  }
 
  SpriteID image = dts.ground.sprite;
  PaletteID pal = dts.ground.pal;
 
  if (GB(image, 0, SPRITE_WIDTH) != 0) {
    DrawSprite(image, GroundSpritePaletteTransform(image, pal, palette), x, y);
  }
 
  DrawNewGRFTileSeqInGUI(x, y, &dts, 0, palette);
}

uint16_t StubGetObjectCallback(CallbackID callback, uint32_t param1, uint32_t param2, const ObjectSpec *spec, Object *o, TileIndex tile, int)
{
  return GetObjectCallback(callback, param1, param2, spec, o, tile);
}

struct ObjectAnimationBase : public AnimationBase<ObjectAnimationBase, ObjectSpec, Object, int, StubGetObjectCallback, TileAnimationFrameAnimationHelper<Object> > {
  static const CallbackID cb_animation_speed      = CBID_OBJECT_ANIMATION_SPEED;
  static const CallbackID cb_animation_next_frame = CBID_OBJECT_ANIMATION_NEXT_FRAME;
 
  static const ObjectCallbackMask cbm_animation_speed      = ObjectCallbackMask::AnimationSpeed;
  static const ObjectCallbackMask cbm_animation_next_frame = ObjectCallbackMask::AnimationNextFrame;
};

void AnimateNewObjectTile(TileIndex tile)
{
  const ObjectSpec *spec = ObjectSpec::GetByTile(tile);
  if (spec == nullptr || !spec->flags.Test(ObjectFlag::Animation)) return;
 
  ObjectAnimationBase::AnimateTile(spec, Object::GetByTile(tile), tile, spec->flags.Test(ObjectFlag::AnimRandomBits));
}
 
static bool DoTriggerObjectTileAnimation(Object *o, TileIndex tile, ObjectAnimationTrigger trigger, const ObjectSpec *spec, uint32_t random, uint32_t var18_extra = 0)
{
  if (!spec->animation.triggers.Test(trigger)) return false;
 
  ObjectAnimationBase::ChangeAnimationFrame(CBID_OBJECT_ANIMATION_TRIGGER, spec, o, tile, random, to_underlying(trigger) | var18_extra);
  return true;
}

bool TriggerObjectTileAnimation(Object *o, TileIndex tile, ObjectAnimationTrigger trigger, const ObjectSpec *spec)
{
  return DoTriggerObjectTileAnimation(o, tile, trigger, spec, Random());
}

bool TriggerObjectAnimation(Object *o, ObjectAnimationTrigger trigger, const ObjectSpec *spec)
{
  if (!spec->animation.triggers.Test(trigger)) return false;
 
  bool ret = true;
  uint32_t random = Random();
  for (TileIndex tile : o->location) {
    if (DoTriggerObjectTileAnimation(o, tile, trigger, spec, random)) {
      SB(random, 0, 16, Random());
    } else {
      ret = false;
    }
  }
 
  return ret;
}