newgrf_industrytiles.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 "debug.h"
#include "landscape.h"
#include "newgrf_badge.h"
#include "newgrf_industrytiles.h"
#include "newgrf_sound.h"
#include "industry.h"
#include "town.h"
#include "command_func.h"
#include "water.h"
#include "newgrf_animation_base.h"
 
#include "table/strings.h"
 
#include "safeguards.h"
 
uint32_t GetNearbyIndustryTileInformation(uint8_t parameter, TileIndex tile, IndustryID index, bool signed_offsets, bool grf_version8)
{
  if (parameter != 0) tile = GetNearbyTile(parameter, tile, signed_offsets); // only perform if it is required
  bool is_same_industry = (IsTileType(tile, MP_INDUSTRY) && GetIndustryIndex(tile) == index);
 
  return GetNearbyTileInformation(tile, grf_version8) | (is_same_industry ? 1 : 0) << 8;
}
 
uint32_t GetRelativePosition(TileIndex tile, TileIndex ind_tile)
{
  uint8_t x = TileX(tile) - TileX(ind_tile);
  uint8_t y = TileY(tile) - TileY(ind_tile);
 
  return ((y & 0xF) << 20) | ((x & 0xF) << 16) | (y << 8) | x;
}
 
/* virtual */ uint32_t IndustryTileScopeResolver::GetVariable(uint8_t variable, [[maybe_unused]] uint32_t parameter, bool &available) const
{
  switch (variable) {
    /* Construction state of the tile: a value between 0 and 3 */
    case 0x40: return (IsTileType(this->tile, MP_INDUSTRY)) ? GetIndustryConstructionStage(this->tile) : 0;
 
    /* Terrain type */
    case 0x41: return GetTerrainType(this->tile);
 
    /* Current town zone of the tile in the nearest town */
    case 0x42: return GetTownRadiusGroup(ClosestTownFromTile(this->tile, UINT_MAX), this->tile);
 
    /* Relative position */
    case 0x43: return GetRelativePosition(this->tile, this->industry->location.tile);
 
    /* Animation frame. Like house variable 46 but can contain anything 0..FF. */
    case 0x44: return IsTileType(this->tile, MP_INDUSTRY) ? GetAnimationFrame(this->tile) : 0;
 
    /* Land info of nearby tiles */
    case 0x60: return GetNearbyIndustryTileInformation(parameter, this->tile,
        this->industry == nullptr ? (IndustryID)IndustryID::Invalid() : this->industry->index, true, this->ro.grffile->grf_version >= 8);
 
    /* Animation stage of nearby tiles */
    case 0x61: {
      TileIndex tile = GetNearbyTile(parameter, this->tile);
      if (IsTileType(tile, MP_INDUSTRY) && Industry::GetByTile(tile) == this->industry) {
        return GetAnimationFrame(tile);
      }
      return UINT_MAX;
    }
 
    /* Get industry tile ID at offset */
    case 0x62: return GetIndustryIDAtOffset(GetNearbyTile(parameter, this->tile), this->industry, this->ro.grffile->grfid);
 
    case 0x7A: return GetBadgeVariableResult(*this->ro.grffile, GetIndustryTileSpec(GetIndustryGfx(this->tile))->badges, parameter);
  }
 
  Debug(grf, 1, "Unhandled industry tile variable 0x{:X}", variable);
 
  available = false;
  return UINT_MAX;
}
 
/* virtual */ uint32_t IndustryTileScopeResolver::GetRandomBits() const
{
  assert(this->industry != nullptr && IsValidTile(this->tile));
  assert(this->industry->index == IndustryID::Invalid() || IsTileType(this->tile, MP_INDUSTRY));
 
  return (this->industry->index != IndustryID::Invalid()) ? GetIndustryRandomBits(this->tile) : 0;
}
 
/* virtual */ uint32_t IndustryTileScopeResolver::GetTriggers() const
{
  assert(this->industry != nullptr && IsValidTile(this->tile));
  assert(this->industry->index == IndustryID::Invalid() || IsTileType(this->tile, MP_INDUSTRY));
  if (this->industry->index == IndustryID::Invalid()) return 0;
  return GetIndustryTriggers(this->tile);
}
 
static const GRFFile *GetIndTileGrffile(IndustryGfx gfx)
{
  const IndustryTileSpec *its = GetIndustryTileSpec(gfx);
  return (its != nullptr) ? its->grf_prop.grffile : nullptr;
}
 
IndustryTileResolverObject::IndustryTileResolverObject(IndustryGfx gfx, TileIndex tile, Industry *indus,
      CallbackID callback, uint32_t callback_param1, uint32_t callback_param2)
  : ResolverObject(GetIndTileGrffile(gfx), callback, callback_param1, callback_param2),
  indtile_scope(*this, indus, tile),
  ind_scope(*this, tile, indus, indus->type),
  gfx(gfx)
{
  this->root_spritegroup = GetIndustryTileSpec(gfx)->grf_prop.GetSpriteGroup();
}
 
