OpenTTD Source 20260107-master-g88a467db19
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
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 */
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 switch (GetTrackBits(tile)) {
115 case TRACK_BIT_X: return AXIS_X;
116 case TRACK_BIT_Y: return AXIS_Y;
117 default: return INVALID_AXIS;
118 }
119}
120
129{
130 /* The axis for existing road waypoints is easy. */
131 if (IsRoadWaypointTile(tile)) return GetDriveThroughStopAxis(tile);
132
133 /* Non-plain road type, no valid axis for waypoints. */
134 if (!IsNormalRoadTile(tile)) return INVALID_AXIS;
135
136 RoadBits bits = GetAllRoadBits(tile);
137
138 if ((bits & ROAD_Y) == 0) return AXIS_X;
139 if ((bits & ROAD_X) == 0) return AXIS_Y;
140
141 return INVALID_AXIS;
142}
143
145
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, MP_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 << axis)) || !(tileh & ~(0x3 << 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
208CommandCost 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)
209{
210 if (!IsValidAxis(axis)) return CMD_ERROR;
211 /* Check if the given station class is valid */
212 if (static_cast<uint>(spec_class) >= StationClass::GetClassCount()) return CMD_ERROR;
213 const StationClass *cls = StationClass::Get(spec_class);
214 if (!IsWaypointClass(*cls)) return CMD_ERROR;
215 if (spec_index >= cls->GetSpecCount()) return CMD_ERROR;
216
217 /* The number of parts to build */
218 uint8_t count = axis == AXIS_X ? height : width;
219
220 if ((axis == AXIS_X ? width : height) != 1) return CMD_ERROR;
221 if (count == 0 || count > _settings_game.station.station_spread) return CMD_ERROR;
222
223 bool reuse = (station_to_join != NEW_STATION);
224 if (!reuse) station_to_join = StationID::Invalid();
225 bool distant_join = (station_to_join != StationID::Invalid());
226
227 if (distant_join && (!_settings_game.station.distant_join_stations || !Waypoint::IsValidID(station_to_join))) return CMD_ERROR;
228
229 TileArea new_location(start_tile, width, height);
230
231 /* only AddCost for non-existing waypoints */
233 for (TileIndex cur_tile : new_location) {
234 if (!IsRailWaypointTile(cur_tile)) cost.AddCost(_price[PR_BUILD_WAYPOINT_RAIL]);
235 }
236
237 /* Make sure the area below consists of clear tiles. (OR tiles belonging to a certain rail station) */
238 StationID est = StationID::Invalid();
239
240 const StationSpec *spec = StationClass::Get(spec_class)->GetSpec(spec_index);
241 RailStationTileLayout stl{spec, count, 1};
242
243 /* Check whether the tiles we're building on are valid rail or not. */
244 TileIndexDiff offset = TileOffsByAxis(OtherAxis(axis));
245 for (auto [i, it, tile] = std::make_tuple(0, stl.begin(), start_tile); i < count; ++i, ++it, tile += offset) {
246 CommandCost ret = IsValidTileForWaypoint(tile, axis, &est);
247 if (ret.Failed()) return ret;
248
249 ret = IsRailStationBridgeAboveOk(tile, spec, StationType::RailWaypoint, *it + axis);
250 if (ret.Failed()) return ret;
251 }
252
253 Waypoint *wp = nullptr;
254 CommandCost ret = FindJoiningWaypoint(est, station_to_join, adjacent, new_location, &wp, false);
255 if (ret.Failed()) return ret;
256
257 /* Check if there is an already existing, deleted, waypoint close to us that we can reuse. */
258 TileIndex center_tile = start_tile + (count / 2) * offset;
259 if (wp == nullptr && reuse) wp = FindDeletedWaypointCloseTo(center_tile, STR_SV_STNAME_WAYPOINT, _current_company, false);
260
261 if (wp != nullptr) {
262 /* Reuse an existing waypoint. */
263 if (wp->owner != _current_company) return CommandCost(STR_ERROR_TOO_CLOSE_TO_ANOTHER_WAYPOINT);
264
265 /* Check if we want to expand an already existing waypoint. */
266 if (wp->train_station.tile != INVALID_TILE) {
267 ret = CanExpandRailStation(wp, new_location);
268 if (ret.Failed()) return ret;
269 }
270
271 ret = wp->rect.BeforeAddRect(start_tile, width, height, StationRect::ADD_TEST);
272 if (ret.Failed()) return ret;
273 } else {
274 /* Check if we can create a new waypoint. */
275 if (!Waypoint::CanAllocateItem()) return CommandCost(STR_ERROR_TOO_MANY_STATIONS_LOADING);
276 }
277
278 /* Check if we can allocate a custom spec to this waypoint. */
279 auto specindex = AllocateSpecToStation(spec, wp);
280 if (!specindex.has_value()) return CommandCost(STR_ERROR_TOO_MANY_STATION_SPECS);
281
282 if (flags.Test(DoCommandFlag::Execute)) {
283 if (wp == nullptr) {
284 wp = Waypoint::Create(start_tile);
285 } else if (!wp->IsInUse()) {
286 /* Move existing (recently deleted) waypoint to the new location */
287 wp->xy = start_tile;
288 }
289 wp->owner = GetTileOwner(start_tile);
290
291 wp->rect.BeforeAddRect(start_tile, width, height, StationRect::ADD_TRY);
292 if (specindex.has_value()) AssignSpecToStation(spec, wp, *specindex);
293
294 wp->delete_ctr = 0;
297 wp->string_id = STR_SV_STNAME_WAYPOINT;
298 wp->train_station = new_location;
299
300 if (wp->town == nullptr) MakeDefaultName(wp);
301
302 wp->UpdateVirtCoord();
303
304 Company *c = Company::Get(wp->owner);
305 for (auto [i, it, tile] = std::make_tuple(0, stl.begin(), start_tile); i < count; ++i, ++it, tile += offset) {
306 uint8_t old_specindex = HasStationTileRail(tile) ? GetCustomStationSpecIndex(tile) : 0;
308 bool reserved = IsTileType(tile, MP_RAILWAY) ?
311 MakeRailWaypoint(tile, wp->owner, wp->index, axis, *it, GetRailType(tile));
312 SetCustomStationSpecIndex(tile, *specindex);
313
314 SetRailStationTileFlags(tile, spec);
315
316 SetRailStationReservation(tile, reserved);
318
319 DeallocateSpecFromStation(wp, old_specindex);
320 if (spec == nullptr) DeleteNewGRFInspectWindow(GSF_STATIONS, tile);
322 }
324 }
325
326 return cost;
327}
328
342CommandCost 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)
343{
344 if (!IsValidAxis(axis)) return CMD_ERROR;
345 /* Check if the given station class is valid */
346 if (static_cast<uint>(spec_class) >= RoadStopClass::GetClassCount()) return CMD_ERROR;
347 const RoadStopClass *cls = RoadStopClass::Get(spec_class);
348 if (!IsWaypointClass(*cls)) return CMD_ERROR;
349 if (spec_index >= cls->GetSpecCount()) return CMD_ERROR;
350
351 const RoadStopSpec *roadstopspec = RoadStopClass::Get(spec_class)->GetSpec(spec_index);
352
353 /* The number of parts to build */
354 uint8_t count = axis == AXIS_X ? height : width;
355
356 if ((axis == AXIS_X ? width : height) != 1) return CMD_ERROR;
357 if (count == 0 || count > _settings_game.station.station_spread) return CMD_ERROR;
358
359 bool reuse = (station_to_join != NEW_STATION);
360 if (!reuse) station_to_join = StationID::Invalid();
361 bool distant_join = (station_to_join != StationID::Invalid());
362
363 if (distant_join && (!_settings_game.station.distant_join_stations || !Waypoint::IsValidID(station_to_join))) return CMD_ERROR;
364
365 TileArea roadstop_area(start_tile, width, height);
366
367 /* Total road stop cost. */
368 Money unit_cost;
369 if (roadstopspec != nullptr) {
370 unit_cost = roadstopspec->GetBuildCost(PR_BUILD_STATION_TRUCK);
371 } else {
372 unit_cost = _price[PR_BUILD_STATION_TRUCK];
373 }
374 StationID est = StationID::Invalid();
375 CommandCost cost = CalculateRoadStopCost(roadstop_area, flags, true, StationType::RoadWaypoint, roadstopspec, axis, AxisToDiagDir(axis), &est, INVALID_ROADTYPE, unit_cost);
376 if (cost.Failed()) return cost;
377
378 Waypoint *wp = nullptr;
379 CommandCost ret = FindJoiningWaypoint(est, station_to_join, adjacent, roadstop_area, &wp, true);
380 if (ret.Failed()) return ret;
381
382 /* Check if there is an already existing, deleted, waypoint close to us that we can reuse. */
383 TileIndex center_tile = start_tile + (count / 2) * TileOffsByAxis(OtherAxis(axis));
384 if (wp == nullptr && reuse) wp = FindDeletedWaypointCloseTo(center_tile, STR_SV_STNAME_WAYPOINT, _current_company, true);
385
386 if (wp != nullptr) {
387 /* Reuse an existing waypoint. */
388 if (!HasBit(wp->waypoint_flags, WPF_ROAD)) return CMD_ERROR;
389 if (wp->owner != _current_company) return CommandCost(STR_ERROR_TOO_CLOSE_TO_ANOTHER_WAYPOINT);
390
391 ret = wp->rect.BeforeAddRect(start_tile, width, height, StationRect::ADD_TEST);
392 if (ret.Failed()) return ret;
393 } else {
394 /* Check if we can create a new waypoint. */
395 if (!Waypoint::CanAllocateItem()) return CommandCost(STR_ERROR_TOO_MANY_STATIONS_LOADING);
396 }
397
398 /* Check if we can allocate a custom spec to this waypoint. */
399 auto specindex = AllocateSpecToRoadStop(roadstopspec, wp);
400 if (!specindex.has_value()) return CommandCost(STR_ERROR_TOO_MANY_STATION_SPECS);
401
402 if (flags.Test(DoCommandFlag::Execute)) {
403 if (wp == nullptr) {
404 wp = Waypoint::Create(start_tile);
406 } else if (!wp->IsInUse()) {
407 /* Move existing (recently deleted) waypoint to the new location */
408 wp->xy = start_tile;
409 }
411
412 wp->rect.BeforeAddRect(start_tile, width, height, StationRect::ADD_TRY);
413 if (specindex.has_value()) AssignSpecToRoadStop(roadstopspec, wp, *specindex);
414
415 if (roadstopspec != nullptr) {
416 /* Include this road stop spec's animation trigger bitmask
417 * in the station's cached copy. */
418 wp->cached_roadstop_anim_triggers.Set(roadstopspec->animation.triggers);
419 }
420
421 wp->delete_ctr = 0;
424 wp->string_id = STR_SV_STNAME_WAYPOINT;
425
426 if (wp->town == nullptr) MakeDefaultName(wp);
427
428 wp->UpdateVirtCoord();
429
430 /* Check every tile in the area. */
431 for (TileIndex cur_tile : roadstop_area) {
432 /* Get existing road types and owners before any tile clearing */
433 RoadType road_rt = MayHaveRoad(cur_tile) ? GetRoadType(cur_tile, RTT_ROAD) : INVALID_ROADTYPE;
434 RoadType tram_rt = MayHaveRoad(cur_tile) ? GetRoadType(cur_tile, RTT_TRAM) : INVALID_ROADTYPE;
435 Owner road_owner = road_rt != INVALID_ROADTYPE ? GetRoadOwner(cur_tile, RTT_ROAD) : _current_company;
436 Owner tram_owner = tram_rt != INVALID_ROADTYPE ? GetRoadOwner(cur_tile, RTT_TRAM) : _current_company;
437
438 if (IsRoadWaypointTile(cur_tile)) {
439 RemoveRoadWaypointStop(cur_tile, flags, *specindex);
440 }
441
442 wp->road_waypoint_area.Add(cur_tile);
443
444 wp->rect.BeforeAddTile(cur_tile, StationRect::ADD_TRY);
445
446 /* Update company infrastructure counts. If the current tile is a normal road tile, remove the old
447 * bits first. */
448 if (IsNormalRoadTile(cur_tile)) {
449 UpdateCompanyRoadInfrastructure(road_rt, road_owner, -(int)CountBits(GetRoadBits(cur_tile, RTT_ROAD)));
450 UpdateCompanyRoadInfrastructure(tram_rt, tram_owner, -(int)CountBits(GetRoadBits(cur_tile, RTT_TRAM)));
451 }
452
455
456 MakeDriveThroughRoadStop(cur_tile, wp->owner, road_owner, tram_owner, wp->index, StationType::RoadWaypoint, road_rt, tram_rt, axis);
457 SetCustomRoadStopSpecIndex(cur_tile, *specindex);
458 if (roadstopspec != nullptr) wp->SetRoadStopRandomBits(cur_tile, 0);
459
460 Company::Get(wp->owner)->infrastructure.station++;
461
462 MarkTileDirtyByTile(cur_tile);
463 }
465 }
466 return cost;
467}
468
476{
477 if (!HasTileWaterGround(tile)) return CommandCost(STR_ERROR_SITE_UNSUITABLE);
478 if (CommandCost ret = IsBuoyBridgeAboveOk(tile); ret.Failed()) return ret;
479
480 if (!IsTileFlat(tile)) return CommandCost(STR_ERROR_SITE_UNSUITABLE);
481
482 /* Check if there is an already existing, deleted, waypoint close to us that we can reuse. */
483 Waypoint *wp = FindDeletedWaypointCloseTo(tile, STR_SV_STNAME_BUOY, OWNER_NONE, false);
484 if (wp == nullptr && !Waypoint::CanAllocateItem()) return CommandCost(STR_ERROR_TOO_MANY_STATIONS_LOADING);
485
486 CommandCost cost(EXPENSES_CONSTRUCTION, _price[PR_BUILD_WAYPOINT_BUOY]);
487 if (!IsWaterTile(tile)) {
489 if (ret.Failed()) return ret;
490 cost.AddCost(ret.GetCost());
491 }
492
493 if (flags.Test(DoCommandFlag::Execute)) {
494 if (wp == nullptr) {
495 wp = Waypoint::Create(tile);
496 } else {
497 /* Move existing (recently deleted) buoy to the new location */
498 wp->xy = tile;
500 }
501 wp->rect.BeforeAddTile(tile, StationRect::ADD_TRY);
502
503 wp->string_id = STR_SV_STNAME_BUOY;
504
506 wp->owner = OWNER_NONE;
507
509
510 if (wp->town == nullptr) MakeDefaultName(wp);
511
512 MakeBuoy(tile, wp->index, GetWaterClass(tile));
516
517 wp->UpdateVirtCoord();
519 }
520
521 return cost;
522}
523
532{
533 /* XXX: strange stuff, allow clearing as invalid company when clearing landscape */
535
536 Waypoint *wp = Waypoint::GetByTile(tile);
537
538 if (HasStationInUse(wp->index, false, _current_company)) return CommandCost(STR_ERROR_BUOY_IS_IN_USE);
539 /* remove the buoy if there is a ship on tile when company goes bankrupt... */
540 if (!flags.Test(DoCommandFlag::Bankrupt)) {
542 if (ret.Failed()) return ret;
543 }
544
545 if (flags.Test(DoCommandFlag::Execute)) {
547
549
550 /* We have to set the water tile's state to the same state as before the
551 * buoy was placed. Otherwise one could plant a buoy on a canal edge,
552 * remove it and flood the land (if the canal edge is at level 0) */
553 MakeWaterKeepingClass(tile, GetTileOwner(tile));
554
555 wp->rect.AfterRemoveTile(wp, tile);
556
557 wp->UpdateVirtCoord();
558 wp->delete_ctr = 0;
559 }
560
561 return CommandCost(EXPENSES_CONSTRUCTION, _price[PR_CLEAR_WAYPOINT_BUOY]);
562}
563
569static bool IsUniqueWaypointName(const std::string &name)
570{
571 for (const Waypoint *wp : Waypoint::Iterate()) {
572 if (!wp->name.empty() && wp->name == name) return false;
573 }
574
575 return true;
576}
577
585CommandCost CmdRenameWaypoint(DoCommandFlags flags, StationID waypoint_id, const std::string &text)
586{
587 Waypoint *wp = Waypoint::GetIfValid(waypoint_id);
588 if (wp == nullptr) return CMD_ERROR;
589
590 if (wp->owner != OWNER_NONE) {
592 if (ret.Failed()) return ret;
593 }
594
595 bool reset = text.empty();
596
597 if (!reset) {
599 if (!IsUniqueWaypointName(text)) return CommandCost(STR_ERROR_NAME_MUST_BE_UNIQUE);
600 }
601
602 if (flags.Test(DoCommandFlag::Execute)) {
603 if (reset) {
604 wp->name.clear();
605 } else {
606 wp->name = text;
607 }
608
609 wp->UpdateVirtCoord();
610 }
611 return CommandCost();
612}
613
621std::tuple<CommandCost, StationID> CmdMoveWaypointName(DoCommandFlags flags, StationID waypoint_id, TileIndex tile)
622{
623 Waypoint *wp = Waypoint::GetIfValid(waypoint_id);
624 if (wp == nullptr) return { CMD_ERROR, StationID::Invalid() };
625
626 if (wp->owner != OWNER_NONE) {
628 if (ret.Failed()) return { ret, StationID::Invalid() };
629 }
630
631 const StationRect *r = &wp->rect;
632 if (!r->PtInExtendedRect(TileX(tile), TileY(tile))) {
633 return { CommandCost(STR_ERROR_SITE_UNSUITABLE), StationID::Invalid() };
634 }
635
636 bool other_station = false;
637 /* Check if the tile is the base tile of another station */
638 ForAllStationsRadius(tile, 0, [&](BaseStation *st) {
639 if (st != nullptr) {
640 if (st != wp && st->xy == tile) other_station = true;
641 }
642 });
643 if (other_station) return { CommandCost(STR_ERROR_SITE_UNSUITABLE), StationID::Invalid() };
644
645 if (flags.Test(DoCommandFlag::Execute)) {
646 wp->MoveSign(tile);
647
648 wp->UpdateVirtCoord();
649 }
650 return { CommandCost(), waypoint_id };
651}
652
658void CcMoveWaypointName(Commands, const CommandCost &result, StationID waypoint_id)
659{
660 if (result.Failed()) return;
661
663 Waypoint *wp = Waypoint::Get(waypoint_id);
665}
constexpr T SetBit(T &x, const uint8_t y)
Set a bit in a variable.
constexpr uint CountBits(T value)
Counts the number of set bits 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.
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?
Enum-as-bit-set wrapper.
void Insert(const T &element)
Insert a single element in the tree.
Definition kdtree.hpp:396
void Remove(const T &element)
Remove a single element from the tree, if it exists.
Definition kdtree.hpp:415
Struct containing information relating to NewGRF classes for stations and airports.
static NewGRFClass * Get(Tindex class_index)
Get a particular class.
uint GetSpecCount() const
Get the number of allocated specs within the class.
static uint GetClassCount()
Get the number of allocated classes.
const Tspec * GetSpec(uint index) const
Get a spec from the class at a given index.
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.
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
Allow incrementing of DiagDirDiff variables.
@ INVALID_AXIS
Flag for an invalid Axis.
@ AXIS_X
The X axis.
@ AXIS_Y
The y axis.
DiagDirection
Enumeration for diagonal directions.
static const uint ROAD_STOP_TRACKBIT_FACTOR
Multiplier for how many regular track bits a bay stop counts.
@ EXPENSES_CONSTRUCTION
Construction costs.
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.).
uint DistanceManhattan(TileIndex t0, TileIndex t1)
Gets the Manhattan distance between the two given tiles.
Definition map.cpp:158
TileIndexDiff TileOffsByAxis(Axis axis)
Convert an Axis to a TileIndexDiff.
Definition map_func.h:567
static uint TileY(TileIndex tile)
Get the Y component of a tile.
Definition map_func.h:437
static uint TileX(TileIndex tile)
Get the X component of a tile.
Definition map_func.h:427
int32_t TileIndexDiff
An offset value between two tiles.
Definition map_type.h:23
Types related to the misc widgets.
uint8_t StationGfx
Copy from station_map.h.
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.
RoadStopClassID
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.
std::optional< uint8_t > AllocateSpecToStation(const StationSpec *spec, BaseStation *st)
Allocate a StationSpec to a Station.
Header file for NewGRF stations.
StationClassID
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.
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:180
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
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:218
RoadBits
Enumeration for the road parts on a tile.
Definition road_type.h:56
@ ROAD_Y
Full road along the y-axis (north-west + south-east)
Definition road_type.h:63
@ ROAD_X
Full road along the x-axis (south-west + north-east)
Definition road_type.h:62
@ RTT_ROAD
Road road type.
Definition road_type.h:38
@ RTT_TRAM
Tram road type.
Definition road_type.h:39
RoadType
The different roadtypes we support.
Definition road_type.h:23
@ INVALID_ROADTYPE
flag for invalid roadtype
Definition road_type.h:28
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:47
@ SLOPE_FLAT
a flat tile
Definition slope_type.h:48
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.
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 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? In other words, is this station tile a rail station or rail waypoint?
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.
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:349
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.
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.
bool build_on_slopes
allow building on slopes
T y
Y coordinate.
T x
X coordinate.
ConstructionSettings construction
construction of things in-game
StationSettings station
settings related to station management
Represents the covered area of e.g.
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 Titem * Get(auto index)
Returns Titem with given index.
static bool CanAllocateItem(size_t n=1)
Helper functions so we can use PoolItem::Function() instead of _poolitem_pool.Function()
static bool IsValidID(auto index)
Tests whether given index can be used to get valid (non-nullptr) Titem.
const Tindex index
Index of this pool item.
Road stop specification.
Money GetBuildCost(Price category) const
Get the cost for building a road stop of this type.
static bool IsValidID(auto index)
Tests whether given index is a valid index for station of this type.
static Waypoint * Create(Targs &&... args)
Creates a new T-object in the station pool.
static Pool::IterateWrapper< Waypoint > Iterate(size_t from=0)
Returns an iterable ensemble of all valid stations of type T.
static Waypoint * Get(auto index)
Gets station with given index.
static Waypoint * GetIfValid(auto index)
Returns station if the index is a valid index for this station type.
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:564
uint8_t station_spread
amount a station may spread
bool distant_join_stations
allow to join non-adjacent stations
Station specification.
void UpdatePosition(int center, int top, std::string_view str, std::string_view str_small={})
Update the position of the viewport sign.
bool kdtree_valid
Are the sign data valid for use with the _viewport_sign_kdtree?
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:95
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
constexpr TileIndex INVALID_TILE
The very nice invalid tile marker.
Definition tile_type.h:95
static constexpr uint TILE_SIZE
Tile size in world coordinates.
Definition tile_type.h:15
@ MP_STATION
A tile of a station.
Definition tile_type.h:53
@ MP_RAILWAY
A railway.
Definition tile_type.h:49
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:285
Track AxisToTrack(Axis a)
Convert an Axis to the corresponding Track AXIS_X -> TRACK_X AXIS_Y -> TRACK_Y Uses the fact that the...
Definition track_func.h:66
@ TRACK_BIT_Y
Y-axis track.
Definition track_type.h:38
@ TRACK_BIT_X
X-axis track.
Definition track_type.h:37
CommandCost EnsureNoVehicleOnGround(TileIndex tile)
Ensure there is no vehicle at the ground at the given position.
Definition vehicle.cpp:528
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:97
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:352
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)
Clear a single tile of a station.
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:3300
Window functions not directly related to making/drawing windows.
@ WC_WAYPOINT_VIEW
Waypoint view; Window numbers:
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.