vehicle.cpp

Go to the documentation of this file.

/* $Id: vehicle.cpp 14933 2009-01-09 14:59:02Z rubidium $ */

#include "stdafx.h"
#include "openttd.h"
#include "road_map.h"
#include "roadveh.h"
#include "ship.h"
#include "spritecache.h"
#include "tile_cmd.h"
#include "landscape.h"
#include "timetable.h"
#include "viewport_func.h"
#include "gfx_func.h"
#include "news_func.h"
#include "command_func.h"
#include "saveload/saveload.h"
#include "company_func.h"
#include "debug.h"
#include "vehicle_gui.h"
#include "rail_type.h"
#include "train.h"
#include "aircraft.h"
#include "industry_map.h"
#include "station_map.h"
#include "water_map.h"
#include "yapf/yapf.h"
#include "newgrf_callbacks.h"
#include "newgrf_engine.h"
#include "newgrf_sound.h"
#include "newgrf_station.h"
#include "newgrf_text.h"
#include "group.h"
#include "group_gui.h"
#include "order_func.h"
#include "strings_func.h"
#include "zoom_func.h"
#include "functions.h"
#include "date_func.h"
#include "window_func.h"
#include "vehicle_func.h"
#include "signal_func.h"
#include "sound_func.h"
#include "variables.h"
#include "autoreplace_func.h"
#include "autoreplace_gui.h"
#include "string_func.h"
#include "settings_type.h"
#include "oldpool_func.h"
#include "depot_map.h"
#include "animated_tile_func.h"
#include "effectvehicle_base.h"
#include "core/alloc_func.hpp"
#include "core/smallmap_type.hpp"
#include "vehiclelist.h"
#include "core/mem_func.hpp"
#include "depot_func.h"

#include "table/sprites.h"
#include "table/strings.h"

#define GEN_HASH(x, y) ((GB((y), 6, 6) << 6) + GB((x), 7, 6))

VehicleID _vehicle_id_ctr_day;
const Vehicle *_place_clicked_vehicle;
VehicleID _new_vehicle_id;
uint16 _returned_refit_capacity;


/* Tables used in vehicle.h to find the right command for a certain vehicle type */
const uint32 _veh_build_proc_table[] = {
  CMD_BUILD_RAIL_VEHICLE,
  CMD_BUILD_ROAD_VEH,
  CMD_BUILD_SHIP,
  CMD_BUILD_AIRCRAFT,
};
const uint32 _veh_sell_proc_table[] = {
  CMD_SELL_RAIL_WAGON,
  CMD_SELL_ROAD_VEH,
  CMD_SELL_SHIP,
  CMD_SELL_AIRCRAFT,
};

const uint32 _veh_refit_proc_table[] = {
  CMD_REFIT_RAIL_VEHICLE,
  CMD_REFIT_ROAD_VEH,
  CMD_REFIT_SHIP,
  CMD_REFIT_AIRCRAFT,
};

const uint32 _send_to_depot_proc_table[] = {
  CMD_SEND_TRAIN_TO_DEPOT,
  CMD_SEND_ROADVEH_TO_DEPOT,
  CMD_SEND_SHIP_TO_DEPOT,
  CMD_SEND_AIRCRAFT_TO_HANGAR,
};


/* Initialize the vehicle-pool */
DEFINE_OLD_POOL_GENERIC(Vehicle, Vehicle)


bool Vehicle::NeedsAutorenewing(const Company *c) const
{
  /* We can always generate the Company pointer when we have the vehicle.
   * However this takes time and since the Company pointer is often present
   * when this function is called then it's faster to pass the pointer as an
   * argument rather than finding it again. */
  assert(c == GetCompany(this->owner));

  if (!c->engine_renew) return false;
  if (this->age - this->max_age < (c->engine_renew_months * 30)) return false;
  if (this->age == 0) return false; // rail cars don't age and lacks a max age

  return true;
}

void VehicleServiceInDepot(Vehicle *v)
{
  v->date_of_last_service = _date;
  v->breakdowns_since_last_service = 0;
  v->reliability = GetEngine(v->engine_type)->reliability;
  InvalidateWindow(WC_VEHICLE_DETAILS, v->index); // ensure that last service date and reliability are updated
}

bool Vehicle::NeedsServicing() const
{
  if (this->vehstatus & (VS_STOPPED | VS_CRASHED)) return false;

  if (_settings_game.order.no_servicing_if_no_breakdowns && _settings_game.difficulty.vehicle_breakdowns == 0) {
    /* Vehicles set for autoreplacing needs to go to a depot even if breakdowns are turned off.
     * Note: If servicing is enabled, we postpone replacement till next service. */
    return EngineHasReplacementForCompany(GetCompany(this->owner), this->engine_type, this->group_id);
  }

  return _settings_game.vehicle.servint_ispercent ?
    (this->reliability < GetEngine(this->engine_type)->reliability * (100 - this->service_interval) / 100) :
    (this->date_of_last_service + this->service_interval < _date);
}

