newgrf_commons.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 "house.h"
#include "industrytype.h"
#include "newgrf_config.h"
#include "clear_map.h"
#include "station_map.h"
#include "tree_map.h"
#include "tunnelbridge_map.h"
#include "newgrf_object.h"
#include "genworld.h"
#include "newgrf_spritegroup.h"
#include "newgrf_text.h"
#include "company_base.h"
#include "error.h"
#include "strings_func.h"
#include "string_func.h"
 
#include "table/strings.h"
 
#include "safeguards.h"
 
OverrideManagerBase::OverrideManagerBase(uint16_t offset, uint16_t maximum, uint16_t invalid)
{
  this->max_offset = offset;
  this->max_entities = maximum;
  this->invalid_id = invalid;
 
  this->mappings.resize(this->max_entities);
  this->entity_overrides.resize(this->max_offset);
  std::fill(this->entity_overrides.begin(), this->entity_overrides.end(), this->invalid_id);
  this->grfid_overrides.resize(this->max_offset);
}
 
void OverrideManagerBase::Add(uint16_t local_id, uint32_t grfid, uint entity_type)
{
  assert(entity_type < this->max_offset);
  /* An override can be set only once */
  if (this->entity_overrides[entity_type] != this->invalid_id) return;
  this->entity_overrides[entity_type] = local_id;
  this->grfid_overrides[entity_type] = grfid;
}
 
void OverrideManagerBase::ResetMapping()
{
  std::fill(this->mappings.begin(), this->mappings.end(), EntityIDMapping{});
}
 
void OverrideManagerBase::ResetOverride()
{
  std::fill(this->entity_overrides.begin(), this->entity_overrides.end(), this->invalid_id);
  std::fill(this->grfid_overrides.begin(), this->grfid_overrides.end(), uint32_t());
}
 
uint16_t OverrideManagerBase::GetID(uint16_t grf_local_id, uint32_t grfid) const
{
  for (uint16_t id = 0; id < this->max_entities; id++) {
    const EntityIDMapping *map = &this->mappings[id];
    if (map->entity_id == grf_local_id && map->grfid == grfid) {
      return id;
    }
  }
 
  return this->invalid_id;
}
 
uint16_t OverrideManagerBase::AddEntityID(uint16_t grf_local_id, uint32_t grfid, uint16_t substitute_id)
{
  uint16_t id = this->GetID(grf_local_id, grfid);
 
  /* Look to see if this entity has already been added. This is done
   * separately from the loop below in case a GRF has been deleted, and there
   * are any gaps in the array.
   */
  if (id != this->invalid_id) return id;
 
  /* This entity hasn't been defined before, so give it an ID now. */
  for (id = this->max_offset; id < this->max_entities; id++) {
    EntityIDMapping *map = &this->mappings[id];
 
    if (CheckValidNewID(id) && map->entity_id == 0 && map->grfid == 0) {
      map->entity_id     = grf_local_id;
      map->grfid         = grfid;
      map->substitute_id = substitute_id;
      return id;
    }
  }
 
  return this->invalid_id;
}
 
uint32_t OverrideManagerBase::GetGRFID(uint16_t entity_id) const
{
  return this->mappings[entity_id].grfid;
}
 
uint16_t OverrideManagerBase::GetSubstituteID(uint16_t entity_id) const
{
  return this->mappings[entity_id].substitute_id;
}
 
void HouseOverrideManager::SetEntitySpec(const HouseSpec *hs)
{
  HouseID house_id = this->AddEntityID(hs->grf_prop.local_id, hs->grf_prop.grffile->grfid, hs->grf_prop.subst_id);
 
  if (house_id == this->invalid_id) {
    GrfMsg(1, "House.SetEntitySpec: Too many houses allocated. Ignoring.");
    return;
  }
 
  *HouseSpec::Get(house_id) = *hs;
 
  /* Now add the overrides. */
  for (int i = 0; i < this->max_offset; i++) {
    HouseSpec *overridden_hs = HouseSpec::Get(i);
 
    if (this->entity_overrides[i] != hs->grf_prop.local_id || this->grfid_overrides[i] != hs->grf_prop.grffile->grfid) continue;
 
    overridden_hs->grf_prop.override = house_id;
    this->entity_overrides[i] = this->invalid_id;
    this->grfid_overrides[i] = 0;
  }
}
 
