waypoint_cmd.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 "command_func.h"
#include "landscape.h"
#include "bridge_map.h"
#include "town.h"
#include "waypoint_base.h"
#include "pathfinder/yapf/yapf_cache.h"
#include "pathfinder/water_regions.h"
#include "tilehighlight_func.h"
#include "strings_func.h"
#include "viewport_func.h"
#include "viewport_kdtree.h"
#include "station_kdtree.h"
#include "window_func.h"
#include "timer/timer_game_calendar.h"
#include "vehicle_func.h"
#include "string_func.h"
#include "company_func.h"
#include "newgrf_debug.h"
#include "newgrf_station.h"
#include "newgrf_roadstop.h"
#include "company_base.h"
#include "water.h"
#include "company_gui.h"
#include "waypoint_cmd.h"
#include "landscape_cmd.h"
#include "station_layout_type.h"
 
#include "widgets/misc_widget.h"
 
#include "table/strings.h"
 
#include "safeguards.h"

void Waypoint::UpdateVirtCoord()
{
  Point pt = RemapCoords2(TileX(this->xy) * TILE_SIZE, TileY(this->xy) * TILE_SIZE);
  if (this->sign.kdtree_valid) _viewport_sign_kdtree.Remove(ViewportSignKdtreeItem::MakeWaypoint(this->index));
 
  this->sign.UpdatePosition(pt.x, pt.y - 32 * ZOOM_BASE, GetString(STR_WAYPOINT_NAME, this->index));
 
  _viewport_sign_kdtree.Insert(ViewportSignKdtreeItem::MakeWaypoint(this->index));
 
  /* Recenter viewport */
  InvalidateWindowData(WindowClass::WaypointView, this->index);
}

void Waypoint::MoveSign(TileIndex new_xy)
{
  if (this->xy == new_xy) return;
 
  this->BaseStation::MoveSign(new_xy);
}

static Waypoint *FindDeletedWaypointCloseTo(TileIndex tile, StringID str, CompanyID cid, bool is_road)
{
  Waypoint *best = nullptr;
  uint thres = 8;
 
  for (Waypoint *wp : Waypoint::Iterate()) {
    if (!wp->IsInUse() && wp->string_id == str && wp->owner == cid && HasBit(wp->waypoint_flags, WPF_ROAD) == is_road) {
      uint cur_dist = DistanceManhattan(tile, wp->xy);
 
      if (cur_dist < thres) {
        thres = cur_dist;
        best = wp;
      }
    }
  }
 
  return best;
}

Axis GetAxisForNewRailWaypoint(TileIndex tile)
{
  /* The axis for rail waypoints is easy. */
  if (IsRailWaypointTile(tile)) return GetRailStationAxis(tile);
 
  /* Non-plain rail type, no valid axis for waypoints. */
  if (!IsTileType(tile, TileType::Railway) || GetRailTileType(tile) != RailTileType::Normal) return Axis::Invalid;
 
  TrackBits bits = GetTrackBits(tile);
  if (bits == Track::X) return Axis::X;
  if (bits == Track::Y) return Axis::Y;
  return Axis::Invalid;
}

Axis GetAxisForNewRoadWaypoint(TileIndex tile)
{
  /* The axis for existing road waypoints is easy. */
  if (IsRoadWaypointTile(tile)) return GetDriveThroughStopAxis(tile);
 
  /* Non-plain road type, no valid axis for waypoints. */
  if (!IsNormalRoadTile(tile)) return Axis::Invalid;
 
  RoadBits bits = GetAllRoadBits(tile);
 
  if (!bits.Any(ROAD_Y)) return Axis::X;
  if (!bits.Any(ROAD_X)) return Axis::Y;
 
  return Axis::Invalid;
}
 
extern CommandCost ClearTile_Station(TileIndex tile, DoCommandFlags flags);