bool Vehicle::NeedsAutomaticServicing() const
{
  if (_settings_game.order.gotodepot && VehicleHasDepotOrders(this)) return false;
  if (this->current_order.IsType(OT_LOADING))            return false;
  if (this->current_order.IsType(OT_GOTO_DEPOT) && this->current_order.GetDepotOrderType() != ODTFB_SERVICE) return false;
  return NeedsServicing();
}

StringID VehicleInTheWayErrMsg(const Vehicle* v)
{
  switch (v->type) {
    case VEH_TRAIN:    return STR_8803_TRAIN_IN_THE_WAY;
    case VEH_ROAD:     return STR_9000_ROAD_VEHICLE_IN_THE_WAY;
    case VEH_AIRCRAFT: return STR_A015_AIRCRAFT_IN_THE_WAY;
    default:           return STR_980E_SHIP_IN_THE_WAY;
  }
}

static Vehicle *EnsureNoVehicleProcZ(Vehicle *v, void *data)
{
  byte z = *(byte*)data;

  if (v->type == VEH_DISASTER || (v->type == VEH_AIRCRAFT && v->subtype == AIR_SHADOW)) return NULL;
  if (v->z_pos > z) return NULL;

  _error_message = VehicleInTheWayErrMsg(v);
  return v;
}

bool EnsureNoVehicleOnGround(TileIndex tile)
{
  byte z = GetTileMaxZ(tile);
  return !HasVehicleOnPos(tile, &z, &EnsureNoVehicleProcZ);
}

static Vehicle *GetVehicleTunnelBridgeProc(Vehicle *v, void *data)
{
  if (v->type != VEH_TRAIN && v->type != VEH_ROAD && v->type != VEH_SHIP) return NULL;
  if (v == (const Vehicle *)data) return NULL;

  _error_message = VehicleInTheWayErrMsg(v);
  return v;
}

bool HasVehicleOnTunnelBridge(TileIndex tile, TileIndex endtile, const Vehicle *ignore)
{
  return HasVehicleOnPos(tile, (void *)ignore, &GetVehicleTunnelBridgeProc) ||
      HasVehicleOnPos(endtile, (void *)ignore, &GetVehicleTunnelBridgeProc);
}


static void UpdateVehiclePosHash(Vehicle *v, int x, int y);

void VehiclePositionChanged(Vehicle *v)
{
  int img = v->cur_image;
  Point pt = RemapCoords(v->x_pos + v->x_offs, v->y_pos + v->y_offs, v->z_pos);
  const Sprite *spr = GetSprite(img, ST_NORMAL);

  pt.x += spr->x_offs;
  pt.y += spr->y_offs;

  UpdateVehiclePosHash(v, pt.x, pt.y);

  v->left_coord = pt.x;
  v->top_coord = pt.y;
  v->right_coord = pt.x + spr->width + 2;
  v->bottom_coord = pt.y + spr->height + 2;
}

Vehicle::Vehicle()
{
  this->type               = VEH_INVALID;
  this->left_coord         = INVALID_COORD;
  this->group_id           = DEFAULT_GROUP;
  this->fill_percent_te_id = INVALID_TE_ID;
  this->first              = this;
  this->colormap           = PAL_NONE;
}

byte VehicleRandomBits()
{
  return GB(Random(), 0, 8);
}


/* static */ bool Vehicle::AllocateList(Vehicle **vl, int num)
{
  if (!Vehicle::CanAllocateItem(num)) return false;
  if (vl == NULL) return true;

  uint counter = _Vehicle_pool.first_free_index;

  for (int i = 0; i != num; i++) {
    vl[i] = new (AllocateRaw(counter)) InvalidVehicle();
    counter++;
  }

  return true;
}

/* Size of the hash, 6 = 64 x 64, 7 = 128 x 128. Larger sizes will (in theory) reduce hash
 * lookup times at the expense of memory usage. */
const int HASH_BITS = 7;
const int HASH_SIZE = 1 << HASH_BITS;
const int HASH_MASK = HASH_SIZE - 1;
const int TOTAL_HASH_SIZE = 1 << (HASH_BITS * 2);
const int TOTAL_HASH_MASK = TOTAL_HASH_SIZE - 1;

/* Resolution of the hash, 0 = 1*1 tile, 1 = 2*2 tiles, 2 = 4*4 tiles, etc.
 * Profiling results show that 0 is fastest. */
const int HASH_RES = 0;

static Vehicle *_new_vehicle_position_hash[TOTAL_HASH_SIZE];

static Vehicle *VehicleFromHash(int xl, int yl, int xu, int yu, void *data, VehicleFromPosProc *proc, bool find_first)
{
  for (int y = yl; ; y = (y + (1 << HASH_BITS)) & (HASH_MASK << HASH_BITS)) {
    for (int x = xl; ; x = (x + 1) & HASH_MASK) {
      Vehicle *v = _new_vehicle_position_hash[(x + y) & TOTAL_HASH_MASK];
      for (; v != NULL; v = v->next_new_hash) {
        Vehicle *a = proc(v, data);
        if (find_first && a != NULL) return a;
      }
      if (x == xu) break;
    }
    if (y == yu) break;
  }

  return NULL;
}