uint16_t IndustryOverrideManager::GetID(uint16_t grf_local_id, uint32_t grfid) const
{
  uint16_t id = OverrideManagerBase::GetID(grf_local_id, grfid);
  if (id != this->invalid_id) return id;
 
  /* No mapping found, try the overrides */
  for (id = 0; id < this->max_offset; id++) {
    if (this->entity_overrides[id] == grf_local_id && this->grfid_overrides[id] == grfid) return id;
  }
 
  return this->invalid_id;
}
 
uint16_t IndustryOverrideManager::AddEntityID(uint16_t grf_local_id, uint32_t grfid, uint16_t substitute_id)
{
  /* This entity hasn't been defined before, so give it an ID now. */
  for (uint16_t id = 0; id < this->max_entities; id++) {
    /* Skip overridden industries */
    if (id < this->max_offset && this->entity_overrides[id] != this->invalid_id) continue;
 
    /* Get the real live industry */
    const IndustrySpec *inds = GetIndustrySpec(id);
 
    /* This industry must be one that is not available(enabled), mostly because of climate.
     * And it must not already be used by a grf (grffile == nullptr).
     * So reserve this slot here, as it is the chosen one */
    if (!inds->enabled && inds->grf_prop.grffile == nullptr) {
      EntityIDMapping *map = &this->mappings[id];
 
      if (map->entity_id == 0 && map->grfid == 0) {
        /* winning slot, mark it as been used */
        map->entity_id     = grf_local_id;
        map->grfid         = grfid;
        map->substitute_id = substitute_id;
        return id;
      }
    }
  }
 
  return this->invalid_id;
}
 
void IndustryOverrideManager::SetEntitySpec(IndustrySpec *inds)
{
  /* First step : We need to find if this industry is already specified in the savegame data. */
  IndustryType ind_id = this->GetID(inds->grf_prop.local_id, inds->grf_prop.grffile->grfid);
 
  if (ind_id == this->invalid_id) {
    /* Not found.
     * Or it has already been overridden, so you've lost your place.
     * Or it is a simple substitute.
     * We need to find a free available slot */
    ind_id = this->AddEntityID(inds->grf_prop.local_id, inds->grf_prop.grffile->grfid, inds->grf_prop.subst_id);
    inds->grf_prop.override = this->invalid_id;  // make sure it will not be detected as overridden
  }
 
  if (ind_id == this->invalid_id) {
    GrfMsg(1, "Industry.SetEntitySpec: Too many industries allocated. Ignoring.");
    return;
  }
 
  /* Now that we know we can use the given id, copy the spec to its final destination... */
  _industry_specs[ind_id] = *inds;
  /* ... and mark it as usable*/
  _industry_specs[ind_id].enabled = true;
}
 
void IndustryTileOverrideManager::SetEntitySpec(const IndustryTileSpec *its)
{
  IndustryGfx indt_id = this->AddEntityID(its->grf_prop.local_id, its->grf_prop.grffile->grfid, its->grf_prop.subst_id);
 
  if (indt_id == this->invalid_id) {
    GrfMsg(1, "IndustryTile.SetEntitySpec: Too many industry tiles allocated. Ignoring.");
    return;
  }
 
  _industry_tile_specs[indt_id] = *its;
 
  /* Now add the overrides. */
  for (int i = 0; i < this->max_offset; i++) {
    IndustryTileSpec *overridden_its = &_industry_tile_specs[i];
 
    if (this->entity_overrides[i] != its->grf_prop.local_id || this->grfid_overrides[i] != its->grf_prop.grffile->grfid) continue;
 
    overridden_its->grf_prop.override = indt_id;
    overridden_its->enabled = false;
    this->entity_overrides[i] = this->invalid_id;
    this->grfid_overrides[i] = 0;
  }
}
 
void ObjectOverrideManager::SetEntitySpec(ObjectSpec *spec)
{
  /* First step : We need to find if this object is already specified in the savegame data. */
  ObjectType type = this->GetID(spec->grf_prop.local_id, spec->grf_prop.grffile->grfid);
 
  if (type == this->invalid_id) {
    /* Not found.
     * Or it has already been overridden, so you've lost your place.
     * Or it is a simple substitute.
     * We need to find a free available slot */
    type = this->AddEntityID(spec->grf_prop.local_id, spec->grf_prop.grffile->grfid, OBJECT_TRANSMITTER);
  }
 
  if (type == this->invalid_id) {
    GrfMsg(1, "Object.SetEntitySpec: Too many objects allocated. Ignoring.");
    return;
  }
 
  extern std::vector<ObjectSpec> _object_specs;
 
  /* Now that we know we can use the given id, copy the spec to its final destination. */
  if (type >= _object_specs.size()) _object_specs.resize(type + 1);
  _object_specs[type] = *spec;
}
 