static CommandCost IsValidTileForWaypoint(TileIndex tile, Axis axis, StationID *waypoint)
{
  /* if waypoint is set, then we have special handling to allow building on top of already existing waypoints.
   * so waypoint points to StationID::Invalid() if we can build on any waypoint.
   * Or it points to a waypoint if we're only allowed to build on exactly that waypoint. */
  if (waypoint != nullptr && IsTileType(tile, TileType::Station)) {
    if (!IsRailWaypoint(tile)) {
      return ClearTile_Station(tile, DoCommandFlag::Auto); // get error message
    } else {
      StationID wp = GetStationIndex(tile);
      if (*waypoint == StationID::Invalid()) {
        *waypoint = wp;
      } else if (*waypoint != wp) {
        return CommandCost(STR_ERROR_WAYPOINT_ADJOINS_MORE_THAN_ONE_EXISTING);
      }
    }
  }
 
  if (GetAxisForNewRailWaypoint(tile) != axis) return CommandCost(STR_ERROR_NO_SUITABLE_RAILROAD_TRACK);
 
  Owner owner = GetTileOwner(tile);
  CommandCost ret = CheckOwnership(owner);
  if (ret.Succeeded()) ret = EnsureNoVehicleOnGround(tile);
  if (ret.Failed()) return ret;
 
  Slope tileh = GetTileSlope(tile);
  if (tileh != SLOPE_FLAT &&
      (!_settings_game.construction.build_on_slopes || IsSteepSlope(tileh) || !(tileh & (0x3 << to_underlying(axis))) || !(tileh & ~(0x3 << to_underlying(axis))))) {
    return CommandCost(STR_ERROR_FLAT_LAND_REQUIRED);
  }
 
  return CommandCost();
}
 
extern CommandCost FindJoiningWaypoint(StationID existing_station, StationID station_to_join, bool adjacent, TileArea ta, Waypoint **wp, bool is_road);
extern CommandCost CalculateRoadStopCost(TileArea tile_area, DoCommandFlags flags, bool is_drive_through, StationType station_type, const RoadStopSpec *roadstopspec, Axis axis, DiagDirection ddir, StationID *est, RoadType rt, Money unit_cost);
extern CommandCost IsRailStationBridgeAboveOk(TileIndex tile, const StationSpec *spec, StationType type, StationGfx layout);
extern CommandCost IsBuoyBridgeAboveOk(TileIndex tile);
 
extern CommandCost RemoveRoadWaypointStop(TileIndex tile, DoCommandFlags flags, int replacement_spec_index);

template <>
StationGfx RailStationTileLayout<StationType::RailWaypoint>::Iterator::operator*() const
{
  /* Use predefined layout if it exists. Mask bit zero which will indicate axis. */
  if (!stl.layout.empty()) return this->stl.layout[this->position] & ~1;
 
  return 0;
}