static Vehicle *VehicleFromPosXY(int x, int y, void *data, VehicleFromPosProc *proc, bool find_first)
{
  const int COLL_DIST = 6;

  /* Hash area to scan is from xl,yl to xu,yu */
  int xl = GB((x - COLL_DIST) / TILE_SIZE, HASH_RES, HASH_BITS);
  int xu = GB((x + COLL_DIST) / TILE_SIZE, HASH_RES, HASH_BITS);
  int yl = GB((y - COLL_DIST) / TILE_SIZE, HASH_RES, HASH_BITS) << HASH_BITS;
  int yu = GB((y + COLL_DIST) / TILE_SIZE, HASH_RES, HASH_BITS) << HASH_BITS;

  return VehicleFromHash(xl, yl, xu, yu, data, proc, find_first);
}

void FindVehicleOnPosXY(int x, int y, void *data, VehicleFromPosProc *proc)
{
  VehicleFromPosXY(x, y, data, proc, false);
}

bool HasVehicleOnPosXY(int x, int y, void *data, VehicleFromPosProc *proc)
{
  return VehicleFromPosXY(x, y, data, proc, true) != NULL;
}

static Vehicle *VehicleFromPos(TileIndex tile, void *data, VehicleFromPosProc *proc, bool find_first)
{
  int x = GB(TileX(tile), HASH_RES, HASH_BITS);
  int y = GB(TileY(tile), HASH_RES, HASH_BITS) << HASH_BITS;

  Vehicle *v = _new_vehicle_position_hash[(x + y) & TOTAL_HASH_MASK];
  for (; v != NULL; v = v->next_new_hash) {
    if (v->tile != tile) continue;

    Vehicle *a = proc(v, data);
    if (find_first && a != NULL) return a;
  }

  return NULL;
}

void FindVehicleOnPos(TileIndex tile, void *data, VehicleFromPosProc *proc)
{
  VehicleFromPos(tile, data, proc, false);
}

bool HasVehicleOnPos(TileIndex tile, void *data, VehicleFromPosProc *proc)
{
  return VehicleFromPos(tile, data, proc, true) != NULL;
}


static void UpdateNewVehiclePosHash(Vehicle *v, bool remove)
{
  Vehicle **old_hash = v->old_new_hash;
  Vehicle **new_hash;

  if (remove) {
    new_hash = NULL;
  } else {
    int x = GB(TileX(v->tile), HASH_RES, HASH_BITS);
    int y = GB(TileY(v->tile), HASH_RES, HASH_BITS) << HASH_BITS;
    new_hash = &_new_vehicle_position_hash[(x + y) & TOTAL_HASH_MASK];
  }

  if (old_hash == new_hash) return;

  /* Remove from the old position in the hash table */
  if (old_hash != NULL) {
    Vehicle *last = NULL;
    Vehicle *u = *old_hash;
    while (u != v) {
      last = u;
      u = u->next_new_hash;
      assert(u != NULL);
    }

    if (last == NULL) {
      *old_hash = v->next_new_hash;
    } else {
      last->next_new_hash = v->next_new_hash;
    }
  }

  /* Insert vehicle at beginning of the new position in the hash table */
  if (new_hash != NULL) {
    v->next_new_hash = *new_hash;
    *new_hash = v;
    assert(v != v->next_new_hash);
  }

  /* Remember current hash position */
  v->old_new_hash = new_hash;
}

static Vehicle *_vehicle_position_hash[0x1000];

static void UpdateVehiclePosHash(Vehicle *v, int x, int y)
{
  UpdateNewVehiclePosHash(v, x == INVALID_COORD);

  Vehicle **old_hash, **new_hash;
  int old_x = v->left_coord;
  int old_y = v->top_coord;

  new_hash = (x == INVALID_COORD) ? NULL : &_vehicle_position_hash[GEN_HASH(x, y)];
  old_hash = (old_x == INVALID_COORD) ? NULL : &_vehicle_position_hash[GEN_HASH(old_x, old_y)];

  if (old_hash == new_hash) return;

  /* remove from hash table? */
  if (old_hash != NULL) {
    Vehicle *last = NULL;
    Vehicle *u = *old_hash;
    while (u != v) {
      last = u;
      u = u->next_hash;
      assert(u != NULL);
    }

    if (last == NULL) {
      *old_hash = v->next_hash;
    } else {
      last->next_hash = v->next_hash;
    }
  }

  /* insert into hash table? */
  if (new_hash != NULL) {
    v->next_hash = *new_hash;
    *new_hash = v;
  }
}

void ResetVehiclePosHash()
{
  Vehicle *v;
  FOR_ALL_VEHICLES(v) { v->old_new_hash = NULL; }
  memset(_vehicle_position_hash, 0, sizeof(_vehicle_position_hash));
  memset(_new_vehicle_position_hash, 0, sizeof(_new_vehicle_position_hash));
}

void ResetVehicleColorMap()
{
  Vehicle *v;
  FOR_ALL_VEHICLES(v) { v->colormap = PAL_NONE; }
}

typedef SmallMap<Vehicle *, bool, 4> AutoreplaceMap;
static AutoreplaceMap _vehicles_to_autoreplace;