GrfSpecFeature IndustryTileResolverObject::GetFeature() const
{
  return GSF_INDUSTRYTILES;
}
 
uint32_t IndustryTileResolverObject::GetDebugID() const
{
  return GetIndustryTileSpec(gfx)->grf_prop.local_id;
}
 
static void IndustryDrawTileLayout(const TileInfo *ti, const TileLayoutSpriteGroup *group, uint8_t rnd_colour, uint8_t stage)
{
  const DrawTileSprites *dts = group->ProcessRegisters(&stage);
 
  SpriteID image = dts->ground.sprite;
  PaletteID pal  = dts->ground.pal;
 
  if (HasBit(image, SPRITE_MODIFIER_CUSTOM_SPRITE)) image += stage;
  if (HasBit(pal, SPRITE_MODIFIER_CUSTOM_SPRITE)) pal += stage;
 
  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 && IsTileOnWater(ti->tile)) {
      DrawWaterClassGround(ti);
    } else {
      DrawGroundSprite(image, GroundSpritePaletteTransform(image, pal, GENERAL_SPRITE_COLOUR(rnd_colour)));
    }
  }
 
  DrawNewGRFTileSeq(ti, dts, TO_INDUSTRIES, stage, GENERAL_SPRITE_COLOUR(rnd_colour));
}
 
uint16_t GetIndustryTileCallback(CallbackID callback, uint32_t param1, uint32_t param2, IndustryGfx gfx_id, Industry *industry, TileIndex tile)
{
  assert(industry != nullptr && IsValidTile(tile));
  assert(industry->index == IndustryID::Invalid() || IsTileType(tile, MP_INDUSTRY));
 
  IndustryTileResolverObject object(gfx_id, tile, industry, callback, param1, param2);
  return object.ResolveCallback();
}
 
bool DrawNewIndustryTile(TileInfo *ti, Industry *i, IndustryGfx gfx, const IndustryTileSpec *inds)
{
  if (ti->tileh != SLOPE_FLAT) {
    bool draw_old_one = true;
    if (inds->callback_mask.Test(IndustryTileCallbackMask::DrawFoundations)) {
      /* Called to determine the type (if any) of foundation to draw for industry tile */
      uint32_t callback_res = GetIndustryTileCallback(CBID_INDTILE_DRAW_FOUNDATIONS, 0, 0, gfx, i, ti->tile);
      if (callback_res != CALLBACK_FAILED) draw_old_one = ConvertBooleanCallback(inds->grf_prop.grffile, CBID_INDTILE_DRAW_FOUNDATIONS, callback_res);
    }
 
    if (draw_old_one) DrawFoundation(ti, FOUNDATION_LEVELED);
  }
 
  IndustryTileResolverObject object(gfx, ti->tile, i);
 
  const SpriteGroup *group = object.Resolve();
  if (group == nullptr || group->type != SGT_TILELAYOUT) return false;
 
  /* Limit the building stage to the number of stages supplied. */
  const TileLayoutSpriteGroup *tlgroup = (const TileLayoutSpriteGroup *)group;
  uint8_t stage = GetIndustryConstructionStage(ti->tile);
  IndustryDrawTileLayout(ti, tlgroup, i->random_colour, stage);
  return true;
}
 
extern bool IsSlopeRefused(Slope current, Slope refused);
 
CommandCost PerformIndustryTileSlopeCheck(TileIndex ind_base_tile, TileIndex ind_tile, const IndustryTileSpec *its, IndustryType type, IndustryGfx gfx, size_t layout_index, uint16_t initial_random_bits, Owner founder, IndustryAvailabilityCallType creation_type)
{
  Industry ind;
  ind.index = IndustryID::Invalid();
  ind.location.tile = ind_base_tile;
  ind.location.w = 0;
  ind.type = type;
  ind.random = initial_random_bits;
  ind.founder = founder;
 
  uint16_t callback_res = GetIndustryTileCallback(CBID_INDTILE_SHAPE_CHECK, 0, creation_type << 8 | (uint32_t)layout_index, gfx, &ind, ind_tile);
  if (callback_res == CALLBACK_FAILED) {
    if (!IsSlopeRefused(GetTileSlope(ind_tile), its->slopes_refused)) return CommandCost();
    return CommandCost(STR_ERROR_SITE_UNSUITABLE);
  }
  if (its->grf_prop.grffile->grf_version < 7) {
    if (callback_res != 0) return CommandCost();
    return CommandCost(STR_ERROR_SITE_UNSUITABLE);
  }
 
  return GetErrorMessageFromLocationCallbackResult(callback_res, its->grf_prop.grffile, STR_ERROR_SITE_UNSUITABLE);
}
 