CommandCost CmdBuildRailWaypoint(DoCommandFlags flags, TileIndex start_tile, Axis axis, uint8_t width, uint8_t height, StationClassID spec_class, uint16_t spec_index, StationID station_to_join, bool adjacent)
{
  if (!IsValidAxis(axis)) return CMD_ERROR;
  /* Check if the given station class is valid */
  if (spec_class.base() >= StationClass::GetClassCount()) return CMD_ERROR;
  const StationClass *cls = StationClass::Get(spec_class);
  if (!IsWaypointClass(*cls)) return CMD_ERROR;
  if (spec_index >= cls->GetSpecCount()) return CMD_ERROR;
 
  /* The number of parts to build */
  uint8_t count = axis == Axis::X ? height : width;
 
  if ((axis == Axis::X ? width : height) != 1) return CMD_ERROR;
  if (count == 0 || count > _settings_game.station.station_spread) return CMD_ERROR;
 
  bool reuse = (station_to_join != NEW_STATION);
  if (!reuse) station_to_join = StationID::Invalid();
  bool distant_join = (station_to_join != StationID::Invalid());
 
  if (distant_join && (!_settings_game.station.distant_join_stations || !Waypoint::IsValidID(station_to_join))) return CMD_ERROR;
 
  TileArea new_location(start_tile, width, height);
  if (CommandCost ret = CheckStationSpread({}, new_location); ret.Failed()) return ret;
 
  /* only AddCost for non-existing waypoints */
  CommandCost cost(ExpensesType::Construction);
  for (TileIndex cur_tile : new_location) {
    if (!IsRailWaypointTile(cur_tile)) cost.AddCost(_price[Price::BuildWaypointRail]);
  }
 
  /* Make sure the area below consists of clear tiles. (OR tiles belonging to a certain rail station) */
  StationID est = StationID::Invalid();
 
  const StationSpec *spec = StationClass::Get(spec_class)->GetSpec(spec_index);
  RailStationTileLayout<StationType::RailWaypoint> stl{spec, count, 1};
 
  /* Check whether the tiles we're building on are valid rail or not. */
  TileIndexDiff offset = TileOffsByAxis(OtherAxis(axis));
  for (auto [i, it, tile] = std::make_tuple(0, stl.begin(), start_tile); i < count; ++i, ++it, tile += offset) {
    CommandCost ret = IsValidTileForWaypoint(tile, axis, &est);
    if (ret.Failed()) return ret;
 
    StationGfx gfx = *it + to_underlying(axis);
    if (spec != nullptr) {
      uint32_t platinfo = GetPlatformInfo(gfx, count, 1, i, 0, false);
      /* As the station is not yet completely finished, the station does not yet exist. */
      uint16_t callback = GetStationCallback(CBID_STATION_BUILD_TILE_LAYOUT, platinfo, 0, spec, nullptr, INVALID_TILE);
      if (callback != CALLBACK_FAILED && callback <= UINT8_MAX) gfx = (callback & ~1) + to_underlying(axis);
    }
 
    ret = IsRailStationBridgeAboveOk(tile, spec, StationType::RailWaypoint, gfx);
    if (ret.Failed()) return ret;
  }
 
  Waypoint *wp = nullptr;
  CommandCost ret = FindJoiningWaypoint(est, station_to_join, adjacent, new_location, &wp, false);
  if (ret.Failed()) return ret;
 
  /* Check if there is an already existing, deleted, waypoint close to us that we can reuse. */
  TileIndex center_tile = start_tile + (count / 2) * offset;
  if (wp == nullptr && reuse) wp = FindDeletedWaypointCloseTo(center_tile, STR_SV_STNAME_WAYPOINT, _current_company, false);
 
  if (wp != nullptr) {
    /* Reuse an existing waypoint. */
    if (wp->owner != _current_company) return CommandCost(STR_ERROR_TOO_CLOSE_TO_ANOTHER_WAYPOINT);
 
    ret = CheckStationSpread(wp->spread, new_location);
    if (ret.Failed()) return ret;
  } else {
    /* Check if we can create a new waypoint. */
    if (!Waypoint::CanAllocateItem()) return CommandCost(STR_ERROR_TOO_MANY_STATIONS_LOADING);
  }
 
  /* Check if we can allocate a custom spec to this waypoint. */
  auto specindex = AllocateSpecToStation(spec, wp);
  if (!specindex.has_value()) return CommandCost(STR_ERROR_TOO_MANY_STATION_SPECS);
 
  if (flags.Test(DoCommandFlag::Execute)) {
    if (wp == nullptr) {
      wp = Waypoint::Create(start_tile);
    } else if (!wp->IsInUse()) {
      /* Move existing (recently deleted) waypoint to the new location */
      wp->xy = start_tile;
    }
    wp->owner = GetTileOwner(start_tile);
 
    wp->spread.Add(new_location);
    wp->train_station.Add(new_location);
 
    if (specindex.has_value()) AssignSpecToStation(spec, wp, *specindex);
 
    wp->delete_ctr = 0;
    wp->facilities.Set(StationFacility::Train);
    wp->build_date = TimerGameCalendar::date;
    wp->string_id = STR_SV_STNAME_WAYPOINT;
 
    if (wp->town == nullptr) MakeDefaultName(wp);
 
    wp->UpdateVirtCoord();
 
    Company *c = Company::Get(wp->owner);
    for (auto [i, it, tile] = std::make_tuple(0, stl.begin(), start_tile); i < count; ++i, ++it, tile += offset) {
      uint8_t old_specindex = HasStationTileRail(tile) ? GetCustomStationSpecIndex(tile) : 0;
      if (!HasStationTileRail(tile)) c->infrastructure.station++;
      bool reserved = IsTileType(tile, TileType::Railway) ?
          GetRailReservationTrackBits(tile).Test(AxisToTrack(axis)) :
          HasStationReservation(tile);
      MakeRailWaypoint(tile, wp->owner, wp->index, axis, *it, GetRailType(tile));
      SetCustomStationSpecIndex(tile, *specindex);
 
      if (spec != nullptr) {
        uint32_t platinfo = GetPlatformInfo(*it + to_underlying(axis), count, 1, i, 0, false);
 
        /* As the station is not yet completely finished, the station does not yet exist. */
        uint16_t callback = GetStationCallback(CBID_STATION_BUILD_TILE_LAYOUT, platinfo, 0, spec, nullptr, tile);
        if (callback != CALLBACK_FAILED) {
          if (callback <= UINT8_MAX) {
            SetStationGfx(tile, (callback & ~1) + to_underlying(axis));
          } else {
            ErrorUnknownCallbackResult(spec->grf_prop.grfid, CBID_STATION_BUILD_TILE_LAYOUT, callback);
          }
        }
      }
 
      SetRailStationTileFlags(tile, spec);
 
      SetRailStationReservation(tile, reserved);
      MarkTileDirtyByTile(tile);
 
      DeallocateSpecFromStation(wp, old_specindex);
      if (spec == nullptr) DeleteNewGRFInspectWindow(GrfSpecFeature::Stations, tile);
      YapfNotifyTrackLayoutChange(tile, AxisToTrack(axis));
    }
    DirtyCompanyInfrastructureWindows(wp->owner);
  }
 
  return cost;
}