void InitializeVehicles()
{
  _Vehicle_pool.CleanPool();
  _Vehicle_pool.AddBlockToPool();

  _vehicles_to_autoreplace.Reset();
  ResetVehiclePosHash();
}

Vehicle *GetLastVehicleInChain(Vehicle *v)
{
  while (v->Next() != NULL) v = v->Next();
  return v;
}

const Vehicle *GetLastVehicleInChain(const Vehicle *v)
{
  while (v->Next() != NULL) v = v->Next();
  return v;
}

uint CountVehiclesInChain(const Vehicle* v)
{
  uint count = 0;
  do count++; while ((v = v->Next()) != NULL);
  return count;
}

bool IsEngineCountable(const Vehicle *v)
{
  switch (v->type) {
    case VEH_AIRCRAFT: return IsNormalAircraft(v); // don't count plane shadows and helicopter rotors
    case VEH_TRAIN:
      return !IsArticulatedPart(v) && // tenders and other articulated parts
      !IsRearDualheaded(v); // rear parts of multiheaded engines
    case VEH_ROAD: return IsRoadVehFront(v);
    case VEH_SHIP: return true;
    default: return false; // Only count company buildable vehicles
  }
}

void Vehicle::PreDestructor()
{
  if (CleaningPool()) return;

  if (IsValidStationID(this->last_station_visited)) {
    GetStation(this->last_station_visited)->loading_vehicles.remove(this);

    HideFillingPercent(&this->fill_percent_te_id);
  }

  if (IsEngineCountable(this)) {
    GetCompany(this->owner)->num_engines[this->engine_type]--;
    if (this->owner == _local_company) InvalidateAutoreplaceWindow(this->engine_type, this->group_id);

    DeleteGroupHighlightOfVehicle(this);
    if (IsValidGroupID(this->group_id)) GetGroup(this->group_id)->num_engines[this->engine_type]--;
    if (this->IsPrimaryVehicle()) DecreaseGroupNumVehicle(this->group_id);
  }

  if (this->type == VEH_ROAD) ClearSlot(this);
  if (this->type == VEH_AIRCRAFT && this->IsPrimaryVehicle()) {
    Station *st = GetTargetAirportIfValid(this);
    if (st != NULL) {
      const AirportFTA *layout = st->Airport()->layout;
      CLRBITS(st->airport_flags, layout[this->u.air.previous_pos].block | layout[this->u.air.pos].block);
    }
  }

  if (this->type != VEH_TRAIN || (this->type == VEH_TRAIN && (IsFrontEngine(this) || IsFreeWagon(this)))) {
    InvalidateWindowData(WC_VEHICLE_DEPOT, this->tile);
  }

  if (this->IsPrimaryVehicle()) {
    DeleteWindowById(WC_VEHICLE_VIEW, this->index);
    DeleteWindowById(WC_VEHICLE_ORDERS, this->index);
    DeleteWindowById(WC_VEHICLE_REFIT, this->index);
    DeleteWindowById(WC_VEHICLE_DETAILS, this->index);
    DeleteWindowById(WC_VEHICLE_TIMETABLE, this->index);
    InvalidateWindow(WC_COMPANY, this->owner);
  }
  InvalidateWindowClassesData(GetWindowClassForVehicleType(this->type), 0);

  this->cargo.Truncate(0);
  DeleteVehicleOrders(this);
  DeleteDepotHighlightOfVehicle(this);

  extern void StopGlobalFollowVehicle(const Vehicle *v);
  StopGlobalFollowVehicle(this);
}

Vehicle::~Vehicle()
{
  free(this->name);

  if (CleaningPool()) return;

  /* sometimes, eg. for disaster vehicles, when company bankrupts, when removing crashed/flooded vehicles,
   * it may happen that vehicle chain is deleted when visible */
  if (!(this->vehstatus & VS_HIDDEN)) MarkSingleVehicleDirty(this);

  Vehicle *v = this->Next();
  this->SetNext(NULL);

  delete v;

  UpdateVehiclePosHash(this, INVALID_COORD, 0);
  this->next_hash = NULL;
  this->next_new_hash = NULL;

  DeleteVehicleNews(this->index, INVALID_STRING_ID);

  new (this) InvalidVehicle();
}

void VehicleEnteredDepotThisTick(Vehicle *v)
{
  /* Vehicle should stop in the depot if it was in 'stopping' state or
   * when the vehicle is ordered to halt in the depot. */
  _vehicles_to_autoreplace[v] = !(v->vehstatus & VS_STOPPED) &&
      (!v->current_order.IsType(OT_GOTO_DEPOT) ||
       !(v->current_order.GetDepotActionType() & ODATFB_HALT));

  /* We ALWAYS set the stopped state. Even when the vehicle does not plan on
   * stopping in the depot, so we stop it to ensure that it will not reserve
   * the path out of the depot before we might autoreplace it to a different
   * engine. The new engine would not own the reserved path we store that we
   * stopped the vehicle, so autoreplace can start it again */
  v->vehstatus |= VS_STOPPED;
}