uint32_t GetTerrainType(TileIndex tile, TileContext context)
{
  switch (_settings_game.game_creation.landscape) {
    case LT_TROPIC: return GetTropicZone(tile);
    case LT_ARCTIC: {
      bool has_snow;
      switch (GetTileType(tile)) {
        case MP_CLEAR:
          /* During map generation the snowstate may not be valid yet, as the tileloop may not have run yet. */
          if (_generating_world) goto genworld;
          has_snow = IsSnowTile(tile) && GetClearDensity(tile) >= 2;
          break;
 
        case MP_RAILWAY: {
          /* During map generation the snowstate may not be valid yet, as the tileloop may not have run yet. */
          if (_generating_world) goto genworld; // we do not care about foundations here
          RailGroundType ground = GetRailGroundType(tile);
          has_snow = (ground == RAIL_GROUND_ICE_DESERT || (context == TCX_UPPER_HALFTILE && ground == RAIL_GROUND_HALF_SNOW));
          break;
        }
 
        case MP_ROAD:
          /* During map generation the snowstate may not be valid yet, as the tileloop may not have run yet. */
          if (_generating_world) goto genworld; // we do not care about foundations here
          has_snow = IsOnSnow(tile);
          break;
 
        case MP_TREES: {
          /* During map generation the snowstate may not be valid yet, as the tileloop may not have run yet. */
          if (_generating_world) goto genworld;
          TreeGround ground = GetTreeGround(tile);
          has_snow = (ground == TREE_GROUND_SNOW_DESERT || ground == TREE_GROUND_ROUGH_SNOW) && GetTreeDensity(tile) >= 2;
          break;
        }
 
        case MP_TUNNELBRIDGE:
          if (context == TCX_ON_BRIDGE) {
            has_snow = (GetBridgeHeight(tile) > GetSnowLine());
          } else {
            /* During map generation the snowstate may not be valid yet, as the tileloop may not have run yet. */
            if (_generating_world) goto genworld; // we do not care about foundations here
            has_snow = HasTunnelBridgeSnowOrDesert(tile);
          }
          break;
 
        case MP_STATION:
        case MP_HOUSE:
        case MP_INDUSTRY:
        case MP_OBJECT:
          /* These tiles usually have a levelling foundation. So use max Z */
          has_snow = (GetTileMaxZ(tile) > GetSnowLine());
          break;
 
        case MP_VOID:
        case MP_WATER:
        genworld:
          has_snow = (GetTileZ(tile) > GetSnowLine());
          break;
 
        default: NOT_REACHED();
      }
      return has_snow ? 4 : 0;
    }
    default:        return 0;
  }
}
 
TileIndex GetNearbyTile(byte parameter, TileIndex tile, bool signed_offsets, Axis axis)
{
  int8_t x = GB(parameter, 0, 4);
  int8_t y = GB(parameter, 4, 4);
 
  if (signed_offsets && x >= 8) x -= 16;
  if (signed_offsets && y >= 8) y -= 16;
 
  /* Swap width and height depending on axis for railway stations */
  if (axis == INVALID_AXIS && HasStationTileRail(tile)) axis = GetRailStationAxis(tile);
  if (axis == AXIS_Y) Swap(x, y);
 
  /* Make sure we never roam outside of the map, better wrap in that case */
  return Map::WrapToMap(tile + TileDiffXY(x, y));
}
 
uint32_t GetNearbyTileInformation(TileIndex tile, bool grf_version8)
{
  TileType tile_type = GetTileType(tile);
 
  /* Fake tile type for trees on shore */
  if (IsTileType(tile, MP_TREES) && GetTreeGround(tile) == TREE_GROUND_SHORE) tile_type = MP_WATER;
 
  int z;
  Slope tileh = GetTilePixelSlope(tile, &z);
  /* Return 0 if the tile is a land tile */
  byte terrain_type = (HasTileWaterClass(tile) ? (GetWaterClass(tile) + 1) & 3 : 0) << 5 | GetTerrainType(tile) << 2 | (tile_type == MP_WATER ? 1 : 0) << 1;
  if (grf_version8) z /= TILE_HEIGHT;
  return tile_type << 24 | ClampTo<uint8_t>(z) << 16 | terrain_type << 8 | tileh;
}
 