CommandCost CmdBuildRoadWaypoint(DoCommandFlags flags, TileIndex start_tile, Axis axis, uint8_t width, uint8_t height, RoadStopClassID spec_class, uint16_t spec_index, StationID station_to_join, bool adjacent)
{
  if (!IsValidAxis(axis)) return CMD_ERROR;
  /* Check if the given station class is valid */
  if (spec_class.base() >= RoadStopClass::GetClassCount()) return CMD_ERROR;
  const RoadStopClass *cls = RoadStopClass::Get(spec_class);
  if (!IsWaypointClass(*cls)) return CMD_ERROR;
  if (spec_index >= cls->GetSpecCount()) return CMD_ERROR;
 
  const RoadStopSpec *roadstopspec = RoadStopClass::Get(spec_class)->GetSpec(spec_index);
 
  /* The number of parts to build */
  uint8_t count = axis == Axis::X ? height : width;
 
  if ((axis == Axis::X ? width : height) != 1) return CMD_ERROR;
  if (count == 0 || count > _settings_game.station.station_spread) return CMD_ERROR;
 
  bool reuse = (station_to_join != NEW_STATION);
  if (!reuse) station_to_join = StationID::Invalid();
  bool distant_join = (station_to_join != StationID::Invalid());
 
  if (distant_join && (!_settings_game.station.distant_join_stations || !Waypoint::IsValidID(station_to_join))) return CMD_ERROR;
 
  TileArea roadstop_area(start_tile, width, height);
  if (CommandCost ret = CheckStationSpread({}, roadstop_area); ret.Failed()) return ret;
 
  /* Total road stop cost. */
  Money unit_cost;
  if (roadstopspec != nullptr) {
    unit_cost = roadstopspec->GetBuildCost(Price::BuildStationTruck);
  } else {
    unit_cost = _price[Price::BuildStationTruck];
  }
  StationID est = StationID::Invalid();
  CommandCost cost = CalculateRoadStopCost(roadstop_area, flags, true, StationType::RoadWaypoint, roadstopspec, axis, AxisToDiagDir(axis), &est, INVALID_ROADTYPE, unit_cost);
  if (cost.Failed()) return cost;
 
  Waypoint *wp = nullptr;
  CommandCost ret = FindJoiningWaypoint(est, station_to_join, adjacent, roadstop_area, &wp, true);
  if (ret.Failed()) return ret;
 
  /* Check if there is an already existing, deleted, waypoint close to us that we can reuse. */
  TileIndex center_tile = start_tile + (count / 2) * TileOffsByAxis(OtherAxis(axis));
  if (wp == nullptr && reuse) wp = FindDeletedWaypointCloseTo(center_tile, STR_SV_STNAME_WAYPOINT, _current_company, true);
 
  if (wp != nullptr) {
    /* Reuse an existing waypoint. */
    if (!HasBit(wp->waypoint_flags, WPF_ROAD)) return CMD_ERROR;
    if (wp->owner != _current_company) return CommandCost(STR_ERROR_TOO_CLOSE_TO_ANOTHER_WAYPOINT);
 
    ret = CheckStationSpread(wp->spread, roadstop_area);
    if (ret.Failed()) return ret;
  } else {
    /* Check if we can create a new waypoint. */
    if (!Waypoint::CanAllocateItem()) return CommandCost(STR_ERROR_TOO_MANY_STATIONS_LOADING);
  }
 
  /* Check if we can allocate a custom spec to this waypoint. */
  auto specindex = AllocateSpecToRoadStop(roadstopspec, wp);
  if (!specindex.has_value()) return CommandCost(STR_ERROR_TOO_MANY_STATION_SPECS);
 
  if (flags.Test(DoCommandFlag::Execute)) {
    if (wp == nullptr) {
      wp = Waypoint::Create(start_tile);
      SetBit(wp->waypoint_flags, WPF_ROAD);
    } else if (!wp->IsInUse()) {
      /* Move existing (recently deleted) waypoint to the new location */
      wp->xy = start_tile;
    }
    wp->owner = _current_company;
 
    wp->spread.Add(roadstop_area);
    if (specindex.has_value()) AssignSpecToRoadStop(roadstopspec, wp, *specindex);
 
    if (roadstopspec != nullptr) {
      /* Include this road stop spec's animation trigger bitmask
       * in the station's cached copy. */
      wp->cached_roadstop_anim_triggers.Set(roadstopspec->animation.triggers);
    }
 
    wp->delete_ctr = 0;
    wp->facilities.Set({StationFacility::BusStop, StationFacility::TruckStop});
    wp->build_date = TimerGameCalendar::date;
    wp->string_id = STR_SV_STNAME_WAYPOINT;
 
    if (wp->town == nullptr) MakeDefaultName(wp);
 
    wp->UpdateVirtCoord();
 
    /* Check every tile in the area. */
    for (TileIndex cur_tile : roadstop_area) {
      /* Get existing road types and owners before any tile clearing */
      RoadType road_rt = MayHaveRoad(cur_tile) ? GetRoadType(cur_tile, RoadTramType::Road) : INVALID_ROADTYPE;
      RoadType tram_rt = MayHaveRoad(cur_tile) ? GetRoadType(cur_tile, RoadTramType::Tram) : INVALID_ROADTYPE;
      Owner road_owner = road_rt != INVALID_ROADTYPE ? GetRoadOwner(cur_tile, RoadTramType::Road) : _current_company;
      Owner tram_owner = tram_rt != INVALID_ROADTYPE ? GetRoadOwner(cur_tile, RoadTramType::Tram) : _current_company;
 
      if (IsRoadWaypointTile(cur_tile)) {
        RemoveRoadWaypointStop(cur_tile, flags, *specindex);
      }
 
      wp->road_waypoint_area.Add(cur_tile);
 
      /* Update company infrastructure counts. If the current tile is a normal road tile, remove the old
       * bits first. */
      if (IsNormalRoadTile(cur_tile)) {
        UpdateCompanyRoadInfrastructure(road_rt, road_owner, -static_cast<int>(GetRoadBits(cur_tile, RoadTramType::Road).Count()));
        UpdateCompanyRoadInfrastructure(tram_rt, tram_owner, -static_cast<int>(GetRoadBits(cur_tile, RoadTramType::Tram).Count()));
      }
 
      UpdateCompanyRoadInfrastructure(road_rt, road_owner, ROAD_STOP_TRACKBIT_FACTOR);
      UpdateCompanyRoadInfrastructure(tram_rt, tram_owner, ROAD_STOP_TRACKBIT_FACTOR);
 
      MakeDriveThroughRoadStop(cur_tile, wp->owner, road_owner, tram_owner, wp->index, StationType::RoadWaypoint, road_rt, tram_rt, axis);
      SetCustomRoadStopSpecIndex(cur_tile, *specindex);
      if (roadstopspec != nullptr) wp->SetRoadStopRandomBits(cur_tile, 0);
 
      Company::Get(wp->owner)->infrastructure.station++;
 
      MarkTileDirtyByTile(cur_tile);
    }
    DirtyCompanyInfrastructureWindows(wp->owner);
  }
  return cost;
}