void CallVehicleTicks()
{
  _vehicles_to_autoreplace.Clear();

  Station *st;
  FOR_ALL_STATIONS(st) LoadUnloadStation(st);

  Vehicle *v;
  FOR_ALL_VEHICLES(v) {
    v->Tick();

    switch (v->type) {
      default: break;

      case VEH_TRAIN:
      case VEH_ROAD:
      case VEH_AIRCRAFT:
      case VEH_SHIP:
        if (v->type == VEH_TRAIN && IsTrainWagon(v)) continue;
        if (v->type == VEH_AIRCRAFT && v->subtype != AIR_HELICOPTER) continue;
        if (v->type == VEH_ROAD && !IsRoadVehFront(v)) continue;

        v->motion_counter += (v->direction & 1) ? (v->cur_speed * 3) / 4 : v->cur_speed;
        /* Play a running sound if the motion counter passes 256 (Do we not skip sounds?) */
        if (GB(v->motion_counter, 0, 8) < v->cur_speed) PlayVehicleSound(v, VSE_RUNNING);

        /* Play an alterate running sound every 16 ticks */
        if (GB(v->tick_counter, 0, 4) == 0) PlayVehicleSound(v, v->cur_speed > 0 ? VSE_RUNNING_16 : VSE_STOPPED_16);
    }
  }

  for (AutoreplaceMap::iterator it = _vehicles_to_autoreplace.Begin(); it != _vehicles_to_autoreplace.End(); it++) {
    v = it->first;
    /* Autoreplace needs the current company set as the vehicle owner */
    _current_company = v->owner;

    /* Start vehicle if we stopped them in VehicleEnteredDepotThisTick()
     * We need to stop them between VehicleEnteredDepotThisTick() and here or we risk that
     * they are already leaving the depot again before being replaced. */
    if (it->second) v->vehstatus &= ~VS_STOPPED;

    /* Store the position of the effect as the vehicle pointer will become invalid later */
    int x = v->x_pos;
    int y = v->y_pos;
    int z = v->z_pos;

    const Company *c = GetCompany(_current_company);
    SubtractMoneyFromCompany(CommandCost(EXPENSES_NEW_VEHICLES, (Money)c->engine_renew_money));
    CommandCost res = DoCommand(0, v->index, 0, DC_EXEC, CMD_AUTOREPLACE_VEHICLE);
    SubtractMoneyFromCompany(CommandCost(EXPENSES_NEW_VEHICLES, -(Money)c->engine_renew_money));

    if (!IsLocalCompany()) continue;

    if (res.Succeeded()) {
      ShowCostOrIncomeAnimation(x, y, z, res.GetCost());
      continue;
    }

    StringID error_message = res.GetErrorMessage();
    if (error_message == STR_AUTOREPLACE_NOTHING_TO_DO || error_message == INVALID_STRING_ID) continue;

    if (error_message == STR_0003_NOT_ENOUGH_CASH_REQUIRES) error_message = STR_AUTOREPLACE_MONEY_LIMIT;

    StringID message;
    if (error_message == STR_TRAIN_TOO_LONG_AFTER_REPLACEMENT) {
      message = error_message;
    } else {
      message = STR_VEHICLE_AUTORENEW_FAILED;
    }

    SetDParam(0, v->index);
    SetDParam(1, error_message);
    AddNewsItem(message, NS_ADVICE, v->index, 0);
  }

  _current_company = OWNER_NONE;
}

bool CanRefitTo(EngineID engine_type, CargoID cid_to)
{
  return HasBit(EngInfo(engine_type)->refit_mask, cid_to);
}

CargoID FindFirstRefittableCargo(EngineID engine_type)
{
  uint32 refit_mask = EngInfo(engine_type)->refit_mask;

  if (refit_mask != 0) {
    for (CargoID cid = 0; cid < NUM_CARGO; cid++) {
      if (HasBit(refit_mask, cid)) return cid;
    }
  }

  return CT_INVALID;
}

CommandCost GetRefitCost(EngineID engine_type)
{
  Money base_cost;
  ExpensesType expense_type;
  switch (GetEngine(engine_type)->type) {
    case VEH_SHIP:
      base_cost = _price.ship_base;
      expense_type = EXPENSES_SHIP_RUN;
      break;

    case VEH_ROAD:
      base_cost = _price.roadveh_base;
      expense_type = EXPENSES_ROADVEH_RUN;
      break;

    case VEH_AIRCRAFT:
      base_cost = _price.aircraft_base;
      expense_type = EXPENSES_AIRCRAFT_RUN;
      break;

    case VEH_TRAIN:
      base_cost = 2 * ((RailVehInfo(engine_type)->railveh_type == RAILVEH_WAGON) ?
               _price.build_railwagon : _price.build_railvehicle);
      expense_type = EXPENSES_TRAIN_RUN;
      break;

    default: NOT_REACHED();
  }
  return CommandCost(expense_type, (EngInfo(engine_type)->refit_cost * base_cost) >> 10);
}

static void DoDrawVehicle(const Vehicle *v)
{
  SpriteID image = v->cur_image;
  SpriteID pal = PAL_NONE;

  if (v->vehstatus & VS_DEFPAL) pal = (v->vehstatus & VS_CRASHED) ? PALETTE_CRASH : GetVehiclePalette(v);

  AddSortableSpriteToDraw(image, pal, v->x_pos + v->x_offs, v->y_pos + v->y_offs,
    v->x_extent, v->y_extent, v->z_extent, v->z_pos, (v->vehstatus & VS_SHADOW) != 0);
}

