OpenTTD Source 20260621-master-g720d10536d
waypoint_cmd.cpp
Go to the documentation of this file.
1/*
2 * This file is part of OpenTTD.
3 * 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.
4 * 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.
5 * 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>.
6 */
7
9
10#include "stdafx.h"
11
12#include "command_func.h"
13#include "landscape.h"
14#include "bridge_map.h"
15#include "town.h"
16#include "waypoint_base.h"
19#include "tilehighlight_func.h"
20#include "strings_func.h"
21#include "viewport_func.h"
22#include "viewport_kdtree.h"
23#include "station_kdtree.h"
24#include "window_func.h"
26#include "vehicle_func.h"
27#include "string_func.h"
28#include "company_func.h"
29#include "newgrf_debug.h"
30#include "newgrf_station.h"
31#include "newgrf_roadstop.h"
32#include "company_base.h"
33#include "water.h"
34#include "company_gui.h"
35#include "waypoint_cmd.h"
36#include "landscape_cmd.h"
37#include "station_layout_type.h"
38
39#include "widgets/misc_widget.h"
40
41#include "table/strings.h"
42
43#include "safeguards.h"
44
49{
50 Point pt = RemapCoords2(TileX(this->xy) * TILE_SIZE, TileY(this->xy) * TILE_SIZE);
51 if (this->sign.kdtree_valid) _viewport_sign_kdtree.Remove(ViewportSignKdtreeItem::MakeWaypoint(this->index));
52
53 this->sign.UpdatePosition(pt.x, pt.y - 32 * ZOOM_BASE, GetString(STR_WAYPOINT_NAME, this->index));
54
55 _viewport_sign_kdtree.Insert(ViewportSignKdtreeItem::MakeWaypoint(this->index));
56
57 /* Recenter viewport */
58 InvalidateWindowData(WindowClass::WaypointView, this->index);
59}
60
66{
67 if (this->xy == new_xy) return;
68
69 this->BaseStation::MoveSign(new_xy);
70}
71
80static Waypoint *FindDeletedWaypointCloseTo(TileIndex tile, StringID str, CompanyID cid, bool is_road)
81{
82 Waypoint *best = nullptr;
83 uint thres = 8;
84
85 for (Waypoint *wp : Waypoint::Iterate()) {
86 if (!wp->IsInUse() && wp->string_id == str && wp->owner == cid && HasBit(wp->waypoint_flags, WPF_ROAD) == is_road) {
87 uint cur_dist = DistanceManhattan(tile, wp->xy);
88
89 if (cur_dist < thres) {
90 thres = cur_dist;
91 best = wp;
92 }
93 }
94 }
95
96 return best;
97}
98
107{
108 /* The axis for rail waypoints is easy. */
109 if (IsRailWaypointTile(tile)) return GetRailStationAxis(tile);
110
111 /* Non-plain rail type, no valid axis for waypoints. */
113
114 TrackBits bits = GetTrackBits(tile);
115 if (bits == Track::X) return Axis::X;
116 if (bits == Track::Y) return Axis::Y;
117 return Axis::Invalid;
118}
119
128{
129 /* The axis for existing road waypoints is easy. */
130 if (IsRoadWaypointTile(tile)) return GetDriveThroughStopAxis(tile);
131
132 /* Non-plain road type, no valid axis for waypoints. */
133 if (!IsNormalRoadTile(tile)) return Axis::Invalid;
134
135 RoadBits bits = GetAllRoadBits(tile);
136
137 if (!bits.Any(ROAD_Y)) return Axis::X;
138 if (!bits.Any(ROAD_X)) return Axis::Y;
139
140 return Axis::Invalid;
141}
142
144
152static CommandCost IsValidTileForWaypoint(TileIndex tile, Axis axis, StationID *waypoint)
153{
154 /* if waypoint is set, then we have special handling to allow building on top of already existing waypoints.
155 * so waypoint points to StationID::Invalid() if we can build on any waypoint.
156 * Or it points to a waypoint if we're only allowed to build on exactly that waypoint. */
157 if (waypoint != nullptr && IsTileType(tile, TileType::Station)) {
158 if (!IsRailWaypoint(tile)) {
159 return ClearTile_Station(tile, DoCommandFlag::Auto); // get error message
160 } else {
161 StationID wp = GetStationIndex(tile);
162 if (*waypoint == StationID::Invalid()) {
163 *waypoint = wp;
164 } else if (*waypoint != wp) {
165 return CommandCost(STR_ERROR_WAYPOINT_ADJOINS_MORE_THAN_ONE_EXISTING);
166 }
167 }
168 }
169
170 if (GetAxisForNewRailWaypoint(tile) != axis) return CommandCost(STR_ERROR_NO_SUITABLE_RAILROAD_TRACK);
171
172 Owner owner = GetTileOwner(tile);
173 CommandCost ret = CheckOwnership(owner);
174 if (ret.Succeeded()) ret = EnsureNoVehicleOnGround(tile);
175 if (ret.Failed()) return ret;
176
177 Slope tileh = GetTileSlope(tile);
178 if (tileh != SLOPE_FLAT &&
179 (!_settings_game.construction.build_on_slopes || IsSteepSlope(tileh) || !(tileh & (0x3 << to_underlying(axis))) || !(tileh & ~(0x3 << to_underlying(axis))))) {
180 return CommandCost(STR_ERROR_FLAT_LAND_REQUIRED);
181 }
182
183 return CommandCost();
184}
185
186extern CommandCost FindJoiningWaypoint(StationID existing_station, StationID station_to_join, bool adjacent, TileArea ta, Waypoint **wp, bool is_road);
187extern CommandCost CanExpandRailStation(const BaseStation *st, TileArea &new_ta);
188extern 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);
191
192extern CommandCost RemoveRoadWaypointStop(TileIndex tile, DoCommandFlags flags, int replacement_spec_index);
193
195template <>
197{
198 /* Use predefined layout if it exists. Mask bit zero which will indicate axis. */
199 if (!stl.layout.empty()) return this->stl.layout[this->position] & ~1;
200
201 return 0;
202}
203
218CommandCost 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)
219{
220 if (!IsValidAxis(axis)) return CMD_ERROR;
221 /* Check if the given station class is valid */
222 if (spec_class.base() >= StationClass::GetClassCount()) return CMD_ERROR;
223 const StationClass *cls = StationClass::Get(spec_class);
224 if (!IsWaypointClass(*cls)) return CMD_ERROR;
225 if (spec_index >= cls->GetSpecCount()) return CMD_ERROR;
226
227 /* The number of parts to build */
228 uint8_t count = axis == Axis::X ? height : width;
229
230 if ((axis == Axis::X ? width : height) != 1) return CMD_ERROR;
231 if (count == 0 || count > _settings_game.station.station_spread) return CMD_ERROR;
232
233 bool reuse = (station_to_join != NEW_STATION);
234 if (!reuse) station_to_join = StationID::Invalid();
235 bool distant_join = (station_to_join != StationID::Invalid());
236
237 if (distant_join && (!_settings_game.station.distant_join_stations || !Waypoint::IsValidID(station_to_join))) return CMD_ERROR;
238
239 TileArea new_location(start_tile, width, height);
240
241 /* only AddCost for non-existing waypoints */
243 for (TileIndex cur_tile : new_location) {
245 }
246
247 /* Make sure the area below consists of clear tiles. (OR tiles belonging to a certain rail station) */
248 StationID est = StationID::Invalid();
249
250 const StationSpec *spec = StationClass::Get(spec_class)->GetSpec(spec_index);
252
253 /* Check whether the tiles we're building on are valid rail or not. */
254 TileIndexDiff offset = TileOffsByAxis(OtherAxis(axis));
255 for (auto [i, it, tile] = std::make_tuple(0, stl.begin(), start_tile); i < count; ++i, ++it, tile += offset) {
256 CommandCost ret = IsValidTileForWaypoint(tile, axis, &est);
257 if (ret.Failed()) return ret;
258
259 StationGfx gfx = *it + to_underlying(axis);
260 if (spec != nullptr) {
261 uint32_t platinfo = GetPlatformInfo(gfx, count, 1, i, 0, false);
262 /* As the station is not yet completely finished, the station does not yet exist. */
263 uint16_t callback = GetStationCallback(CBID_STATION_BUILD_TILE_LAYOUT, platinfo, 0, spec, nullptr, INVALID_TILE);
264 if (callback != CALLBACK_FAILED && callback <= UINT8_MAX) gfx = (callback & ~1) + to_underlying(axis);
265 }
266
268 if (ret.Failed()) return ret;
269 }
270
271 Waypoint *wp = nullptr;
272 CommandCost ret = FindJoiningWaypoint(est, station_to_join, adjacent, new_location, &wp, false);
273 if (ret.Failed()) return ret;
274
275 /* Check if there is an already existing, deleted, waypoint close to us that we can reuse. */
276 TileIndex center_tile = start_tile + (count / 2) * offset;
277 if (wp == nullptr && reuse) wp = FindDeletedWaypointCloseTo(center_tile, STR_SV_STNAME_WAYPOINT, _current_company, false);
278
279 if (wp != nullptr) {
280 /* Reuse an existing waypoint. */
281 if (wp->owner != _current_company) return CommandCost(STR_ERROR_TOO_CLOSE_TO_ANOTHER_WAYPOINT);
282
283 /* Check if we want to expand an already existing waypoint. */
284 if (wp->train_station.tile != INVALID_TILE) {
285 ret = CanExpandRailStation(wp, new_location);
286 if (ret.Failed()) return ret;
287 }
288
289 ret = wp->rect.BeforeAddRect(start_tile, width, height, StationRect::ADD_TEST);
290 if (ret.Failed()) return ret;
291 } else {
292 /* Check if we can create a new waypoint. */
293 if (!Waypoint::CanAllocateItem()) return CommandCost(STR_ERROR_TOO_MANY_STATIONS_LOADING);
294 }
295
296 /* Check if we can allocate a custom spec to this waypoint. */
297 auto specindex = AllocateSpecToStation(spec, wp);
298 if (!specindex.has_value()) return CommandCost(STR_ERROR_TOO_MANY_STATION_SPECS);
299
300 if (flags.Test(DoCommandFlag::Execute)) {
301 if (wp == nullptr) {
302 wp = Waypoint::Create(start_tile);
303 } else if (!wp->IsInUse()) {
304 /* Move existing (recently deleted) waypoint to the new location */
305 wp->xy = start_tile;
306 }
307 wp->owner = GetTileOwner(start_tile);
308
309 wp->rect.BeforeAddRect(start_tile, width, height, StationRect::ADD_TRY);
310 if (specindex.has_value()) AssignSpecToStation(spec, wp, *specindex);
311
312 wp->delete_ctr = 0;
315 wp->string_id = STR_SV_STNAME_WAYPOINT;
316 wp->train_station = new_location;
317
318 if (wp->town == nullptr) MakeDefaultName(wp);
319
320 wp->UpdateVirtCoord();
321
322 Company *c = Company::Get(wp->owner);
323 for (auto [i, it, tile] = std::make_tuple(0, stl.begin(), start_tile); i < count; ++i, ++it, tile += offset) {
324 uint8_t old_specindex = HasStationTileRail(tile) ? GetCustomStationSpecIndex(tile) : 0;
326 bool reserved = IsTileType(tile, TileType::Railway) ?
329 MakeRailWaypoint(tile, wp->owner, wp->index, axis, *it, GetRailType(tile));
330 SetCustomStationSpecIndex(tile, *specindex);
331
332 if (spec != nullptr) {
333 uint32_t platinfo = GetPlatformInfo(*it + to_underlying(axis), count, 1, i, 0, false);
334
335 /* As the station is not yet completely finished, the station does not yet exist. */
336 uint16_t callback = GetStationCallback(CBID_STATION_BUILD_TILE_LAYOUT, platinfo, 0, spec, nullptr, tile);
337 if (callback != CALLBACK_FAILED) {
338 if (callback <= UINT8_MAX) {
339 SetStationGfx(tile, (callback & ~1) + to_underlying(axis));
340 } else {
342 }
343 }
344 }
345
346 SetRailStationTileFlags(tile, spec);
347
348 SetRailStationReservation(tile, reserved);
350
351 DeallocateSpecFromStation(wp, old_specindex);
352 if (spec == nullptr) DeleteNewGRFInspectWindow(GrfSpecFeature::Stations, tile);
354 }
356 }
357
358 return cost;
359}
360
374CommandCost 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)
375{
376 if (!IsValidAxis(axis)) return CMD_ERROR;
377 /* Check if the given station class is valid */
378 if (spec_class.base() >= RoadStopClass::GetClassCount()) return CMD_ERROR;
379 const RoadStopClass *cls = RoadStopClass::Get(spec_class);
380 if (!IsWaypointClass(*cls)) return CMD_ERROR;
381 if (spec_index >= cls->GetSpecCount()) return CMD_ERROR;
382
383 const RoadStopSpec *roadstopspec = RoadStopClass::Get(spec_class)->GetSpec(spec_index);
384
385 /* The number of parts to build */
386 uint8_t count = axis == Axis::X ? height : width;
387
388 if ((axis == Axis::X ? width : height) != 1) return CMD_ERROR;
389 if (count == 0 || count > _settings_game.station.station_spread) return CMD_ERROR;
390
391 bool reuse = (station_to_join != NEW_STATION);
392 if (!reuse) station_to_join = StationID::Invalid();
393 bool distant_join = (station_to_join != StationID::Invalid());
394
395 if (distant_join && (!_settings_game.station.distant_join_stations || !Waypoint::IsValidID(station_to_join))) return CMD_ERROR;
396
397 TileArea roadstop_area(start_tile, width, height);
398
399 /* Total road stop cost. */
400 Money unit_cost;
401 if (roadstopspec != nullptr) {
402 unit_cost = roadstopspec->GetBuildCost(Price::BuildStationTruck);
403 } else {
404 unit_cost = _price[Price::BuildStationTruck];
405 }
406 StationID est = StationID::Invalid();
407 CommandCost cost = CalculateRoadStopCost(roadstop_area, flags, true, StationType::RoadWaypoint, roadstopspec, axis, AxisToDiagDir(axis), &est, INVALID_ROADTYPE, unit_cost);
408 if (cost.Failed()) return cost;
409
410 Waypoint *wp = nullptr;
411 CommandCost ret = FindJoiningWaypoint(est, station_to_join, adjacent, roadstop_area, &wp, true);
412 if (ret.Failed()) return ret;
413
414 /* Check if there is an already existing, deleted, waypoint close to us that we can reuse. */
415 TileIndex center_tile = start_tile + (count / 2) * TileOffsByAxis(OtherAxis(axis));
416 if (wp == nullptr && reuse) wp = FindDeletedWaypointCloseTo(center_tile, STR_SV_STNAME_WAYPOINT, _current_company, true);
417
418 if (wp != nullptr) {
419 /* Reuse an existing waypoint. */
420 if (!HasBit(wp->waypoint_flags, WPF_ROAD)) return CMD_ERROR;
421 if (wp->owner != _current_company) return CommandCost(STR_ERROR_TOO_CLOSE_TO_ANOTHER_WAYPOINT);
422
423 ret = wp->rect.BeforeAddRect(start_tile, width, height, StationRect::ADD_TEST);
424 if (ret.Failed()) return ret;
425 } else {
426 /* Check if we can create a new waypoint. */
427 if (!Waypoint::CanAllocateItem()) return CommandCost(STR_ERROR_TOO_MANY_STATIONS_LOADING);
428 }
429
430 /* Check if we can allocate a custom spec to this waypoint. */
431 auto specindex = AllocateSpecToRoadStop(roadstopspec, wp);
432 if (!specindex.has_value()) return CommandCost(STR_ERROR_TOO_MANY_STATION_SPECS);
433
434 if (flags.Test(DoCommandFlag::Execute)) {
435 if (wp == nullptr) {
436 wp = Waypoint::Create(start_tile);
438 } else if (!wp->IsInUse()) {
439 /* Move existing (recently deleted) waypoint to the new location */
440 wp->xy = start_tile;
441 }
443
444 wp->rect.BeforeAddRect(start_tile, width, height, StationRect::ADD_TRY);
445 if (specindex.has_value()) AssignSpecToRoadStop(roadstopspec, wp, *specindex);
446
447 if (roadstopspec != nullptr) {
448 /* Include this road stop spec's animation trigger bitmask
449 * in the station's cached copy. */
450 wp->cached_roadstop_anim_triggers.Set(roadstopspec->animation.triggers);
451 }
452
453 wp->delete_ctr = 0;
456 wp->string_id = STR_SV_STNAME_WAYPOINT;
457
458 if (wp->town == nullptr) MakeDefaultName(wp);
459
460 wp->UpdateVirtCoord();
461
462 /* Check every tile in the area. */
463 for (TileIndex cur_tile : roadstop_area) {
464 /* Get existing road types and owners before any tile clearing */
465 RoadType road_rt = MayHaveRoad(cur_tile) ? GetRoadType(cur_tile, RoadTramType::Road) : INVALID_ROADTYPE;
466 RoadType tram_rt = MayHaveRoad(cur_tile) ? GetRoadType(cur_tile, RoadTramType::Tram) : INVALID_ROADTYPE;
467 Owner road_owner = road_rt != INVALID_ROADTYPE ? GetRoadOwner(cur_tile, RoadTramType::Road) : _current_company;
468 Owner tram_owner = tram_rt != INVALID_ROADTYPE ? GetRoadOwner(cur_tile, RoadTramType::Tram) : _current_company;
469
470 if (IsRoadWaypointTile(cur_tile)) {
471 RemoveRoadWaypointStop(cur_tile, flags, *specindex);
472 }
473
474 wp->road_waypoint_area.Add(cur_tile);
475
476 wp->rect.BeforeAddTile(cur_tile, StationRect::ADD_TRY);
477
478 /* Update company infrastructure counts. If the current tile is a normal road tile, remove the old
479 * bits first. */
480 if (IsNormalRoadTile(cur_tile)) {
481 UpdateCompanyRoadInfrastructure(road_rt, road_owner, -static_cast<int>(GetRoadBits(cur_tile, RoadTramType::Road).Count()));
482 UpdateCompanyRoadInfrastructure(tram_rt, tram_owner, -static_cast<int>(GetRoadBits(cur_tile, RoadTramType::Tram).Count()));
483 }
484
487
488 MakeDriveThroughRoadStop(cur_tile, wp->owner, road_owner, tram_owner, wp->index, StationType::RoadWaypoint, road_rt, tram_rt, axis);
489 SetCustomRoadStopSpecIndex(cur_tile, *specindex);
490 if (roadstopspec != nullptr) wp->SetRoadStopRandomBits(cur_tile, 0);
491
492 Company::Get(wp->owner)->infrastructure.station++;
493
494 MarkTileDirtyByTile(cur_tile);
495 }
497 }
498 return cost;
499}
500
508{
509 if (!HasTileWaterGround(tile)) return CommandCost(STR_ERROR_SITE_UNSUITABLE);
510 if (CommandCost ret = IsBuoyBridgeAboveOk(tile); ret.Failed()) return ret;
511
512 if (!IsTileFlat(tile)) return CommandCost(STR_ERROR_SITE_UNSUITABLE);
513
514 /* Check if there is an already existing, deleted, waypoint close to us that we can reuse. */
515 Waypoint *wp = FindDeletedWaypointCloseTo(tile, STR_SV_STNAME_BUOY, OWNER_NONE, false);
516 if (wp == nullptr && !Waypoint::CanAllocateItem()) return CommandCost(STR_ERROR_TOO_MANY_STATIONS_LOADING);
517
519 if (!IsWaterTile(tile)) {
520 CommandCost ret = Command<Commands::LandscapeClear>::Do(flags | DoCommandFlag::Auto, tile);
521 if (ret.Failed()) return ret;
522 cost.AddCost(ret.GetCost());
523 }
524
525 if (flags.Test(DoCommandFlag::Execute)) {
526 if (wp == nullptr) {
527 wp = Waypoint::Create(tile);
528 } else {
529 /* Move existing (recently deleted) buoy to the new location */
530 wp->xy = tile;
531 InvalidateWindowData(WindowClass::WaypointView, wp->index);
532 }
533 wp->rect.BeforeAddTile(tile, StationRect::ADD_TRY);
534
535 wp->string_id = STR_SV_STNAME_BUOY;
536
538 wp->owner = OWNER_NONE;
539
541
542 if (wp->town == nullptr) MakeDefaultName(wp);
543
544 MakeBuoy(tile, wp->index, GetWaterClass(tile));
548
549 wp->UpdateVirtCoord();
550 InvalidateWindowData(WindowClass::WaypointView, wp->index);
551 }
552
553 return cost;
554}
555
564{
565 /* XXX: strange stuff, allow clearing as invalid company when clearing landscape */
567
568 Waypoint *wp = Waypoint::GetByTile(tile);
569
570 if (HasStationInUse(wp->index, false, _current_company)) return CommandCost(STR_ERROR_BUOY_IS_IN_USE);
571 /* remove the buoy if there is a ship on tile when company goes bankrupt... */
572 if (!flags.Test(DoCommandFlag::Bankrupt)) {
574 if (ret.Failed()) return ret;
575 }
576
577 if (flags.Test(DoCommandFlag::Execute)) {
579
580 InvalidateWindowData(WindowClass::WaypointView, wp->index);
581
582 /* We have to set the water tile's state to the same state as before the
583 * buoy was placed. Otherwise one could plant a buoy on a canal edge,
584 * remove it and flood the land (if the canal edge is at level 0) */
585 MakeWaterKeepingClass(tile, GetTileOwner(tile));
586
587 wp->rect.AfterRemoveTile(wp, tile);
588
589 wp->UpdateVirtCoord();
590 wp->delete_ctr = 0;
591 }
592
594}
595
601static bool IsUniqueWaypointName(const std::string &name)
602{
603 for (const Waypoint *wp : Waypoint::Iterate()) {
604 if (!wp->name.empty() && wp->name == name) return false;
605 }
606
607 return true;
608}
609
617CommandCost CmdRenameWaypoint(DoCommandFlags flags, StationID waypoint_id, const std::string &text)
618{
619 Waypoint *wp = Waypoint::GetIfValid(waypoint_id);
620 if (wp == nullptr) return CMD_ERROR;
621
622 if (wp->owner != OWNER_NONE) {
624 if (ret.Failed()) return ret;
625 }
626
627 bool reset = text.empty();
628
629 if (!reset) {
631 if (!IsUniqueWaypointName(text)) return CommandCost(STR_ERROR_NAME_MUST_BE_UNIQUE);
632 }
633
634 if (flags.Test(DoCommandFlag::Execute)) {
635 if (reset) {
636 wp->name.clear();
637 } else {
638 wp->name = text;
639 }
640
641 wp->UpdateVirtCoord();
642 }
643 return CommandCost();
644}
645
653std::tuple<CommandCost, StationID> CmdMoveWaypointName(DoCommandFlags flags, StationID waypoint_id, TileIndex tile)
654{
655 Waypoint *wp = Waypoint::GetIfValid(waypoint_id);
656 if (wp == nullptr) return { CMD_ERROR, StationID::Invalid() };
657
658 if (wp->owner != OWNER_NONE) {
660 if (ret.Failed()) return { ret, StationID::Invalid() };
661 }
662
663 const StationRect *r = &wp->rect;
664 if (!r->PtInExtendedRect(TileX(tile), TileY(tile))) {
665 return { CommandCost(STR_ERROR_SITE_UNSUITABLE), StationID::Invalid() };
666 }
667
668 bool other_station = false;
669 /* Check if the tile is the base tile of another station */
670 ForAllStationsRadius(tile, 0, [&](BaseStation *st) {
671 if (st != nullptr) {
672 if (st != wp && st->xy == tile) other_station = true;
673 }
674 });
675 if (other_station) return { CommandCost(STR_ERROR_SITE_UNSUITABLE), StationID::Invalid() };
676
677 if (flags.Test(DoCommandFlag::Execute)) {
678 wp->MoveSign(tile);
679
680 wp->UpdateVirtCoord();
681 }
682 return { CommandCost(), waypoint_id };
683}
684
690void CcMoveWaypointName(Commands, const CommandCost &result, StationID waypoint_id)
691{
692 if (result.Failed()) return;
693
695 Waypoint *wp = Waypoint::Get(waypoint_id);
697}
constexpr T SetBit(T &x, const uint8_t y)
Set a bit in a variable.
constexpr bool HasBit(const T x, const uint8_t y)
Checks if a bit in a value is set.
Map accessor functions for bridges.
constexpr bool Test(Tvalue_type value) const
Test if the value-th bit is set.
constexpr Timpl & Reset()
Reset all bits.
constexpr Timpl & Set()
Set all bits.
constexpr bool Any(const Timpl &other) const
Test if any of the given values are set.
Common return value for all commands.
bool Succeeded() const
Did this command succeed?
void AddCost(const Money &cost)
Adds the given cost to the cost of the command.
Money GetCost() const
The costs as made up to this moment.
bool Failed() const
Did this command fail?
const Tspec * GetSpec(uint index) const
Get a spec from the class at a given index.
uint GetSpecCount() const
Get the number of allocated specs within the class.
static NewGRFClass * Get(StationClassID class_index)
const RailStationTileLayout & stl
Station tile layout being iterated.
uint position
Position within iterator.
StationGfx operator*() const
Dereference operator.
static Date date
Current date in days (day counter).
Functions related to commands.
static const CommandCost CMD_ERROR
Define a default return value for a failed command.
@ Auto
don't allow building on structures
@ Execute
execute the given command
@ Bankrupt
company bankrupts, skip money check, skip vehicle on tile check in some cases
Commands
List of commands.
EnumBitSet< DoCommandFlag, uint16_t > DoCommandFlags
Bitset of DoCommandFlag elements.
Definition of stuff that is very close to a company, like the company struct itself.
CommandCost CheckOwnership(Owner owner, TileIndex tile)
Check whether the current owner owns something.
CompanyID _current_company
Company currently doing an action.
Functions related to companies.
void DirtyCompanyInfrastructureWindows(CompanyID company)
Redraw all windows with company infrastructure counts.
GUI Functions related to companies.
static constexpr Owner OWNER_NONE
The tile has no ownership.
bool IsValidAxis(Axis d)
Checks if an integer value is a valid Axis.
DiagDirection AxisToDiagDir(Axis a)
Converts an Axis to a DiagDirection.
Axis OtherAxis(Axis a)
Select the other axis as provided.
Axis
Enumeration for the two axis X and Y.
@ X
The X axis.
@ Invalid
Flag for an invalid Axis.
@ Y
The y axis.
DiagDirection
Enumeration for diagonal directions.
Prices _price
Prices and also the fractional part.
Definition economy.cpp:106
static const uint ROAD_STOP_TRACKBIT_FACTOR
Multiplier for how many regular track bits a bay stop counts.
@ Construction
Construction costs.
@ BuildStationTruck
Price for building lorry stations.
@ BuildWaypointBuoy
Price for building new buoys.
@ ClearWaypointBuoy
Price for destroying buoys.
@ BuildWaypointRail
Price for building new rail waypoints.
constexpr std::underlying_type_t< enum_type > to_underlying(enum_type e)
Implementation of std::to_underlying (from C++23).
Definition enum_type.hpp:21
void MarkTileDirtyByTile(TileIndex tile, int bridge_level_offset, int tile_height_override)
Mark a tile given by its index dirty for repaint.
Functions related to OTTD's landscape.
Point RemapCoords2(int x, int y)
Map 3D world or tile coordinate to equivalent 2D coordinate as used in the viewports and smallmap.
Definition landscape.h:97
Command definitions related to landscape (slopes etc.).
#define Point
Macro that prevents name conflicts between included headers.
uint DistanceManhattan(TileIndex t0, TileIndex t1)
Gets the Manhattan distance between the two given tiles.
Definition map.cpp:169
TileIndexDiff TileOffsByAxis(Axis axis)
Convert an Axis to a TileIndexDiff.
Definition map_func.h:559
static uint TileY(TileIndex tile)
Get the Y component of a tile.
Definition map_func.h:429
static uint TileX(TileIndex tile)
Get the X component of a tile.
Definition map_func.h:419
int32_t TileIndexDiff
An offset value between two tiles.
Definition map_type.h:23
Types related to the misc widgets.
@ Stations
Stations feature.
Definition newgrf.h:85
uint8_t StationGfx
Copy from station_map.h.
@ CBID_STATION_BUILD_TILE_LAYOUT
Called when building a station to customize the tile layout.
static const uint CALLBACK_FAILED
Different values for Callback result evaluations.
void ErrorUnknownCallbackResult(uint32_t grfid, uint16_t cbid, uint16_t cb_res)
Record that a NewGRF returned an unknown/invalid callback result.
Functions/types related to NewGRF debugging.
void DeleteNewGRFInspectWindow(GrfSpecFeature feature, uint index)
Delete inspect window for a given feature and index.
std::optional< uint8_t > AllocateSpecToRoadStop(const RoadStopSpec *spec, BaseStation *st)
Allocate a RoadStopSpec to a Station.
void AssignSpecToRoadStop(const RoadStopSpec *spec, BaseStation *st, uint8_t specindex)
Assign a previously allocated RoadStopSpec specindex to a Station.
NewGRF definitions and structures for road stops.
bool IsWaypointClass(const RoadStopClass &cls)
Test if a RoadStopClass is the waypoint class.
PoolID< uint16_t, struct RoadStopClassIDTag, UINT16_MAX, UINT16_MAX > RoadStopClassID
Class IDs for stations.
void AssignSpecToStation(const StationSpec *spec, BaseStation *st, uint8_t specindex)
Assign a previously allocated StationSpec specindex to a Station.
void DeallocateSpecFromStation(BaseStation *st, uint8_t specindex)
Deallocate a StationSpec from a Station.
uint32_t GetPlatformInfo(StationGfx gfx, int platforms, int length, int platform, int position, bool centred)
Evaluate a tile's position within a station, and return the result in a bit-stuffed format.
std::optional< uint8_t > AllocateSpecToStation(const StationSpec *spec, BaseStation *st)
Allocate a StationSpec to a Station.
Header file for NewGRF stations.
NewGRFClass< StationSpec, StationClassID > StationClass
Class containing information relating to station classes.
PoolID< uint16_t, struct StationClassIDTag, UINT16_MAX, UINT16_MAX > StationClassID
Class IDs for stations.
static RailTileType GetRailTileType(Tile t)
Returns the RailTileType (normal with or without signals, waypoint or depot).
Definition rail_map.h:36
RailType GetRailType(Tile t)
Gets the rail type of the given tile.
Definition rail_map.h:115
TrackBits GetTrackBits(Tile tile)
Gets the track bits of the given tile.
Definition rail_map.h:136
@ Normal
Normal rail tile without signals.
Definition rail_map.h:24
TrackBits GetRailReservationTrackBits(Tile t)
Returns the reserved track bits of the tile.
Definition rail_map.h:194
void UpdateCompanyRoadInfrastructure(RoadType rt, Owner o, int count)
Update road infrastructure counts for a company.
Definition road_cmd.cpp:183
bool MayHaveRoad(Tile t)
Test whether a tile can have road/tram types.
Definition road_map.cpp:21
RoadBits GetRoadBits(Tile t, RoadTramType rtt)
Get the present road bits for a specific road type.
Definition road_map.h:112
RoadBits GetAllRoadBits(Tile tile)
Get all set RoadBits on the given tile.
Definition road_map.h:125
RoadType GetRoadType(Tile t, RoadTramType rtt)
Get the road type for the given RoadTramType.
Definition road_map.h:175
static bool IsNormalRoadTile(Tile t)
Return whether a tile is a normal road tile.
Definition road_map.h:58
Owner GetRoadOwner(Tile t, RoadTramType rtt)
Get the owner of a specific road type.
Definition road_map.h:244
static constexpr RoadBits ROAD_X
Full road along the x-axis (south-west + north-east).
Definition road_type.h:66
EnumBitSet< RoadBit, uint8_t > RoadBits
Bitset of RoadBit elements.
Definition road_type.h:64
static constexpr RoadBits ROAD_Y
Full road along the y-axis (north-west + south-east).
Definition road_type.h:67
RoadType
The different roadtypes we support.
Definition road_type.h:23
@ INVALID_ROADTYPE
flag for invalid roadtype
Definition road_type.h:28
@ Tram
Tram type.
Definition road_type.h:39
@ Road
Road type.
Definition road_type.h:38
A number of safeguards to prevent using unsafe methods.
GameSettings _settings_game
Game settings of a running game or the scenario editor.
Definition settings.cpp:61
static constexpr bool IsSteepSlope(Slope s)
Checks if a slope is steep.
Definition slope_func.h:36
Slope
Enumeration for the slope-type.
Definition slope_type.h:53
@ SLOPE_FLAT
a flat tile
Definition slope_type.h:54
CommandCost IsRailStationBridgeAboveOk(TileIndex tile, const StationSpec *spec, StationType type, StationGfx layout)
Test if a rail station can be built below a bridge.
CommandCost CanExpandRailStation(const BaseStation *st, TileArea &new_ta)
Check whether we can expand the rail part of the given station.
CommandCost FindJoiningWaypoint(StationID existing_waypoint, StationID waypoint_to_join, bool adjacent, TileArea ta, Waypoint **wp, bool is_road)
Find a nearby waypoint that joins this waypoint.
CommandCost IsBuoyBridgeAboveOk(TileIndex tile)
Test if a buoy can be built below a bridge.
CommandCost RemoveRoadWaypointStop(TileIndex tile, DoCommandFlags flags, int replacement_spec_index=-1)
Remove a road waypoint.
bool HasStationInUse(StationID station, bool include_company, CompanyID company)
Tests whether the company's vehicles have this station in orders.
void SetRailStationTileFlags(TileIndex tile, const StationSpec *statspec)
Set rail station tile flags for the given tile.
CommandCost CalculateRoadStopCost(TileArea tile_area, DoCommandFlags flags, bool is_drive_through, StationType station_type, const RoadStopSpec *roadstopspec, Axis axis, DiagDirection ddir, StationID *station, RoadType rt, Money unit_cost)
Calculates cost of new road stops within the area.
@ Count
by amount of cargo
Declarations for accessing the k-d tree of stations.
void ForAllStationsRadius(TileIndex center, uint radius, Func func)
Call a function on all stations whose sign is within a radius of a center tile.
Functions related to station layouts.
void SetStationGfx(Tile t, StationGfx gfx)
Set the station graphics of this tile.
Definition station_map.h:80
void SetCustomStationSpecIndex(Tile t, uint8_t specindex)
Set the custom station spec for this tile.
bool IsRailWaypointTile(Tile t)
Is this tile a station tile and a rail waypoint?
void MakeDriveThroughRoadStop(Tile t, Owner station, Owner road, Owner tram, StationID sid, StationType rst, RoadType road_rt, RoadType tram_rt, Axis a)
Make the given tile a drivethrough roadstop tile.
StationID GetStationIndex(Tile t)
Get StationID from a tile.
Definition station_map.h:28
bool HasStationTileRail(Tile t)
Has this station tile a rail?
uint GetCustomStationSpecIndex(Tile t)
Get the custom station spec for this tile.
bool IsRailWaypoint(Tile t)
Is this station tile a rail waypoint?
void SetRailStationReservation(Tile t, bool b)
Set the reservation state of the rail station.
Axis GetRailStationAxis(Tile t)
Get the rail direction of a rail station.
void MakeRailWaypoint(Tile t, Owner o, StationID sid, Axis a, uint8_t section, RailType rt)
Make the given tile a rail waypoint tile.
bool IsRoadWaypointTile(Tile t)
Is this tile a station tile and a road waypoint?
Axis GetDriveThroughStopAxis(Tile t)
Gets the axis of the drive through stop.
void MakeBuoy(Tile t, StationID sid, WaterClass wc)
Make the given tile a buoy tile.
bool HasStationReservation(Tile t)
Get the reservation state of the rail station.
void SetCustomRoadStopSpecIndex(Tile t, uint8_t specindex)
Set the custom road stop spec for this tile.
@ Dock
Station with a dock.
@ TruckStop
Station with truck stops.
@ Train
Station with train station.
@ BusStop
Station with bus stops.
StationType
Station types.
@ RailWaypoint
Waypoint for trains.
@ RoadWaypoint
Waypoint for trucks and busses.
static const uint MAX_LENGTH_STATION_NAME_CHARS
The maximum length of a station name in characters including '\0'.
Definition of base types and functions in a cross-platform compatible way.
size_t Utf8StringLength(std::string_view str)
Get the length of an UTF-8 encoded string in number of characters and thus not the number of bytes th...
Definition string.cpp:351
Functions related to low-level strings.
std::string GetString(StringID string)
Resolve the given StringID into a std::string with formatting but no parameters.
Definition strings.cpp:424
Functions related to OTTD's strings.
uint32_t StringID
Numeric value that represents a string, independent of the selected language.
static const StringID INVALID_STRING_ID
Constant representing an invalid string (16bit in case it is used in savegames).
Base class for all station-ish types.
StringID string_id
Default name (town area) of station.
TileIndex xy
Base tile of the station.
virtual void MoveSign(TileIndex new_xy)
Move this station's main coordinate somewhere else.
StationFacilities facilities
The facilities that this station has.
TileArea train_station
Tile area the train 'station' part covers.
Owner owner
The owner of this station.
uint8_t delete_ctr
Delete counter. If greater than 0 then it is decremented until it reaches 0; the waypoint is then is ...
StationAnimationTriggers cached_roadstop_anim_triggers
NOSAVE: Combined animation trigger bitmask for road stops, used to determine if trigger processing sh...
StationRect rect
NOSAVE: Station spread out rectangle maintained by StationRect::xxx() functions.
bool IsInUse() const
Check whether the base station currently is in use; in use means that it is not scheduled for deletio...
Town * town
The town this station is associated with.
static BaseStation * GetByTile(TileIndex tile)
Get the base station belonging to a specific tile.
TrackedViewportSign sign
NOSAVE: Dimensions of sign.
TimerGameCalendar::Date build_date
Date of construction.
std::string name
Custom name.
uint32_t station
Count of company owned station tiles.
CompanyInfrastructure infrastructure
NOSAVE: Counts of company owned infrastructure.
T y
Y coordinate.
T x
X coordinate.
uint32_t grfid
grfid that introduced this entity.
void Add(TileIndex to_add)
Add a single tile to a tile area; enlarge if needed.
Definition tilearea.cpp:43
TileIndex tile
The base tile of the area.
static Company * Get(auto index)
Road stop specification.
Money GetBuildCost(Price category) const
Get the cost for building a road stop of this type.
static Waypoint * Create(Targs &&... args)
static Pool::IterateWrapper< Waypoint > Iterate(size_t from=0)
static Waypoint * Get(auto index)
static Waypoint * GetIfValid(auto index)
StationRect - used to track station spread out rectangle - cheaper than scanning whole map.
bool PtInExtendedRect(int x, int y, int distance=0) const
Determines whether a given point (x, y) is within a certain distance of the station rectangle.
Definition station.cpp:567
Station specification.
CargoGRFFileProps grf_prop
Link to NewGRF.
Representation of a waypoint.
TileArea road_waypoint_area
Tile area the road waypoint part covers.
uint16_t waypoint_flags
Waypoint flags, see WaypointFlags.
void MoveSign(TileIndex new_xy) override
Move the waypoint main coordinate somewhere else.
void UpdateVirtCoord() override
Update the virtual coords needed to draw the waypoint sign.
bool IsTileFlat(TileIndex tile, int *h)
Check if a given tile is flat.
Definition tile_map.cpp:94
static bool IsTileType(Tile tile, TileType type)
Checks if a tile is a given tiletype.
Definition tile_map.h:150
Owner GetTileOwner(Tile tile)
Returns the owner of a tile.
Definition tile_map.h:178
Slope GetTileSlope(TileIndex tile)
Return the slope of a given tile inside the map.
Definition tile_map.h:279
StrongType::Typedef< uint32_t, struct TileIndexTag, StrongType::Compare, StrongType::Integer, StrongType::Compatible< int32_t >, StrongType::Compatible< int64_t > > TileIndex
The index/ID of a Tile.
Definition tile_type.h:92
constexpr TileIndex INVALID_TILE
The very nice invalid tile marker.
Definition tile_type.h:100
static constexpr uint TILE_SIZE
Tile size in world coordinates.
Definition tile_type.h:15
@ Station
A tile of a station or airport.
Definition tile_type.h:54
@ Railway
A tile with railway.
Definition tile_type.h:50
OrthogonalTileArea TileArea
Shorthand for the much more common orthogonal tile area.
Functions related to tile highlights.
void ResetObjectToPlace()
Reset the cursor and mouse mode handling back to default (normal cursor, only clicking in windows).
Definition of the game-calendar-timer.
Base of the town class.
void MakeDefaultName(T *obj)
Set the default name for a depot/waypoint.
Definition town.h:334
Track AxisToTrack(Axis a)
Convert an Axis to the corresponding Track Axis::X -> Track::X Axis::Y -> Track::Y Uses the fact that...
Definition track_func.h:62
EnumBitSet< Track, uint8_t > TrackBits
Bitset of Track elements.
Definition track_type.h:43
@ X
Track along the x-axis (north-east to south-west).
Definition track_type.h:21
@ Y
Track along the y-axis (north-west to south-east).
Definition track_type.h:22
CommandCost EnsureNoVehicleOnGround(TileIndex tile)
Ensure there is no vehicle at the ground at the given position.
Definition vehicle.cpp:557
Functions related to vehicles.
void SetViewportCatchmentWaypoint(const Waypoint *wp, bool sel)
Select or deselect waypoint for coverage area highlight.
Functions related to (drawing on) viewports.
Declarations for accessing the k-d tree of viewports.
Functions related to water management.
void ClearNeighbourNonFloodingStates(TileIndex tile)
Clear non-flooding state of the tiles around a tile.
Definition water_cmd.cpp:98
void CheckForDockingTile(TileIndex t)
Mark the supplied tile as a docking tile if it is suitable for docking.
bool HasTileWaterGround(Tile t)
Checks whether the tile has water at the ground.
Definition water_map.h:353
WaterClass GetWaterClass(Tile t)
Get the water class at a tile.
Definition water_map.h:114
bool IsWaterTile(Tile t)
Is it a water tile with plain water?
Definition water_map.h:192
Handles dividing the water in the map into regions to assist pathfinding.
Base of waypoints.
@ WPF_ROAD
This is a road waypoint.
static CommandCost IsValidTileForWaypoint(TileIndex tile, Axis axis, StationID *waypoint)
Check whether the given tile is suitable for a waypoint.
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)
Build a road waypoint on an existing road.
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)
Convert existing rail to waypoint.
void CcMoveWaypointName(Commands, const CommandCost &result, StationID waypoint_id)
Callback function that is called after a name is moved.
CommandCost IsRailStationBridgeAboveOk(TileIndex tile, const StationSpec *spec, StationType type, StationGfx layout)
Test if a rail station can be built below a bridge.
std::tuple< CommandCost, StationID > CmdMoveWaypointName(DoCommandFlags flags, StationID waypoint_id, TileIndex tile)
Move a waypoint name.
CommandCost CanExpandRailStation(const BaseStation *st, TileArea &new_ta)
Check whether we can expand the rail part of the given station.
Axis GetAxisForNewRailWaypoint(TileIndex tile)
Get the axis for a new rail waypoint.
Axis GetAxisForNewRoadWaypoint(TileIndex tile)
Get the axis for a new road waypoint.
CommandCost FindJoiningWaypoint(StationID existing_station, StationID station_to_join, bool adjacent, TileArea ta, Waypoint **wp, bool is_road)
Find a nearby waypoint that joins this waypoint.
CommandCost IsBuoyBridgeAboveOk(TileIndex tile)
Test if a buoy can be built below a bridge.
CommandCost RemoveRoadWaypointStop(TileIndex tile, DoCommandFlags flags, int replacement_spec_index)
Remove a road waypoint.
CommandCost RemoveBuoy(TileIndex tile, DoCommandFlags flags)
Remove a buoy.
CommandCost ClearTile_Station(TileIndex tile, DoCommandFlags flags)
Tile callback function signature for clearing a tile.
CommandCost CmdRenameWaypoint(DoCommandFlags flags, StationID waypoint_id, const std::string &text)
Rename a waypoint.
CommandCost CmdBuildBuoy(DoCommandFlags flags, TileIndex tile)
Build a buoy.
static bool IsUniqueWaypointName(const std::string &name)
Check whether the name is unique amongst the waypoints.
static Waypoint * FindDeletedWaypointCloseTo(TileIndex tile, StringID str, CompanyID cid, bool is_road)
Find a deleted waypoint close to a tile.
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)
Calculates cost of new road stops within the area.
Command definitions related to waypoints.
void InvalidateWindowData(WindowClass cls, WindowNumber number, int data, bool gui_scope)
Mark window data of the window of a given class and specific window number as invalid (in need of re-...
Definition window.cpp:3315
Window functions not directly related to making/drawing windows.
Entry point for OpenTTD to YAPF's cache.
void YapfNotifyTrackLayoutChange(TileIndex tile, Track track)
Use this function to notify YAPF that track layout (or signal configuration) has change.