CommandCost CmdBuildBuoy(DoCommandFlags flags, TileIndex tile)
{
  if (!HasTileWaterGround(tile)) return CommandCost(STR_ERROR_SITE_UNSUITABLE);
  if (CommandCost ret = IsBuoyBridgeAboveOk(tile); ret.Failed()) return ret;
 
  if (!IsTileFlat(tile)) return CommandCost(STR_ERROR_SITE_UNSUITABLE);
 
  /* Check if there is an already existing, deleted, waypoint close to us that we can reuse. */
  Waypoint *wp = FindDeletedWaypointCloseTo(tile, STR_SV_STNAME_BUOY, OWNER_NONE, false);
  if (wp == nullptr && !Waypoint::CanAllocateItem()) return CommandCost(STR_ERROR_TOO_MANY_STATIONS_LOADING);
 
  CommandCost cost(ExpensesType::Construction, _price[Price::BuildWaypointBuoy]);
 
  /* Get the water class of the water tile before it is cleared.*/
  WaterClass wc = GetWaterClass(tile);
 
  if (!IsWaterTile(tile)) {
    CommandCost ret = Command<Commands::LandscapeClear>::Do(flags | DoCommandFlag::Auto, tile);
    if (ret.Failed()) return ret;
    cost.AddCost(ret.GetCost());
  }
 
  if (flags.Test(DoCommandFlag::Execute)) {
    if (wp == nullptr) {
      wp = Waypoint::Create(tile);
    } else {
      /* Move existing (recently deleted) buoy to the new location */
      wp->xy = tile;
      InvalidateWindowData(WindowClass::WaypointView, wp->index);
    }
    wp->spread.Add(tile);
 
    wp->string_id = STR_SV_STNAME_BUOY;
 
    wp->facilities.Set(StationFacility::Dock);
    wp->owner = OWNER_NONE;
 
    wp->build_date = TimerGameCalendar::date;
 
    if (wp->town == nullptr) MakeDefaultName(wp);
 
    MakeBuoy(tile, wp->index, wc);
    CheckForDockingTile(tile);
    MarkTileDirtyByTile(tile);
    ClearNeighbourNonFloodingStates(tile);
 
    wp->UpdateVirtCoord();
    InvalidateWindowData(WindowClass::WaypointView, wp->index);
  }
 
  return cost;
}

