OpenTTD Source: src/waypoint_cmd.cpp Source File

OpenTTD Source 12.2

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 <http://www.gnu.org/licenses/>.
6 */
7
10 #include "stdafx.h"
11
12 #include "cmd_helper.h"
13 #include "command_func.h"
14 #include "landscape.h"
15 #include "bridge_map.h"
16 #include "town.h"
17 #include "waypoint_base.h"
18 #include "pathfinder/yapf/yapf_cache.h"
19 #include "strings_func.h"
20 #include "viewport_func.h"
21 #include "viewport_kdtree.h"
22 #include "window_func.h"
23 #include "date_func.h"
24 #include "vehicle_func.h"
25 #include "string_func.h"
26 #include "company_func.h"
27 #include "newgrf_station.h"
28 #include "company_base.h"
29 #include "water.h"
30 #include "company_gui.h"
31
32 #include "table/strings.h"
33
34 #include "safeguards.h"
35
39 void Waypoint::UpdateVirtCoord()
40 {
41 Point pt = RemapCoords2(TileX(this->xy) * TILE_SIZE, TileY(this->xy) * TILE_SIZE);
42 if (this->sign.kdtree_valid) _viewport_sign_kdtree.Remove(ViewportSignKdtreeItem::MakeWaypoint(this->index));
43
44 SetDParam(0, this->index);
45 this->sign.UpdatePosition(pt.x, pt.y - 32 * ZOOM_LVL_BASE, STR_VIEWPORT_WAYPOINT);
46
47 _viewport_sign_kdtree.Insert(ViewportSignKdtreeItem::MakeWaypoint(this->index));
48
49 /* Recenter viewport */
50 InvalidateWindowData(WC_WAYPOINT_VIEW, this->index);
51 }
52
57 void Waypoint::MoveSign(TileIndex new_xy)
58 {
59 if (this->xy == new_xy) return;
60
61 this->BaseStation::MoveSign(new_xy);
62 }
63
71 static Waypoint *FindDeletedWaypointCloseTo(TileIndex tile, StringID str, CompanyID cid)
72 {
73 Waypoint *best = nullptr;
74 uint thres = 8;
75
76 for (Waypoint *wp : Waypoint::Iterate()) {
77 if (!wp->IsInUse() && wp->string_id == str && wp->owner == cid) {
78 uint cur_dist = DistanceManhattan(tile, wp->xy);
79
80 if (cur_dist < thres) {
81 thres = cur_dist;
82 best = wp;
83 }
84 }
85 }
86
87 return best;
88 }
89
97 Axis GetAxisForNewWaypoint(TileIndex tile)
98 {
99 /* The axis for rail waypoints is easy. */
100 if (IsRailWaypointTile(tile)) return GetRailStationAxis(tile);
101
102 /* Non-plain rail type, no valid axis for waypoints. */
103 if (!IsTileType(tile, MP_RAILWAY) || GetRailTileType(tile) != RAIL_TILE_NORMAL) return INVALID_AXIS;
104
105 switch (GetTrackBits(tile)) {
106 case TRACK_BIT_X: return AXIS_X;
107 case TRACK_BIT_Y: return AXIS_Y;
108 default: return INVALID_AXIS;
109 }
110 }
111
112 extern CommandCost ClearTile_Station(TileIndex tile, DoCommandFlag flags);
113
120 static CommandCost IsValidTileForWaypoint(TileIndex tile, Axis axis, StationID *waypoint)
121 {
122 /* if waypoint is set, then we have special handling to allow building on top of already existing waypoints.
123 * so waypoint points to INVALID_STATION if we can build on any waypoint.
124 * Or it points to a waypoint if we're only allowed to build on exactly that waypoint. */
125 if (waypoint != nullptr && IsTileType(tile, MP_STATION)) {
126 if (!IsRailWaypoint(tile)) {
127 return ClearTile_Station(tile, DC_AUTO); // get error message
128 } else {
129 StationID wp = GetStationIndex(tile);
130 if (*waypoint == INVALID_STATION) {
131 *waypoint = wp;
132 } else if (*waypoint != wp) {
133 return_cmd_error(STR_ERROR_WAYPOINT_ADJOINS_MORE_THAN_ONE_EXISTING);
134 }
135 }
136 }
137
138 if (GetAxisForNewWaypoint(tile) != axis) return_cmd_error(STR_ERROR_NO_SUITABLE_RAILROAD_TRACK);
139
140 Owner owner = GetTileOwner(tile);
141 CommandCost ret = CheckOwnership(owner);
142 if (ret.Succeeded()) ret = EnsureNoVehicleOnGround(tile);
143 if (ret.Failed()) return ret;
144
145 Slope tileh = GetTileSlope(tile);
146 if (tileh != SLOPE_FLAT &&
147 (!_settings_game.construction.build_on_slopes || IsSteepSlope(tileh) || !(tileh & (0x3 << axis)) || !(tileh & ~(0x3 << axis)))) {
148 return_cmd_error(STR_ERROR_FLAT_LAND_REQUIRED);
149 }
150
151 if (IsBridgeAbove(tile)) return_cmd_error(STR_ERROR_MUST_DEMOLISH_BRIDGE_FIRST);
152
153 return CommandCost();
154 }
155
156 extern void GetStationLayout(byte *layout, uint numtracks, uint plat_len, const StationSpec *statspec);
157 extern CommandCost FindJoiningWaypoint(StationID existing_station, StationID station_to_join, bool adjacent, TileArea ta, Waypoint **wp);
158 extern CommandCost CanExpandRailStation(const BaseStation *st, TileArea &new_ta, Axis axis);
159
177 CommandCost CmdBuildRailWaypoint(TileIndex start_tile, DoCommandFlag flags, uint32 p1, uint32 p2, const std::string &text)
178 {
179 /* Unpack parameters */
180 Axis axis = Extract<Axis, 6, 1>(p1);
181 byte width = GB(p1, 8, 8);
182 byte height = GB(p1, 16, 8);
183 bool adjacent = HasBit(p1, 24);
184
185 StationClassID spec_class = Extract<StationClassID, 0, 8>(p2);
186 byte spec_index = GB(p2, 8, 8);
187 StationID station_to_join = GB(p2, 16, 16);
188
189 /* Check if the given station class is valid */
190 if (spec_class != STAT_CLASS_WAYP) return CMD_ERROR;
191 if (spec_index >= StationClass::Get(spec_class)->GetSpecCount()) return CMD_ERROR;
192
193 /* The number of parts to build */
194 byte count = axis == AXIS_X ? height : width;
195
196 if ((axis == AXIS_X ? width : height) != 1) return CMD_ERROR;
197 if (count == 0 || count > _settings_game.station.station_spread) return CMD_ERROR;
198
199 bool reuse = (station_to_join != NEW_STATION);
200 if (!reuse) station_to_join = INVALID_STATION;
201 bool distant_join = (station_to_join != INVALID_STATION);
202
203 if (distant_join && (!_settings_game.station.distant_join_stations || !Waypoint::IsValidID(station_to_join))) return CMD_ERROR;
204
205 /* Make sure the area below consists of clear tiles. (OR tiles belonging to a certain rail station) */
206 StationID est = INVALID_STATION;
207
208 /* Check whether the tiles we're building on are valid rail or not. */
209 TileIndexDiff offset = TileOffsByDiagDir(AxisToDiagDir(OtherAxis(axis)));
210 for (int i = 0; i < count; i++) {
211 TileIndex tile = start_tile + i * offset;
212 CommandCost ret = IsValidTileForWaypoint(tile, axis, &est);
213 if (ret.Failed()) return ret;
214 }
215
216 Waypoint *wp = nullptr;
217 TileArea new_location(start_tile, width, height);
218 CommandCost ret = FindJoiningWaypoint(est, station_to_join, adjacent, new_location, &wp);
219 if (ret.Failed()) return ret;
220
221 /* Check if there is an already existing, deleted, waypoint close to us that we can reuse. */
222 TileIndex center_tile = start_tile + (count / 2) * offset;
223 if (wp == nullptr && reuse) wp = FindDeletedWaypointCloseTo(center_tile, STR_SV_STNAME_WAYPOINT, _current_company);
224
225 if (wp != nullptr) {
226 /* Reuse an existing waypoint. */
227 if (wp->owner != _current_company) return_cmd_error(STR_ERROR_TOO_CLOSE_TO_ANOTHER_WAYPOINT);
228
229 /* check if we want to expand an already existing waypoint? */
230 if (wp->train_station.tile != INVALID_TILE) {
231 CommandCost ret = CanExpandRailStation(wp, new_location, axis);
232 if (ret.Failed()) return ret;
233 }
234
235 CommandCost ret = wp->rect.BeforeAddRect(start_tile, width, height, StationRect::ADD_TEST);
236 if (ret.Failed()) return ret;
237 } else {
238 /* allocate and initialize new waypoint */
239 if (!Waypoint::CanAllocateItem()) return_cmd_error(STR_ERROR_TOO_MANY_STATIONS_LOADING);
240 }
241
242 if (flags & DC_EXEC) {
243 if (wp == nullptr) {
244 wp = new Waypoint(start_tile);
245 } else if (!wp->IsInUse()) {
246 /* Move existing (recently deleted) waypoint to the new location */
247 wp->xy = start_tile;
248 }
249 wp->owner = GetTileOwner(start_tile);
250
251 wp->rect.BeforeAddRect(start_tile, width, height, StationRect::ADD_TRY);
252
253 wp->delete_ctr = 0;
254 wp->facilities |= FACIL_TRAIN;
255 wp->build_date = _date;
256 wp->string_id = STR_SV_STNAME_WAYPOINT;
257 wp->train_station = new_location;
258
259 if (wp->town == nullptr) MakeDefaultName(wp);
260
261 wp->UpdateVirtCoord();
262
263 const StationSpec *spec = StationClass::Get(spec_class)->GetSpec(spec_index);
264 byte *layout_ptr = AllocaM(byte, count);
265 if (spec == nullptr) {
266 /* The layout must be 0 for the 'normal' waypoints by design. */
267 memset(layout_ptr, 0, count);
268 } else {
269 /* But for NewGRF waypoints we like to have their style. */
270 GetStationLayout(layout_ptr, count, 1, spec);
271 }
272 byte map_spec_index = AllocateSpecToStation(spec, wp, true);
273
274 Company *c = Company::Get(wp->owner);
275 for (int i = 0; i < count; i++) {
276 TileIndex tile = start_tile + i * offset;
277 byte old_specindex = HasStationTileRail(tile) ? GetCustomStationSpecIndex(tile) : 0;
278 if (!HasStationTileRail(tile)) c->infrastructure.station++;
279 bool reserved = IsTileType(tile, MP_RAILWAY) ?
280 HasBit(GetRailReservationTrackBits(tile), AxisToTrack(axis)) :
281 HasStationReservation(tile);
282 MakeRailWaypoint(tile, wp->owner, wp->index, axis, layout_ptr[i], GetRailType(tile));
283 SetCustomStationSpecIndex(tile, map_spec_index);
284 SetRailStationReservation(tile, reserved);
285 MarkTileDirtyByTile(tile);
286
287 DeallocateSpecFromStation(wp, old_specindex);
288 YapfNotifyTrackLayoutChange(tile, AxisToTrack(axis));
289 }
290 DirtyCompanyInfrastructureWindows(wp->owner);
291 }
292
293 return CommandCost(EXPENSES_CONSTRUCTION, count * _price[PR_BUILD_WAYPOINT_RAIL]);
294 }
295
305 CommandCost CmdBuildBuoy(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const std::string &text)
306 {
307 if (tile == 0 || !HasTileWaterGround(tile)) return_cmd_error(STR_ERROR_SITE_UNSUITABLE);
308 if (IsBridgeAbove(tile)) return_cmd_error(STR_ERROR_MUST_DEMOLISH_BRIDGE_FIRST);
309
310 if (!IsTileFlat(tile)) return_cmd_error(STR_ERROR_SITE_UNSUITABLE);
311
312 /* Check if there is an already existing, deleted, waypoint close to us that we can reuse. */
313 Waypoint *wp = FindDeletedWaypointCloseTo(tile, STR_SV_STNAME_BUOY, OWNER_NONE);
314 if (wp == nullptr && !Waypoint::CanAllocateItem()) return_cmd_error(STR_ERROR_TOO_MANY_STATIONS_LOADING);
315
316 CommandCost cost(EXPENSES_CONSTRUCTION, _price[PR_BUILD_WAYPOINT_BUOY]);
317 if (!IsWaterTile(tile)) {
318 CommandCost ret = DoCommand(tile, 0, 0, flags | DC_AUTO, CMD_LANDSCAPE_CLEAR);
319 if (ret.Failed()) return ret;
320 cost.AddCost(ret);
321 }
322
323 if (flags & DC_EXEC) {
324 if (wp == nullptr) {
325 wp = new Waypoint(tile);
326 } else {
327 /* Move existing (recently deleted) buoy to the new location */
328 wp->xy = tile;
329 InvalidateWindowData(WC_WAYPOINT_VIEW, wp->index);
330 }
331 wp->rect.BeforeAddTile(tile, StationRect::ADD_TRY);
332
333 wp->string_id = STR_SV_STNAME_BUOY;
334
335 wp->facilities |= FACIL_DOCK;
336 wp->owner = OWNER_NONE;
337
338 wp->build_date = _date;
339
340 if (wp->town == nullptr) MakeDefaultName(wp);
341
342 MakeBuoy(tile, wp->index, GetWaterClass(tile));
343 CheckForDockingTile(tile);
344 MarkTileDirtyByTile(tile);
345
346 wp->UpdateVirtCoord();
347 InvalidateWindowData(WC_WAYPOINT_VIEW, wp->index);
348 }
349
350 return cost;
351 }
352
360 CommandCost RemoveBuoy(TileIndex tile, DoCommandFlag flags)
361 {
362 /* XXX: strange stuff, allow clearing as invalid company when clearing landscape */
363 if (!Company::IsValidID(_current_company) && !(flags & DC_BANKRUPT)) return_cmd_error(INVALID_STRING_ID);
364
365 Waypoint *wp = Waypoint::GetByTile(tile);
366
367 if (HasStationInUse(wp->index, false, _current_company)) return_cmd_error(STR_ERROR_BUOY_IS_IN_USE);
368 /* remove the buoy if there is a ship on tile when company goes bankrupt... */
369 if (!(flags & DC_BANKRUPT)) {
370 CommandCost ret = EnsureNoVehicleOnGround(tile);
371 if (ret.Failed()) return ret;
372 }
373
374 if (flags & DC_EXEC) {
375 wp->facilities &= ~FACIL_DOCK;
376
377 InvalidateWindowData(WC_WAYPOINT_VIEW, wp->index);
378
379 /* We have to set the water tile's state to the same state as before the
380 * buoy was placed. Otherwise one could plant a buoy on a canal edge,
381 * remove it and flood the land (if the canal edge is at level 0) */
382 MakeWaterKeepingClass(tile, GetTileOwner(tile));
383
384 wp->rect.AfterRemoveTile(wp, tile);
385
386 wp->UpdateVirtCoord();
387 wp->delete_ctr = 0;
388 }
389
390 return CommandCost(EXPENSES_CONSTRUCTION, _price[PR_CLEAR_WAYPOINT_BUOY]);
391 }
392
398 static bool IsUniqueWaypointName(const std::string &name)
399 {
400 for (const Waypoint *wp : Waypoint::Iterate()) {
401 if (!wp->name.empty() && wp->name == name) return false;
402 }
403
404 return true;
405 }
406
416 CommandCost CmdRenameWaypoint(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const std::string &text)
417 {
418 Waypoint *wp = Waypoint::GetIfValid(p1);
419 if (wp == nullptr) return CMD_ERROR;
420
421 if (wp->owner != OWNER_NONE) {
422 CommandCost ret = CheckOwnership(wp->owner);
423 if (ret.Failed()) return ret;
424 }
425
426 bool reset = text.empty();
427
428 if (!reset) {
429 if (Utf8StringLength(text) >= MAX_LENGTH_STATION_NAME_CHARS) return CMD_ERROR;
430 if (!IsUniqueWaypointName(text)) return_cmd_error(STR_ERROR_NAME_MUST_BE_UNIQUE);
431 }
432
433 if (flags & DC_EXEC) {
434 if (reset) {
435 wp->name.clear();
436 } else {
437 wp->name = text;
438 }
439
440 wp->UpdateVirtCoord();
441 }
442 return CommandCost();
443 }
AllocateSpecToStation
int AllocateSpecToStation(const StationSpec *statspec, BaseStation *st, bool exec)
Allocate a StationSpec to a Station.
Definition: newgrf_station.cpp:680
IsTileFlat
bool IsTileFlat(TileIndex tile, int *h)
Check if a given tile is flat.
Definition: tile_map.cpp:100
ClearTile_Station
CommandCost ClearTile_Station(TileIndex tile, DoCommandFlag flags)
Clear a single tile of a station.
Definition: station_cmd.cpp:4301
IsValidTileForWaypoint
static CommandCost IsValidTileForWaypoint(TileIndex tile, Axis axis, StationID *waypoint)
Check whether the given tile is suitable for a waypoint.
Definition: waypoint_cmd.cpp:120
BaseStation::facilities
StationFacility facilities
The facilities that this station has.
Definition: base_station_base.h:63
TileIndex
uint32 TileIndex
The index/ID of a Tile.
Definition: tile_type.h:83
CmdBuildRailWaypoint
CommandCost CmdBuildRailWaypoint(TileIndex start_tile, DoCommandFlag flags, uint32 p1, uint32 p2, const std::string &text)
Convert existing rail to waypoint.
Definition: waypoint_cmd.cpp:177
InvalidateWindowData
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:3234
Waypoint::MoveSign
void MoveSign(TileIndex new_xy) override
Move the waypoint main coordinate somewhere else.
Definition: waypoint_cmd.cpp:57
newgrf_station.h
DoCommand
CommandCost DoCommand(const CommandContainer *container, DoCommandFlag flags)
Shorthand for calling the long DoCommand with a container.
Definition: command.cpp:450
Pool::PoolItem<&_company_pool >::Get
static Titem * Get(size_t index)
Returns Titem with given index.
Definition: pool_type.hpp:337
TileOffsByDiagDir
static TileIndexDiff TileOffsByDiagDir(DiagDirection dir)
Convert a DiagDirection to a TileIndexDiff.
Definition: map_func.h:341
GameSettings::station
StationSettings station
settings related to station management
Definition: settings_type.h:588
water.h
GB
static uint GB(const T x, const uint8 s, const uint8 n)
Fetch n bits from x, started at bit s.
Definition: bitmath_func.hpp:32
command_func.h
YapfNotifyTrackLayoutChange
void YapfNotifyTrackLayoutChange(TileIndex tile, Track track)
Use this function to notify YAPF that track layout (or signal configuration) has change.
Definition: yapf_rail.cpp:640
IsRailWaypointTile
static bool IsRailWaypointTile(TileIndex t)
Is this tile a station tile and a rail waypoint?
Definition: station_map.h:123
CMD_ERROR
static const CommandCost CMD_ERROR
Define a default return value for a failed command.
Definition: command_func.h:23
CanExpandRailStation
CommandCost CanExpandRailStation(const BaseStation *st, TileArea &new_ta, Axis axis)
Check whether we can expand the rail part of the given station.
Definition: station_cmd.cpp:1074
CmdBuildBuoy
CommandCost CmdBuildBuoy(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const std::string &text)
Build a buoy.
Definition: waypoint_cmd.cpp:305
company_base.h
BaseStation::town
Town * town
The town this station is associated with.
Definition: base_station_base.h:61
SetCustomStationSpecIndex
static void SetCustomStationSpecIndex(TileIndex t, byte specindex)
Set the custom station spec for this tile.
Definition: station_map.h:481
GetAxisForNewWaypoint
Axis GetAxisForNewWaypoint(TileIndex tile)
Get the axis for a new waypoint.
Definition: waypoint_cmd.cpp:97
company_gui.h
OtherAxis
static Axis OtherAxis(Axis a)
Select the other axis as provided.
Definition: direction_func.h:197
SetRailStationReservation
static void SetRailStationReservation(TileIndex t, bool b)
Set the reservation state of the rail station.
Definition: station_map.h:405
Pool::PoolItem<&_station_pool >::index
Tindex index
Index of this pool item.
Definition: pool_type.hpp:235
FindDeletedWaypointCloseTo
static Waypoint * FindDeletedWaypointCloseTo(TileIndex tile, StringID str, CompanyID cid)
Find a deleted waypoint close to a tile.
Definition: waypoint_cmd.cpp:71
HasBit
static bool HasBit(const T x, const uint8 y)
Checks if a bit in a value is set.
Definition: bitmath_func.hpp:103
FindJoiningWaypoint
CommandCost FindJoiningWaypoint(StationID existing_station, StationID station_to_join, bool adjacent, TileArea ta, Waypoint **wp)
Find a nearby waypoint that joins this waypoint.
Definition: station_cmd.cpp:1214
CompanyInfrastructure::station
uint32 station
Count of company owned station tiles.
Definition: company_base.h:35
Waypoint
Representation of a waypoint.
Definition: waypoint_base.h:16
MP_RAILWAY
@ MP_RAILWAY
A railway.
Definition: tile_type.h:47
TILE_SIZE
static const uint TILE_SIZE
Tile size in world coordinates.
Definition: tile_type.h:13
GetTrackBits
static TrackBits GetTrackBits(TileIndex tile)
Gets the track bits of the given tile.
Definition: rail_map.h:136
CmdRenameWaypoint
CommandCost CmdRenameWaypoint(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const std::string &text)
Rename a waypoint.
Definition: waypoint_cmd.cpp:416
SpecializedStation< Waypoint, true >::IsValidID
static bool IsValidID(size_t index)
Tests whether given index is a valid index for station of this type.
Definition: base_station_base.h:210
town.h
TileY
static uint TileY(TileIndex tile)
Get the Y component of a tile.
Definition: map_func.h:215
GetStationLayout
void GetStationLayout(byte *layout, uint numtracks, uint plat_len, const StationSpec *statspec)
Create the station layout for the given number of tracks and platform length.
Definition: station_cmd.cpp:1119
Company::infrastructure
CompanyInfrastructure infrastructure
NOSAVE: Counts of company owned infrastructure.
Definition: company_base.h:128
Owner
Owner
Enum for all companies/owners.
Definition: company_type.h:18
DC_EXEC
@ DC_EXEC
execute the given command
Definition: command_type.h:348
DeallocateSpecFromStation
void DeallocateSpecFromStation(BaseStation *st, byte specindex)
Deallocate a StationSpec from a Station.
Definition: newgrf_station.cpp:733
BaseStation::owner
Owner owner
The owner of this station.
Definition: base_station_base.h:62
SetDParam
static void SetDParam(uint n, uint64 v)
Set a string parameter v at index n in the global string parameter array.
Definition: strings_func.h:196
DoCommandFlag
DoCommandFlag
List of flags for a command.
Definition: command_type.h:346
EnsureNoVehicleOnGround
CommandCost EnsureNoVehicleOnGround(TileIndex tile)
Ensure there is no vehicle at the ground at the given position.
Definition: vehicle.cpp:539
CommandCost::Succeeded
bool Succeeded() const
Did this command succeed?
Definition: command_type.h:150
TileX
static uint TileX(TileIndex tile)
Get the X component of a tile.
Definition: map_func.h:205
GetRailReservationTrackBits
static TrackBits GetRailReservationTrackBits(TileIndex t)
Returns the reserved track bits of the tile.
Definition: rail_map.h:194
Kdtree::Remove
void Remove(const T &element)
Remove a single element from the tree, if it exists.
Definition: kdtree.hpp:419
BaseStation::string_id
StringID string_id
Default name (town area) of station.
Definition: base_station_base.h:58
SpecializedStation< Waypoint, true >::Iterate
static Pool::IterateWrapper< Waypoint > Iterate(size_t from=0)
Returns an iterable ensemble of all valid stations of type T.
Definition: base_station_base.h:270
MakeRailWaypoint
static void MakeRailWaypoint(TileIndex t, Owner o, StationID sid, Axis a, byte section, RailType rt)
Make the given tile a rail waypoint tile.
Definition: station_map.h:573
SLOPE_FLAT
@ SLOPE_FLAT
a flat tile
Definition: slope_type.h:49
MakeBuoy
static void MakeBuoy(TileIndex t, StationID sid, WaterClass wc)
Make the given tile a buoy tile.
Definition: station_map.h:637
Waypoint::UpdateVirtCoord
void UpdateVirtCoord() override
Update the virtual coords needed to draw the waypoint sign.
Definition: waypoint_cmd.cpp:39
Utf8StringLength
size_t Utf8StringLength(const char *s)
Get the length of an UTF-8 encoded string in number of characters and thus not the number of bytes th...
Definition: string.cpp:417
DistanceManhattan
uint DistanceManhattan(TileIndex t0, TileIndex t1)
Gets the Manhattan distance between the two given tiles.
Definition: map.cpp:157
CheckForDockingTile
void CheckForDockingTile(TileIndex t)
Mark the supplied tile as a docking tile if it is suitable for docking.
Definition: water_cmd.cpp:182
CheckOwnership
CommandCost CheckOwnership(Owner owner, TileIndex tile)
Check whether the current owner owns something.
Definition: company_cmd.cpp:311
AXIS_Y
@ AXIS_Y
The y axis.
Definition: direction_type.h:125
return_cmd_error
#define return_cmd_error(errcode)
Returns from a function with a specific StringID as error.
Definition: command_func.h:33
EXPENSES_CONSTRUCTION
@ EXPENSES_CONSTRUCTION
Construction costs.
Definition: economy_type.h:158
BaseStation::sign
TrackedViewportSign sign
NOSAVE: Dimensions of sign.
Definition: base_station_base.h:54
STAT_CLASS_WAYP
@ STAT_CLASS_WAYP
Waypoint class.
Definition: newgrf_station.h:86
IsSteepSlope
static bool IsSteepSlope(Slope s)
Checks if a slope is steep.
Definition: slope_func.h:36
CommandCost
Common return value for all commands.
Definition: command_type.h:23
GetCustomStationSpecIndex
static uint GetCustomStationSpecIndex(TileIndex t)
Get the custom station spec for this tile.
Definition: station_map.h:493
HasTileWaterGround
static bool HasTileWaterGround(TileIndex t)
Checks whether the tile has water at the ground.
Definition: water_map.h:344
cmd_helper.h
_date
Date _date
Current date in days (day counter)
Definition: date.cpp:28
AxisToTrack
static 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:65
BaseStation::train_station
TileArea train_station
Tile area the train 'station' part covers.
Definition: base_station_base.h:75
DirtyCompanyInfrastructureWindows
void DirtyCompanyInfrastructureWindows(CompanyID company)
Redraw all windows with company infrastructure counts.
Definition: company_gui.cpp:2709
BaseStation::rect
StationRect rect
NOSAVE: Station spread out rectangle maintained by StationRect::xxx() functions.
Definition: base_station_base.h:76
GetRailTileType
static RailTileType GetRailTileType(TileIndex t)
Returns the RailTileType (normal with or without signals, waypoint or depot).
Definition: rail_map.h:36
TileIndexDiff
int32 TileIndexDiff
An offset value between to tiles.
Definition: map_func.h:154
Kdtree::Insert
void Insert(const T &element)
Insert a single element in the tree.
Definition: kdtree.hpp:400
CommandCost::Failed
bool Failed() const
Did this command fail?
Definition: command_type.h:159
OrthogonalTileArea
Represents the covered area of e.g.
Definition: tilearea_type.h:18
_settings_game
GameSettings _settings_game
Game settings of a running game or the scenario editor.
Definition: settings.cpp:53
TRACK_BIT_X
@ TRACK_BIT_X
X-axis track.
Definition: track_type.h:40
HasStationTileRail
static bool HasStationTileRail(TileIndex t)
Has this station tile a rail? In other words, is this station tile a rail station or rail waypoint?
Definition: station_map.h:146
safeguards.h
WC_WAYPOINT_VIEW
@ WC_WAYPOINT_VIEW
Waypoint view; Window numbers:
Definition: window_type.h:349
GetTileSlope
Slope GetTileSlope(TileIndex tile, int *h)
Return the slope of a given tile inside the map.
Definition: tile_map.cpp:59
HasStationReservation
static bool HasStationReservation(TileIndex t)
Get the reservation state of the rail station.
Definition: station_map.h:393
BaseStation::name
std::string name
Custom name.
Definition: base_station_base.h:57
RemoveBuoy
CommandCost RemoveBuoy(TileIndex tile, DoCommandFlag flags)
Remove a buoy.
Definition: waypoint_cmd.cpp:360
Point
Coordinates of a point in 2D.
Definition: geometry_type.hpp:21
Slope
Slope
Enumeration for the slope-type.
Definition: slope_type.h:48
FACIL_DOCK
@ FACIL_DOCK
Station with a dock.
Definition: station_type.h:56
StationSettings::station_spread
byte station_spread
amount a station may spread
Definition: settings_type.h:553
date_func.h
CommandCost::AddCost
void AddCost(const Money &cost)
Adds the given cost to the cost of the command.
Definition: command_type.h:62
stdafx.h
landscape.h
DC_BANKRUPT
@ DC_BANKRUPT
company bankrupts, skip money check, skip vehicle on tile check in some cases
Definition: command_type.h:354
viewport_func.h
AxisToDiagDir
static DiagDirection AxisToDiagDir(Axis a)
Converts an Axis to a DiagDirection.
Definition: direction_func.h:232
bridge_map.h
IsTileType
static bool IsTileType(TileIndex tile, TileType type)
Checks if a tile is a given tiletype.
Definition: tile_map.h:150
GetTileOwner
static Owner GetTileOwner(TileIndex tile)
Returns the owner of a tile.
Definition: tile_map.h:178
yapf_cache.h
MAX_LENGTH_STATION_NAME_CHARS
static const uint MAX_LENGTH_STATION_NAME_CHARS
The maximum length of a station name in characters including '\0'.
Definition: station_type.h:87
string_func.h
MakeDefaultName
void MakeDefaultName(T *obj)
Set the default name for a depot/waypoint.
Definition: town.h:239
StringID
uint32 StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:16
_current_company
CompanyID _current_company
Company currently doing an action.
Definition: company_cmd.cpp:47
vehicle_func.h
strings_func.h
StationSpec
Station specification.
Definition: newgrf_station.h:113
GetWaterClass
static WaterClass GetWaterClass(TileIndex t)
Get the water class at a tile.
Definition: water_map.h:106
IsRailWaypoint
static bool IsRailWaypoint(TileIndex t)
Is this station tile a rail waypoint?
Definition: station_map.h:113
FACIL_TRAIN
@ FACIL_TRAIN
Station with train station.
Definition: station_type.h:52
TrackedViewportSign::UpdatePosition
void UpdatePosition(int center, int top, StringID str, StringID str_small=STR_NULL)
Update the position of the viewport sign.
Definition: viewport_type.h:64
GetRailStationAxis
static Axis GetRailStationAxis(TileIndex t)
Get the rail direction of a rail station.
Definition: station_map.h:337
IsWaterTile
static bool IsWaterTile(TileIndex t)
Is it a water tile with plain water?
Definition: water_map.h:184
OrthogonalTileArea::tile
TileIndex tile
The base tile of the area.
Definition: tilearea_type.h:19
ConstructionSettings::build_on_slopes
bool build_on_slopes
allow building on slopes
Definition: settings_type.h:335
MarkTileDirtyByTile
void MarkTileDirtyByTile(TileIndex tile, int bridge_level_offset, int tile_height_override)
Mark a tile given by its index dirty for repaint.
Definition: viewport.cpp:1987
OWNER_NONE
@ OWNER_NONE
The tile has no ownership.
Definition: company_type.h:25
GetRailType
static RailType GetRailType(TileIndex t)
Gets the rail type of the given tile.
Definition: rail_map.h:115
IsUniqueWaypointName
static bool IsUniqueWaypointName(const std::string &name)
Check whether the name is unique amongst the waypoints.
Definition: waypoint_cmd.cpp:398
MP_STATION
@ MP_STATION
A tile of a station.
Definition: tile_type.h:51
SpecializedStation< Waypoint, true >::GetByTile
static Waypoint * GetByTile(TileIndex tile)
Get the station belonging to a specific tile.
Definition: base_station_base.h:238
GetStationIndex
static StationID GetStationIndex(TileIndex t)
Get StationID from a tile.
Definition: station_map.h:28
waypoint_base.h
StationClassID
StationClassID
Definition: newgrf_station.h:83
TrackedViewportSign::kdtree_valid
bool kdtree_valid
Are the sign data valid for use with the _viewport_sign_kdtree?
Definition: viewport_type.h:58
RAIL_TILE_NORMAL
@ RAIL_TILE_NORMAL
Normal rail tile without signals.
Definition: rail_map.h:24
Pool::PoolItem<&_station_pool >::CanAllocateItem
static bool CanAllocateItem(size_t n=1)
Helper functions so we can use PoolItem::Function() instead of _poolitem_pool.Function()
Definition: pool_type.hpp:307
DC_AUTO
@ DC_AUTO
don't allow building on structures
Definition: command_type.h:349
BaseStation::xy
TileIndex xy
Base tile of the station.
Definition: base_station_base.h:53
BaseStation
Base class for all station-ish types.
Definition: base_station_base.h:52
HasStationInUse
bool HasStationInUse(StationID station, bool include_company, CompanyID company)
Tests whether the company's vehicles have this station in orders.
Definition: station_cmd.cpp:2493
company_func.h
BaseStation::delete_ctr
byte delete_ctr
Delete counter. If greater than 0 then it is decremented until it reaches 0; the waypoint is then is ...
Definition: base_station_base.h:55
StationSettings::distant_join_stations
bool distant_join_stations
allow to join non-adjacent stations
Definition: settings_type.h:551
window_func.h
NewGRFClass::Get
static NewGRFClass * Get(Tid cls_id)
Get a particular class.
Definition: newgrf_class_func.h:103
SpecializedStation< Waypoint, true >::GetIfValid
static Waypoint * GetIfValid(size_t index)
Returns station if the index is a valid index for this station type.
Definition: base_station_base.h:228
INVALID_TILE
static const TileIndex INVALID_TILE
The very nice invalid tile marker.
Definition: tile_type.h:88
Axis
Axis
Allow incrementing of DiagDirDiff variables.
Definition: direction_type.h:123
BaseStation::IsInUse
bool IsInUse() const
Check whether the base station currently is in use; in use means that it is not scheduled for deletio...
Definition: base_station_base.h:166
TRACK_BIT_Y
@ TRACK_BIT_Y
Y-axis track.
Definition: track_type.h:41
GameSettings::construction
ConstructionSettings construction
construction of things in-game
Definition: settings_type.h:578
Pool::PoolItem<&_company_pool >::IsValidID
static bool IsValidID(size_t index)
Tests whether given index can be used to get valid (non-nullptr) Titem.
Definition: pool_type.hpp:326
INVALID_AXIS
@ INVALID_AXIS
Flag for an invalid Axis.
Definition: direction_type.h:127
RemapCoords2
static 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:98
Company
Definition: company_base.h:115
BaseStation::build_date
Date build_date
Date of construction.
Definition: base_station_base.h:68
CMD_LANDSCAPE_CLEAR
@ CMD_LANDSCAPE_CLEAR
demolish a tile
Definition: command_type.h:180
INVALID_STRING_ID
static const StringID INVALID_STRING_ID
Constant representing an invalid string (16bit in case it is used in savegames)
Definition: strings_type.h:17
IsBridgeAbove
static bool IsBridgeAbove(TileIndex t)
checks if a bridge is set above the ground of this tile
Definition: bridge_map.h:45
AllocaM
#define AllocaM(T, num_elements)
alloca() has to be called in the parent function, so define AllocaM() as a macro
Definition: alloc_func.hpp:132
AXIS_X
@ AXIS_X
The X axis.
Definition: direction_type.h:124