void ViewportAddVehicles(DrawPixelInfo *dpi)
{
  /* The bounding rectangle */
  const int l = dpi->left;
  const int r = dpi->left + dpi->width;
  const int t = dpi->top;
  const int b = dpi->top + dpi->height;

  /* The hash area to scan */
  int xl, xu, yl, yu;

  if (dpi->width + 70 < (1 << (7 + 6))) {
    xl = GB(l - 70, 7, 6);
    xu = GB(r,      7, 6);
  } else {
    /* scan whole hash row */
    xl = 0;
    xu = 0x3F;
  }

  if (dpi->height + 70 < (1 << (6 + 6))) {
    yl = GB(t - 70, 6, 6) << 6;
    yu = GB(b,      6, 6) << 6;
  } else {
    /* scan whole column */
    yl = 0;
    yu = 0x3F << 6;
  }

  for (int y = yl;; y = (y + (1 << 6)) & (0x3F << 6)) {
    for (int x = xl;; x = (x + 1) & 0x3F) {
      const Vehicle *v = _vehicle_position_hash[x + y]; // already masked & 0xFFF

      while (v != NULL) {
        if (!(v->vehstatus & VS_HIDDEN) &&
            l <= v->right_coord &&
            t <= v->bottom_coord &&
            r >= v->left_coord &&
            b >= v->top_coord) {
          DoDrawVehicle(v);
        }
        v = v->next_hash;
      }

      if (x == xu) break;
    }

    if (y == yu) break;
  }
}

Vehicle *CheckClickOnVehicle(const ViewPort *vp, int x, int y)
{
  Vehicle *found = NULL, *v;
  uint dist, best_dist = UINT_MAX;

  if ((uint)(x -= vp->left) >= (uint)vp->width || (uint)(y -= vp->top) >= (uint)vp->height) return NULL;

  x = ScaleByZoom(x, vp->zoom) + vp->virtual_left;
  y = ScaleByZoom(y, vp->zoom) + vp->virtual_top;

  FOR_ALL_VEHICLES(v) {
    if ((v->vehstatus & (VS_HIDDEN|VS_UNCLICKABLE)) == 0 &&
        x >= v->left_coord && x <= v->right_coord &&
        y >= v->top_coord && y <= v->bottom_coord) {

      dist = max(
        abs(((v->left_coord + v->right_coord) >> 1) - x),
        abs(((v->top_coord + v->bottom_coord) >> 1) - y)
      );

      if (dist < best_dist) {
        found = v;
        best_dist = dist;
      }
    }
  }

  return found;
}

void CheckVehicle32Day(Vehicle *v)
{
  if ((v->day_counter & 0x1F) != 0) return;

  uint16 callback = GetVehicleCallback(CBID_VEHICLE_32DAY_CALLBACK, 0, 0, v->engine_type, v);
  if (callback == CALLBACK_FAILED) return;
  if (HasBit(callback, 0)) TriggerVehicle(v, VEHICLE_TRIGGER_CALLBACK_32); // Trigger vehicle trigger 10
  if (HasBit(callback, 1)) v->colormap = PAL_NONE;                         // Update colormap via callback 2D
}

void DecreaseVehicleValue(Vehicle *v)
{
  v->value -= v->value >> 8;
  InvalidateWindow(WC_VEHICLE_DETAILS, v->index);
}

static const byte _breakdown_chance[64] = {
    3,   3,   3,   3,   3,   3,   3,   3,
    4,   4,   5,   5,   6,   6,   7,   7,
    8,   8,   9,   9,  10,  10,  11,  11,
   12,  13,  13,  13,  13,  14,  15,  16,
   17,  19,  21,  25,  28,  31,  34,  37,
   40,  44,  48,  52,  56,  60,  64,  68,
   72,  80,  90, 100, 110, 120, 130, 140,
  150, 170, 190, 210, 230, 250, 250, 250,
};

void CheckVehicleBreakdown(Vehicle *v)
{
  int rel, rel_old;

  /* decrease reliability */
  v->reliability = rel = max((rel_old = v->reliability) - v->reliability_spd_dec, 0);
  if ((rel_old >> 8) != (rel >> 8)) InvalidateWindow(WC_VEHICLE_DETAILS, v->index);

  if (v->breakdown_ctr != 0 || v->vehstatus & VS_STOPPED ||
      _settings_game.difficulty.vehicle_breakdowns < 1 ||
      v->cur_speed < 5 || _game_mode == GM_MENU) {
    return;
  }

  uint32 r = Random();

  /* increase chance of failure */
  int chance = v->breakdown_chance + 1;
  if (Chance16I(1, 25, r)) chance += 25;
  v->breakdown_chance = min(255, chance);

  /* calculate reliability value to use in comparison */
  rel = v->reliability;
  if (v->type == VEH_SHIP) rel += 0x6666;

  /* reduced breakdowns? */
  if (_settings_game.difficulty.vehicle_breakdowns == 1) rel += 0x6666;

  /* check if to break down */
  if (_breakdown_chance[(uint)min(rel, 0xffff) >> 10] <= v->breakdown_chance) {
    v->breakdown_ctr    = GB(r, 16, 6) + 0x3F;
    v->breakdown_delay  = GB(r, 24, 7) + 0x80;
    v->breakdown_chance = 0;
  }
}