uint32_t GetCompanyInfo(CompanyID owner, const Livery *l)
{
  if (l == nullptr && Company::IsValidID(owner)) l = &Company::Get(owner)->livery[LS_DEFAULT];
  return owner | (Company::IsValidAiID(owner) ? 0x10000 : 0) | (l != nullptr ? (l->colour1 << 24) | (l->colour2 << 28) : 0);
}
 
CommandCost GetErrorMessageFromLocationCallbackResult(uint16_t cb_res, const GRFFile *grffile, StringID default_error)
{
  CommandCost res;
 
  if (cb_res < 0x400) {
    res = CommandCost(GetGRFStringID(grffile->grfid, 0xD000 + cb_res));
  } else {
    switch (cb_res) {
      case 0x400: return res; // No error.
 
      default:    // unknown reason -> default error
      case 0x401: res = CommandCost(default_error); break;
 
      case 0x402: res = CommandCost(STR_ERROR_CAN_ONLY_BE_BUILT_IN_RAINFOREST); break;
      case 0x403: res = CommandCost(STR_ERROR_CAN_ONLY_BE_BUILT_IN_DESERT); break;
      case 0x404: res = CommandCost(STR_ERROR_CAN_ONLY_BE_BUILT_ABOVE_SNOW_LINE); break;
      case 0x405: res = CommandCost(STR_ERROR_CAN_ONLY_BE_BUILT_BELOW_SNOW_LINE); break;
      case 0x406: res = CommandCost(STR_ERROR_CAN_T_BUILD_ON_SEA); break;
      case 0x407: res = CommandCost(STR_ERROR_CAN_T_BUILD_ON_CANAL); break;
      case 0x408: res = CommandCost(STR_ERROR_CAN_T_BUILD_ON_RIVER); break;
    }
  }
 
  /* Copy some parameters from the registers to the error message text ref. stack */
  res.UseTextRefStack(grffile, 4);
 
  return res;
}
 
void ErrorUnknownCallbackResult(uint32_t grfid, uint16_t cbid, uint16_t cb_res)
{
  GRFConfig *grfconfig = GetGRFConfig(grfid);
 
  if (!HasBit(grfconfig->grf_bugs, GBUG_UNKNOWN_CB_RESULT)) {
    SetBit(grfconfig->grf_bugs, GBUG_UNKNOWN_CB_RESULT);
    SetDParamStr(0, grfconfig->GetName());
    SetDParam(1, cbid);
    SetDParam(2, cb_res);
    ShowErrorMessage(STR_NEWGRF_BUGGY, STR_NEWGRF_BUGGY_UNKNOWN_CALLBACK_RESULT, WL_CRITICAL);
  }
 
  /* debug output */
  SetDParamStr(0, grfconfig->GetName());
  Debug(grf, 0, "{}", StrMakeValid(GetString(STR_NEWGRF_BUGGY)));
 
  SetDParam(1, cbid);
  SetDParam(2, cb_res);
  Debug(grf, 0, "{}", StrMakeValid(GetString(STR_NEWGRF_BUGGY_UNKNOWN_CALLBACK_RESULT)));
}
 
bool ConvertBooleanCallback(const GRFFile *grffile, uint16_t cbid, uint16_t cb_res)
{
  assert(cb_res != CALLBACK_FAILED); // We do not know what to return
 
  if (grffile->grf_version < 8) return cb_res != 0;
 
  if (cb_res > 1) ErrorUnknownCallbackResult(grffile->grfid, cbid, cb_res);
  return cb_res != 0;
}
 
bool Convert8bitBooleanCallback(const GRFFile *grffile, uint16_t cbid, uint16_t cb_res)
{
  assert(cb_res != CALLBACK_FAILED); // We do not know what to return
 
  if (grffile->grf_version < 8) return GB(cb_res, 0, 8) != 0;
 
  if (cb_res > 1) ErrorUnknownCallbackResult(grffile->grfid, cbid, cb_res);
  return cb_res != 0;
}
 
 
/* static */ std::vector<DrawTileSeqStruct> NewGRFSpriteLayout::result_seq;
 