/* Simple wrapper for GetHouseCallback to keep the animation unified. */
uint16_t GetSimpleIndustryCallback(CallbackID callback, uint32_t param1, uint32_t param2, const IndustryTileSpec *spec, Industry *ind, TileIndex tile, int)
{
  return GetIndustryTileCallback(callback, param1, param2, spec - GetIndustryTileSpec(0), ind, tile);
}
 
struct IndustryAnimationBase : public AnimationBase<IndustryAnimationBase, IndustryTileSpec, Industry, int, GetSimpleIndustryCallback, TileAnimationFrameAnimationHelper<Industry> > {
  static constexpr CallbackID cb_animation_speed      = CBID_INDTILE_ANIMATION_SPEED;
  static constexpr CallbackID cb_animation_next_frame = CBID_INDTILE_ANIM_NEXT_FRAME;
 
  static constexpr IndustryTileCallbackMask cbm_animation_speed      = IndustryTileCallbackMask::AnimationSpeed;
  static constexpr IndustryTileCallbackMask cbm_animation_next_frame = IndustryTileCallbackMask::AnimationNextFrame;
};
 
void AnimateNewIndustryTile(TileIndex tile)
{
  const IndustryTileSpec *itspec = GetIndustryTileSpec(GetIndustryGfx(tile));
  if (itspec == nullptr) return;
 
  IndustryAnimationBase::AnimateTile(itspec, Industry::GetByTile(tile), tile, itspec->special_flags.Test(IndustryTileSpecialFlag::NextFrameRandomBits));
}
 
bool StartStopIndustryTileAnimation(TileIndex tile, IndustryAnimationTrigger iat, uint32_t random)
{
  const IndustryTileSpec *itspec = GetIndustryTileSpec(GetIndustryGfx(tile));
 
  if (!HasBit(itspec->animation.triggers, iat)) return false;
 
  IndustryAnimationBase::ChangeAnimationFrame(CBID_INDTILE_ANIM_START_STOP, itspec, Industry::GetByTile(tile), tile, random, iat);
  return true;
}
 
bool StartStopIndustryTileAnimation(const Industry *ind, IndustryAnimationTrigger iat)
{
  bool ret = true;
  uint32_t random = Random();
  for (TileIndex tile : ind->location) {
    if (ind->TileBelongsToIndustry(tile)) {
      if (StartStopIndustryTileAnimation(tile, iat, random)) {
        SB(random, 0, 16, Random());
      } else {
        ret = false;
      }
    }
  }
 
  return ret;
}
 
static void DoTriggerIndustryTile(TileIndex tile, IndustryTileTrigger trigger, Industry *ind, uint32_t &reseed_industry)
{
  assert(IsValidTile(tile) && IsTileType(tile, MP_INDUSTRY));
 
  IndustryGfx gfx = GetIndustryGfx(tile);
  const IndustryTileSpec *itspec = GetIndustryTileSpec(gfx);
 
  if (itspec->grf_prop.GetSpriteGroup() == nullptr) return;
 
  IndustryTileResolverObject object(gfx, tile, ind, CBID_RANDOM_TRIGGER);
  object.waiting_triggers = GetIndustryTriggers(tile) | trigger;
  SetIndustryTriggers(tile, object.waiting_triggers); // store now for var 5F
 
  const SpriteGroup *group = object.Resolve();
  if (group == nullptr) return;
 
  /* Store remaining triggers. */
  SetIndustryTriggers(tile, object.GetRemainingTriggers());
 
  /* Rerandomise tile bits */
  uint8_t new_random_bits = Random();
  uint8_t random_bits = GetIndustryRandomBits(tile);
  random_bits &= ~object.reseed[VSG_SCOPE_SELF];
  random_bits |= new_random_bits & object.reseed[VSG_SCOPE_SELF];
  SetIndustryRandomBits(tile, random_bits);
  MarkTileDirtyByTile(tile);
 
  reseed_industry |= object.reseed[VSG_SCOPE_PARENT];
}
 
static void DoReseedIndustry(Industry *ind, uint32_t reseed)
{
  if (reseed == 0 || ind == nullptr) return;
 
  uint16_t random_bits = Random();
  ind->random &= reseed;
  ind->random |= random_bits & reseed;
}
 
void TriggerIndustryTile(TileIndex tile, IndustryTileTrigger trigger)
{
  uint32_t reseed_industry = 0;
  Industry *ind = Industry::GetByTile(tile);
  DoTriggerIndustryTile(tile, trigger, ind, reseed_industry);
  DoReseedIndustry(ind, reseed_industry);
}
 
void TriggerIndustry(Industry *ind, IndustryTileTrigger trigger)
{
  uint32_t reseed_industry = 0;
  for (TileIndex tile : ind->location) {
    if (ind->TileBelongsToIndustry(tile)) {
      DoTriggerIndustryTile(tile, trigger, ind, reseed_industry);
    }
  }
  DoReseedIndustry(ind, reseed_industry);
}