static void ShowVehicleGettingOld(Vehicle *v, StringID msg)
{
  if (v->owner != _local_company) return;

  /* Do not show getting-old message if autorenew is active (and it can replace the vehicle) */
  if (GetCompany(v->owner)->engine_renew && GetEngine(v->engine_type)->company_avail != 0) return;

  SetDParam(0, v->index);
  AddNewsItem(msg, NS_ADVICE, v->index, 0);
}

void AgeVehicle(Vehicle *v)
{
  if (v->age < 65535) v->age++;

  int age = v->age - v->max_age;
  if (age == 366*0 || age == 366*1 || age == 366*2 || age == 366*3 || age == 366*4) v->reliability_spd_dec <<= 1;

  InvalidateWindow(WC_VEHICLE_DETAILS, v->index);

  if (age == -366) {
    ShowVehicleGettingOld(v, STR_01A0_IS_GETTING_OLD);
  } else if (age == 0) {
    ShowVehicleGettingOld(v, STR_01A1_IS_GETTING_VERY_OLD);
  } else if (age > 0 && (age % 366) == 0) {
    ShowVehicleGettingOld(v, STR_01A2_IS_GETTING_VERY_OLD_AND);
  }
}

CommandCost CmdStartStopVehicle(TileIndex tile, uint32 flags, uint32 p1, uint32 p2, const char *text)
{
  /* Disable the effect of p2 bit 0, when DC_AUTOREPLACE is not set */
  if ((flags & DC_AUTOREPLACE) == 0) SetBit(p2, 0);

  if (!IsValidVehicleID(p1)) return CMD_ERROR;

  Vehicle *v = GetVehicle(p1);

  if (!CheckOwnership(v->owner)) return CMD_ERROR;
  if (!v->IsPrimaryVehicle()) return CMD_ERROR;

  switch (v->type) {
    case VEH_TRAIN:
      if (v->vehstatus & VS_STOPPED && v->u.rail.cached_power == 0) return_cmd_error(STR_TRAIN_START_NO_CATENARY);
      break;

    case VEH_SHIP:
    case VEH_ROAD:
      break;

    case VEH_AIRCRAFT:
      /* cannot stop airplane when in flight, or when taking off / landing */
      if (v->u.air.state >= STARTTAKEOFF && v->u.air.state < TERM7) return_cmd_error(STR_A017_AIRCRAFT_IS_IN_FLIGHT);
      break;

    default: return CMD_ERROR;
  }

  /* Check if this vehicle can be started/stopped. The callback will fail or
   * return 0xFF if it can. */
  uint16 callback = GetVehicleCallback(CBID_VEHICLE_START_STOP_CHECK, 0, 0, v->engine_type, v);
  if (callback != CALLBACK_FAILED && GB(callback, 0, 8) != 0xFF && HasBit(p2, 0)) {
    StringID error = GetGRFStringID(GetEngineGRFID(v->engine_type), 0xD000 + callback);
    return_cmd_error(error);
  }

  if (flags & DC_EXEC) {
    static const StringID vehicle_waiting_in_depot[] = {
      STR_8814_TRAIN_IS_WAITING_IN_DEPOT,
      STR_9016_ROAD_VEHICLE_IS_WAITING,
      STR_981C_SHIP_IS_WAITING_IN_DEPOT,
      STR_A014_AIRCRAFT_IS_WAITING_IN,
    };

    static const WindowClass vehicle_list[] = {
      WC_TRAINS_LIST,
      WC_ROADVEH_LIST,
      WC_SHIPS_LIST,
      WC_AIRCRAFT_LIST,
    };

    if (v->IsStoppedInDepot() && (flags & DC_AUTOREPLACE) == 0) DeleteVehicleNews(p1, vehicle_waiting_in_depot[v->type]);

    v->vehstatus ^= VS_STOPPED;
    if (v->type != VEH_TRAIN) v->cur_speed = 0; // trains can stop 'slowly'
    InvalidateWindowWidget(WC_VEHICLE_VIEW, v->index, VVW_WIDGET_START_STOP_VEH);
    InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);
    InvalidateWindowClasses(vehicle_list[v->type]);
  }
  return CommandCost();
}