void NewGRFSpriteLayout::Clone(const DrawTileSeqStruct *source)
{
  assert(this->seq == nullptr);
  assert(source != nullptr);
 
  size_t count = 1; // 1 for the terminator
  const DrawTileSeqStruct *element;
  foreach_draw_tile_seq(element, source) count++;
 
  DrawTileSeqStruct *sprites = MallocT<DrawTileSeqStruct>(count);
  MemCpyT(sprites, source, count);
  this->seq = sprites;
}
 
void NewGRFSpriteLayout::Clone(const NewGRFSpriteLayout *source)
{
  this->Clone((const DrawTileSprites*)source);
 
  if (source->registers != nullptr) {
    size_t count = 1; // 1 for the ground sprite
    const DrawTileSeqStruct *element;
    foreach_draw_tile_seq(element, source->seq) count++;
 
    TileLayoutRegisters *regs = MallocT<TileLayoutRegisters>(count);
    MemCpyT(regs, source->registers, count);
    this->registers = regs;
  }
}
 
 
void NewGRFSpriteLayout::Allocate(uint num_sprites)
{
  assert(this->seq == nullptr);
 
  DrawTileSeqStruct *sprites = CallocT<DrawTileSeqStruct>(num_sprites + 1);
  sprites[num_sprites].MakeTerminator();
  this->seq = sprites;
}
 
void NewGRFSpriteLayout::AllocateRegisters()
{
  assert(this->seq != nullptr);
  assert(this->registers == nullptr);
 
  size_t count = 1; // 1 for the ground sprite
  const DrawTileSeqStruct *element;
  foreach_draw_tile_seq(element, this->seq) count++;
 
  this->registers = CallocT<TileLayoutRegisters>(count);
}
 
uint32_t NewGRFSpriteLayout::PrepareLayout(uint32_t orig_offset, uint32_t newgrf_ground_offset, uint32_t newgrf_offset, uint constr_stage, bool separate_ground) const
{
  result_seq.clear();
  uint32_t var10_values = 0;
 
  /* Create a copy of the spritelayout, so we can modify some values.
   * Also include the groundsprite into the sequence for easier processing. */
  DrawTileSeqStruct *result = &result_seq.emplace_back();
  result->image = ground;
  result->delta_x = 0;
  result->delta_y = 0;
  result->delta_z = (int8_t)0x80;
 
  const DrawTileSeqStruct *dtss;
  foreach_draw_tile_seq(dtss, this->seq) {
    result_seq.push_back(*dtss);
  }
  result_seq.emplace_back().MakeTerminator();
  /* Determine the var10 values the action-1-2-3 chains needs to be resolved for,
   * and apply the default sprite offsets (unless disabled). */
  const TileLayoutRegisters *regs = this->registers;
  bool ground = true;
  foreach_draw_tile_seq(result, result_seq.data()) {
    TileLayoutFlags flags = TLF_NOTHING;
    if (regs != nullptr) flags = regs->flags;
 
    /* Record var10 value for the sprite */
    if (HasBit(result->image.sprite, SPRITE_MODIFIER_CUSTOM_SPRITE) || (flags & TLF_SPRITE_REG_FLAGS)) {
      uint8_t var10 = (flags & TLF_SPRITE_VAR10) ? regs->sprite_var10 : (ground && separate_ground ? 1 : 0);
      SetBit(var10_values, var10);
    }
 
    /* Add default sprite offset, unless there is a custom one */
    if (!(flags & TLF_SPRITE)) {
      if (HasBit(result->image.sprite, SPRITE_MODIFIER_CUSTOM_SPRITE)) {
        result->image.sprite += ground ? newgrf_ground_offset : newgrf_offset;
        if (constr_stage > 0 && regs != nullptr) result->image.sprite += GetConstructionStageOffset(constr_stage, regs->max_sprite_offset);
      } else {
        result->image.sprite += orig_offset;
      }
    }
 
    /* Record var10 value for the palette */
    if (HasBit(result->image.pal, SPRITE_MODIFIER_CUSTOM_SPRITE) || (flags & TLF_PALETTE_REG_FLAGS)) {
      uint8_t var10 = (flags & TLF_PALETTE_VAR10) ? regs->palette_var10 : (ground && separate_ground ? 1 : 0);
      SetBit(var10_values, var10);
    }
 
    /* Add default palette offset, unless there is a custom one */
    if (!(flags & TLF_PALETTE)) {
      if (HasBit(result->image.pal, SPRITE_MODIFIER_CUSTOM_SPRITE)) {
        result->image.sprite += ground ? newgrf_ground_offset : newgrf_offset;
        if (constr_stage > 0 && regs != nullptr) result->image.sprite += GetConstructionStageOffset(constr_stage, regs->max_palette_offset);
      }
    }
 
    ground = false;
    if (regs != nullptr) regs++;
  }
 
  return var10_values;
}
 