CommandCost RemoveBuoy(TileIndex tile, DoCommandFlags flags)
{
  /* XXX: strange stuff, allow clearing as invalid company when clearing landscape */
  if (!Company::IsValidID(_current_company) && !flags.Test(DoCommandFlag::Bankrupt)) return CommandCost(INVALID_STRING_ID);
 
  Waypoint *wp = Waypoint::GetByTile(tile);
 
  if (HasStationInUse(wp->index, false, _current_company)) return CommandCost(STR_ERROR_BUOY_IS_IN_USE);
  /* remove the buoy if there is a ship on tile when company goes bankrupt... */
  if (!flags.Test(DoCommandFlag::Bankrupt)) {
    CommandCost ret = EnsureNoVehicleOnGround(tile);
    if (ret.Failed()) return ret;
  }
 
  if (flags.Test(DoCommandFlag::Execute)) {
    wp->facilities.Reset(StationFacility::Dock);
 
    InvalidateWindowData(WindowClass::WaypointView, wp->index);
 
    /* We have to set the water tile's state to the same state as before the
     * buoy was placed. Otherwise one could plant a buoy on a canal edge,
     * remove it and flood the land (if the canal edge is at level 0) */
    MakeWaterKeepingClass(tile, GetTileOwner(tile));
 
    wp->spread.Clear();
 
    wp->UpdateVirtCoord();
    wp->delete_ctr = 0;
  }
 
  return CommandCost(ExpensesType::Construction, _price[Price::ClearWaypointBuoy]);
}