CommandCost CmdMassStartStopVehicle(TileIndex tile, uint32 flags, uint32 p1, uint32 p2, const char *text)
{
  VehicleList list;
  CommandCost return_value = CMD_ERROR;
  VehicleType vehicle_type = (VehicleType)GB(p2, 0, 5);
  bool start_stop = HasBit(p2, 5);
  bool vehicle_list_window = HasBit(p2, 6);

  if (vehicle_list_window) {
    uint32 id = p1;
    uint16 window_type = p2 & VLW_MASK;

    GenerateVehicleSortList(&list, vehicle_type, _current_company, id, window_type);
  } else {
    /* Get the list of vehicles in the depot */
    BuildDepotVehicleList(vehicle_type, tile, &list, NULL);
  }

  for (uint i = 0; i < list.Length(); i++) {
    const Vehicle *v = list[i];

    if (!!(v->vehstatus & VS_STOPPED) != start_stop) continue;

    if (!vehicle_list_window) {
      if (vehicle_type == VEH_TRAIN) {
        if (CheckTrainInDepot(v, false) == -1) continue;
      } else {
        if (!(v->vehstatus & VS_HIDDEN)) continue;
      }
    }

    CommandCost ret = DoCommand(tile, v->index, 0, flags, CMD_START_STOP_VEHICLE);

    if (CmdSucceeded(ret)) {
      return_value = CommandCost();
      /* We know that the command is valid for at least one vehicle.
       * If we haven't set DC_EXEC, then there is no point in continueing because it will be valid */
      if (!(flags & DC_EXEC)) break;
    }
  }

  return return_value;
}

CommandCost CmdDepotSellAllVehicles(TileIndex tile, uint32 flags, uint32 p1, uint32 p2, const char *text)
{
  VehicleList list;

  CommandCost cost(EXPENSES_NEW_VEHICLES);
  uint sell_command;
  VehicleType vehicle_type = (VehicleType)GB(p1, 0, 8);

  switch (vehicle_type) {
    case VEH_TRAIN:    sell_command = CMD_SELL_RAIL_WAGON; break;
    case VEH_ROAD:     sell_command = CMD_SELL_ROAD_VEH;   break;
    case VEH_SHIP:     sell_command = CMD_SELL_SHIP;       break;
    case VEH_AIRCRAFT: sell_command = CMD_SELL_AIRCRAFT;   break;
    default: return CMD_ERROR;
  }

  /* Get the list of vehicles in the depot */
  BuildDepotVehicleList(vehicle_type, tile, &list, &list);

  for (uint i = 0; i < list.Length(); i++) {
    CommandCost ret = DoCommand(tile, list[i]->index, 1, flags, sell_command);
    if (CmdSucceeded(ret)) cost.AddCost(ret);
  }

  if (cost.GetCost() == 0) return CMD_ERROR; // no vehicles to sell
  return cost;
}

CommandCost CmdDepotMassAutoReplace(TileIndex tile, uint32 flags, uint32 p1, uint32 p2, const char *text)
{
  VehicleList list;
  CommandCost cost = CommandCost(EXPENSES_NEW_VEHICLES);
  VehicleType vehicle_type = (VehicleType)GB(p1, 0, 8);
  bool all_or_nothing = HasBit(p2, 0);

  if (!IsDepotTile(tile) || !IsTileOwner(tile, _current_company)) return CMD_ERROR;

  /* Get the list of vehicles in the depot */
  BuildDepotVehicleList(vehicle_type, tile, &list, &list, true);

  bool did_something = false;

  for (uint i = 0; i < list.Length(); i++) {
    Vehicle *v = (Vehicle*)list[i];

    /* Ensure that the vehicle completely in the depot */
    if (!v->IsInDepot()) continue;

    CommandCost ret = DoCommand(0, v->index, 0, flags, CMD_AUTOREPLACE_VEHICLE);

    if (CmdSucceeded(ret)) {
      did_something = true;
      cost.AddCost(ret);
    } else {
      if (ret.GetErrorMessage() != STR_AUTOREPLACE_NOTHING_TO_DO && all_or_nothing) {
        /* We failed to replace a vehicle even though we set all or nothing.
         * We should never reach this if DC_EXEC is set since then it should
         * have failed the estimation guess. */
        assert(!(flags & DC_EXEC));
        /* Now we will have to return an error. */
        return CMD_ERROR;
      }
    }
  }

  if (!did_something) {
    /* Either we didn't replace anything or something went wrong.
     * Either way we want to return an error and not execute this command. */
    cost = CMD_ERROR;
  }

  return cost;
}

CommandCost CmdCloneVehicle(TileIndex tile, uint32 flags, uint32 p1, uint32 p2, const char *text)
{
  CommandCost total_cost(EXPENSES_NEW_VEHICLES);
  uint32 build_argument = 2;

  if (!IsValidVehicleID(p1)) return CMD_ERROR;

  Vehicle *v = GetVehicle(p1);
  Vehicle *v_front = v;
  Vehicle *w = NULL;
  Vehicle *w_front = NULL;
  Vehicle *w_rear = NULL;

  /*
   * v_front is the front engine in the original vehicle
   * v is the car/vehicle of the original vehicle, that is currently being copied
   * w_front is the front engine of the cloned vehicle
   * w is the car/vehicle currently being cloned
   * w_rear is the rear end of the cloned train. It's used to add more cars and is only used by trains
   */

  if (!CheckOwnership(v->owner)) return CMD_ERROR;

  if (v->type == VEH_TRAIN && (!IsFrontEngine(v) || v->u.rail.crash_anim_pos >= 4400)) return CMD_ERROR;

  /* check that we can allocate enough vehicles */
  if (!(flags &