void NewGRFSpriteLayout::ProcessRegisters(uint8_t resolved_var10, uint32_t resolved_sprite, bool separate_ground) const
{
  DrawTileSeqStruct *result;
  const TileLayoutRegisters *regs = this->registers;
  bool ground = true;
  foreach_draw_tile_seq(result, result_seq.data()) {
    TileLayoutFlags flags = TLF_NOTHING;
    if (regs != nullptr) flags = regs->flags;
 
    /* Is the sprite or bounding box affected by an action-1-2-3 chain? */
    if (HasBit(result->image.sprite, SPRITE_MODIFIER_CUSTOM_SPRITE) || (flags & TLF_SPRITE_REG_FLAGS)) {
      /* Does the var10 value apply to this sprite? */
      uint8_t var10 = (flags & TLF_SPRITE_VAR10) ? regs->sprite_var10 : (ground && separate_ground ? 1 : 0);
      if (var10 == resolved_var10) {
        /* Apply registers */
        if ((flags & TLF_DODRAW) && GetRegister(regs->dodraw) == 0) {
          result->image.sprite = 0;
        } else {
          if (HasBit(result->image.sprite, SPRITE_MODIFIER_CUSTOM_SPRITE)) result->image.sprite += resolved_sprite;
          if (flags & TLF_SPRITE) {
            int16_t offset = (int16_t)GetRegister(regs->sprite); // mask to 16 bits to avoid trouble
            if (!HasBit(result->image.sprite, SPRITE_MODIFIER_CUSTOM_SPRITE) || (offset >= 0 && offset < regs->max_sprite_offset)) {
              result->image.sprite += offset;
            } else {
              result->image.sprite = SPR_IMG_QUERY;
            }
          }
 
          if (result->IsParentSprite()) {
            if (flags & TLF_BB_XY_OFFSET) {
              result->delta_x += (int32_t)GetRegister(regs->delta.parent[0]);
              result->delta_y += (int32_t)GetRegister(regs->delta.parent[1]);
            }
            if (flags & TLF_BB_Z_OFFSET)    result->delta_z += (int32_t)GetRegister(regs->delta.parent[2]);
          } else {
            if (flags & TLF_CHILD_X_OFFSET) result->delta_x += (int32_t)GetRegister(regs->delta.child[0]);
            if (flags & TLF_CHILD_Y_OFFSET) result->delta_y += (int32_t)GetRegister(regs->delta.child[1]);
          }
        }
      }
    }
 
    /* Is the palette affected by an action-1-2-3 chain? */
    if (result->image.sprite != 0 && (HasBit(result->image.pal, SPRITE_MODIFIER_CUSTOM_SPRITE) || (flags & TLF_PALETTE_REG_FLAGS))) {
      /* Does the var10 value apply to this sprite? */
      uint8_t var10 = (flags & TLF_PALETTE_VAR10) ? regs->palette_var10 : (ground && separate_ground ? 1 : 0);
      if (var10 == resolved_var10) {
        /* Apply registers */
        if (HasBit(result->image.pal, SPRITE_MODIFIER_CUSTOM_SPRITE)) result->image.pal += resolved_sprite;
        if (flags & TLF_PALETTE) {
          int16_t offset = (int16_t)GetRegister(regs->palette); // mask to 16 bits to avoid trouble
          if (!HasBit(result->image.pal, SPRITE_MODIFIER_CUSTOM_SPRITE) || (offset >= 0 && offset < regs->max_palette_offset)) {
            result->image.pal += offset;
          } else {
            result->image.sprite = SPR_IMG_QUERY;
            result->image.pal = PAL_NONE;
          }
        }
      }
    }
 
    ground = false;
    if (regs != nullptr) regs++;
  }
}