static bool IsUniqueWaypointName(const std::string &name)
{
  for (const Waypoint *wp : Waypoint::Iterate()) {
    if (!wp->name.empty() && wp->name == name) return false;
  }
 
  return true;
}

CommandCost CmdRenameWaypoint(DoCommandFlags flags, StationID waypoint_id, const std::string &text)
{
  Waypoint *wp = Waypoint::GetIfValid(waypoint_id);
  if (wp == nullptr) return CMD_ERROR;
 
  if (wp->owner != OWNER_NONE) {
    CommandCost ret = CheckOwnership(wp->owner);
    if (ret.Failed()) return ret;
  }
 
  bool reset = text.empty();
 
  if (!reset) {
    if (Utf8StringLength(text) >= MAX_LENGTH_STATION_NAME_CHARS) return CMD_ERROR;
    if (!IsUniqueWaypointName(text)) return CommandCost(STR_ERROR_NAME_MUST_BE_UNIQUE);
  }
 
  if (flags.Test(DoCommandFlag::Execute)) {
    if (reset) {
      wp->name.clear();
    } else {
      wp->name = text;
    }
 
    wp->UpdateVirtCoord();
  }
  return CommandCost();
}

std::tuple<CommandCost, StationID> CmdMoveWaypointName(DoCommandFlags flags, StationID waypoint_id, TileIndex tile)
{
  Waypoint *wp = Waypoint::GetIfValid(waypoint_id);
  if (wp == nullptr) return { CMD_ERROR, StationID::Invalid() };
 
  if (wp->owner != OWNER_NONE) {
    CommandCost ret = CheckOwnership(wp->owner);
    if (ret.Failed()) return { ret, StationID::Invalid() };
  }
 
  if (!wp->spread.Contains(tile)) {
    return { CommandCost(STR_ERROR_SITE_UNSUITABLE), StationID::Invalid() };
  }
 
  bool other_station = false;
  /* Check if the tile is the base tile of another station */
  ForAllStationsRadius(tile, 0, [&](BaseStation *st) {
    if (st != nullptr) {
      if (st != wp && st->xy == tile) other_station = true;
    }
  });
  if (other_station) return { CommandCost(STR_ERROR_SITE_UNSUITABLE), StationID::Invalid() };
 
  if (flags.Test(DoCommandFlag::Execute)) {
    wp->MoveSign(tile);
 
    wp->UpdateVirtCoord();
  }
  return { CommandCost(), waypoint_id };
}

void CcMoveWaypointName(Commands, const CommandCost &result, StationID waypoint_id)
{
  if (result.Failed()) return;
 
  ResetObjectToPlace();
  Waypoint *wp = Waypoint::Get(waypoint_id);
  SetViewportCatchmentWaypoint(wp, false);
}