OpenTTD Source  20241108-master-g80f628063a
station_cmd.cpp File Reference

Handling of station tiles. More...

#include "stdafx.h"
#include "aircraft.h"
#include "bridge_map.h"
#include "vehiclelist_func.h"
#include "viewport_func.h"
#include "viewport_kdtree.h"
#include "command_func.h"
#include "town.h"
#include "news_func.h"
#include "train.h"
#include "ship.h"
#include "roadveh.h"
#include "industry.h"
#include "newgrf_cargo.h"
#include "newgrf_debug.h"
#include "newgrf_station.h"
#include "newgrf_canal.h"
#include "pathfinder/yapf/yapf_cache.h"
#include "road_internal.h"
#include "autoslope.h"
#include "water.h"
#include "strings_internal.h"
#include "clear_func.h"
#include "timer/timer_game_calendar.h"
#include "vehicle_func.h"
#include "string_func.h"
#include "animated_tile_func.h"
#include "elrail_func.h"
#include "station_base.h"
#include "station_func.h"
#include "station_kdtree.h"
#include "roadstop_base.h"
#include "newgrf_railtype.h"
#include "newgrf_roadtype.h"
#include "waypoint_base.h"
#include "waypoint_func.h"
#include "pbs.h"
#include "debug.h"
#include "core/random_func.hpp"
#include "core/container_func.hpp"
#include "company_base.h"
#include "table/airporttile_ids.h"
#include "newgrf_airporttiles.h"
#include "order_backup.h"
#include "newgrf_house.h"
#include "company_gui.h"
#include "linkgraph/linkgraph_base.h"
#include "linkgraph/refresh.h"
#include "tunnelbridge_map.h"
#include "station_cmd.h"
#include "waypoint_cmd.h"
#include "landscape_cmd.h"
#include "rail_cmd.h"
#include "newgrf_roadstop.h"
#include "timer/timer.h"
#include "timer/timer_game_economy.h"
#include "timer/timer_game_tick.h"
#include "cheat_type.h"
#include "road_func.h"
#include "widgets/station_widget.h"
#include "table/strings.h"
#include <bitset>
#include "safeguards.h"
#include "table/station_land.h"

Go to the source code of this file.

Data Structures

struct  StationNameInformation
 Information to handle station action 0 property 24 correctly. More...
 

Macros

#define M(x)   ((x) - STR_SV_STNAME)
 

Typedefs

typedef bool(* CMSAMatcher) (TileIndex tile)
 Function to check whether the given tile matches some criterion. More...
 

Enumerations

enum  StationNaming {
  STATIONNAMING_RAIL , STATIONNAMING_ROAD , STATIONNAMING_AIRPORT , STATIONNAMING_OILRIG ,
  STATIONNAMING_DOCK , STATIONNAMING_HELIPORT
}
 

Functions

bool IsHangar (Tile t)
 Check whether the given tile is a hangar. More...
 
template<class T , class F >
CommandCost GetStationAround (TileArea ta, StationID closest_station, CompanyID company, T **st, F filter)
 Look for a station owned by the given company around the given tile area. More...
 
static int CountMapSquareAround (TileIndex tile, CMSAMatcher cmp)
 Counts the numbers of tiles matching a specific type in the area around. More...
 
static bool CMSAMine (TileIndex tile)
 Check whether the tile is a mine. More...
 
static bool CMSAWater (TileIndex tile)
 Check whether the tile is water. More...
 
static bool CMSATree (TileIndex tile)
 Check whether the tile is a tree. More...
 
static bool FindNearIndustryName (TileIndex tile, void *user_data)
 Find a station action 0 property 24 station name, or reduce the free_names if needed. More...
 
static StringID GenerateStationName (Station *st, TileIndex tile, StationNaming name_class)
 
static StationGetClosestDeletedStation (TileIndex tile)
 Find the closest deleted station of the current company. More...
 
void UpdateAllStationVirtCoords ()
 Update the virtual coords needed to draw the station sign for all stations.
 
void ClearAllStationCachedNames ()
 
CargoTypes GetAcceptanceMask (const Station *st)
 Get a mask of the cargo types that the station accepts. More...
 
CargoTypes GetEmptyMask (const Station *st)
 Get a mask of the cargo types that are empty at the station. More...
 
static void ShowRejectOrAcceptNews (const Station *st, CargoTypes cargoes, bool reject)
 Add news item for when a station changes which cargoes it accepts. More...
 
CargoArray GetProductionAroundTiles (TileIndex north_tile, int w, int h, int rad)
 Get the cargo types being produced around the tile (in a rectangle). More...
 
CargoArray GetAcceptanceAroundTiles (TileIndex center_tile, int w, int h, int rad, CargoTypes *always_accepted)
 Get the acceptance of cargoes around the tile in 1/8. More...
 
static CargoArray GetAcceptanceAroundStation (const Station *st, CargoTypes *always_accepted)
 Get the acceptance of cargoes around the station in. More...
 
void UpdateStationAcceptance (Station *st, bool show_msg)
 Update the acceptance for a station. More...
 
static void UpdateStationSignCoord (BaseStation *st)
 
static CommandCost BuildStationPart (Station **st, DoCommandFlag flags, bool reuse, TileArea area, StationNaming name_class)
 Common part of building various station parts and possibly attaching them to an existing one. More...
 
static void DeleteStationIfEmpty (BaseStation *st)
 This is called right after a station was deleted. More...
 
CommandCost ClearTile_Station (TileIndex tile, DoCommandFlag flags)
 Clear a single tile of a station. More...
 
CommandCost CheckBuildableTile (TileIndex tile, uint invalid_dirs, int &allowed_z, bool allow_steep, bool check_bridge=true)
 Checks if the given tile is buildable, flat and has a certain height. More...
 
static CommandCost CheckFlatLandAirport (AirportTileTableIterator tile_iter, DoCommandFlag flags)
 Checks if an airport can be built at the given location and clear the area. More...
 
static CommandCost CheckFlatLandRailStation (TileIndex tile_cur, TileIndex north_tile, int &allowed_z, DoCommandFlag flags, Axis axis, StationID *station, RailType rt, std::vector< Train * > &affected_vehicles, StationClassID spec_class, uint16_t spec_index, uint8_t plat_len, uint8_t numtracks)
 Checks if a rail station can be built at the given tile. More...
 
CommandCost CheckFlatLandRoadStop (TileIndex cur_tile, int &allowed_z, DoCommandFlag flags, uint invalid_dirs, bool is_drive_through, StationType station_type, Axis axis, StationID *station, RoadType rt)
 Checks if a road stop can be built at the given tile. More...
 
CommandCost CanExpandRailStation (const BaseStation *st, TileArea &new_ta)
 Check whether we can expand the rail part of the given station. More...
 
static uint8_t * CreateSingle (uint8_t *layout, int n)
 
static uint8_t * CreateMulti (uint8_t *layout, int n, uint8_t b)
 
void GetStationLayout (uint8_t *layout, uint numtracks, uint plat_len, const StationSpec *statspec)
 Create the station layout for the given number of tracks and platform length. More...
 
template<class T , StringID error_message, class F >
CommandCost FindJoiningBaseStation (StationID existing_station, StationID station_to_join, bool adjacent, TileArea ta, T **st, F filter)
 Find a nearby station that joins this station. More...
 
static CommandCost FindJoiningStation (StationID existing_station, StationID station_to_join, bool adjacent, TileArea ta, Station **st)
 Find a nearby station that joins this station. More...
 
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. More...
 
static void FreeTrainReservation (Train *v)
 Clear platform reservation during station building/removing. More...
 
static void RestoreTrainReservation (Train *v)
 Restore platform reservation during station building/removing. More...
 
static CommandCost CalculateRailStationCost (TileArea tile_area, DoCommandFlag flags, Axis axis, StationID *station, RailType rt, std::vector< Train * > &affected_vehicles, StationClassID spec_class, uint16_t spec_index, uint8_t plat_len, uint8_t numtracks)
 Calculates cost of new rail stations within the area. More...
 
static StationSpec::TileFlags GetStationTileFlags (StationGfx gfx, const StationSpec *statspec)
 Get station tile flags for the given StationGfx. More...
 
void SetRailStationTileFlags (TileIndex tile, const StationSpec *statspec)
 Set rail station tile flags for the given tile. More...
 
CommandCost CmdBuildRailStation (DoCommandFlag flags, TileIndex tile_org, RailType rt, Axis axis, uint8_t numtracks, uint8_t plat_len, StationClassID spec_class, uint16_t spec_index, StationID station_to_join, bool adjacent)
 Build rail station. More...
 
static TileArea MakeStationAreaSmaller (BaseStation *st, TileArea ta, bool(*func)(BaseStation *, TileIndex))
 
static bool TileBelongsToRailStation (BaseStation *st, TileIndex tile)
 
static void MakeRailStationAreaSmaller (BaseStation *st)
 
static bool TileBelongsToShipStation (BaseStation *st, TileIndex tile)
 
static void MakeShipStationAreaSmaller (Station *st)
 
static bool TileBelongsToRoadWaypointStation (BaseStation *st, TileIndex tile)
 
void MakeRoadWaypointStationAreaSmaller (BaseStation *st, TileArea &road_waypoint_area)
 
template<class T >
CommandCost RemoveFromRailBaseStation (TileArea ta, std::vector< T * > &affected_stations, DoCommandFlag flags, Money removal_cost, bool keep_rail)
 Remove a number of tiles from any rail station within the area. More...
 
CommandCost CmdRemoveFromRailStation (DoCommandFlag flags, TileIndex start, TileIndex end, bool keep_rail)
 Remove a single tile from a rail station. More...
 
CommandCost CmdRemoveFromRailWaypoint (DoCommandFlag flags, TileIndex start, TileIndex end, bool keep_rail)
 Remove a single tile from a waypoint. More...
 
template<class T >
CommandCost RemoveRailStation (T *st, DoCommandFlag flags, Money removal_cost)
 Remove a rail station/waypoint. More...
 
static CommandCost RemoveRailStation (TileIndex tile, DoCommandFlag flags)
 Remove a rail station. More...
 
static CommandCost RemoveRailWaypoint (TileIndex tile, DoCommandFlag flags)
 Remove a rail waypoint. More...
 
static RoadStop ** FindRoadStopSpot (bool truck_station, Station *st)
 
static CommandCost RemoveRoadStop (TileIndex tile, DoCommandFlag flags, int replacement_spec_index)
 Remove a bus station/truck stop. More...
 
CommandCost RemoveRoadWaypointStop (TileIndex tile, DoCommandFlag flags, int replacement_spec_index)
 Remove a road waypoint. More...
 
static CommandCost FindJoiningRoadStop (StationID existing_stop, StationID station_to_join, bool adjacent, TileArea ta, Station **st)
 Find a nearby station that joins this road stop. More...
 
CommandCost CalculateRoadStopCost (TileArea tile_area, DoCommandFlag flags, bool is_drive_through, StationType station_type, Axis axis, DiagDirection ddir, StationID *est, RoadType rt, Money unit_cost)
 Calculates cost of new road stops within the area. More...
 
CommandCost CmdBuildRoadStop (DoCommandFlag flags, TileIndex tile, uint8_t width, uint8_t length, RoadStopType stop_type, bool is_drive_through, DiagDirection ddir, RoadType rt, RoadStopClassID spec_class, uint16_t spec_index, StationID station_to_join, bool adjacent)
 Build a bus or truck stop. More...
 
static VehicleClearRoadStopStatusEnum (Vehicle *v, void *)
 
static CommandCost RemoveGenericRoadStop (DoCommandFlag flags, const TileArea &roadstop_area, StationType station_type, bool remove_road)
 Remove a tile area of road stop or road waypoints. More...
 
CommandCost CmdRemoveRoadStop (DoCommandFlag flags, TileIndex tile, uint8_t width, uint8_t height, RoadStopType stop_type, bool remove_road)
 Remove bus or truck stops. More...
 
CommandCost CmdRemoveFromRoadWaypoint (DoCommandFlag flags, TileIndex start, TileIndex end)
 Remove road waypoints. More...
 
uint8_t GetAirportNoiseLevelForDistance (const AirportSpec *as, uint distance)
 Get a possible noise reduction factor based on distance from town center. More...
 
TownAirportGetNearestTown (const AirportSpec *as, Direction rotation, TileIndex tile, TileIterator &&it, uint &mindist)
 Finds the town nearest to given airport. More...
 
static TownAirportGetNearestTown (const Station *st, uint &mindist)
 Finds the town nearest to given existing airport. More...
 
void UpdateAirportsNoise ()
 Recalculate the noise generated by the airports of each town.
 
CommandCost CmdBuildAirport (DoCommandFlag flags, TileIndex tile, uint8_t airport_type, uint8_t layout, StationID station_to_join, bool allow_adjacent)
 Place an Airport. More...
 
static CommandCost RemoveAirport (TileIndex tile, DoCommandFlag flags)
 Remove an airport. More...
 
CommandCost CmdOpenCloseAirport (DoCommandFlag flags, StationID station_id)
 Open/close an airport to incoming aircraft. More...
 
bool HasStationInUse (StationID station, bool include_company, CompanyID company)
 Tests whether the company's vehicles have this station in orders. More...
 
CommandCost CmdBuildDock (DoCommandFlag flags, TileIndex tile, StationID station_to_join, bool adjacent)
 Build a dock/haven. More...
 
void RemoveDockingTile (TileIndex t)
 
void ClearDockingTilesCheckingNeighbours (TileIndex tile)
 Clear docking tile status from tiles around a removed dock, if the tile has no neighbours which would keep it as a docking tile. More...
 
static TileIndex FindDockLandPart (TileIndex t)
 Find the part of a dock that is land-based. More...
 
static CommandCost RemoveDock (TileIndex tile, DoCommandFlag flags)
 Remove a dock. More...
 
const DrawTileSpritesGetStationTileLayout (StationType st, uint8_t gfx)
 Get station tile layout for a station type and its station gfx. More...
 
bool SplitGroundSpriteForOverlay (const TileInfo *ti, SpriteID *ground, RailTrackOffset *overlay_offset)
 Check whether a sprite is a track sprite, which can be replaced by a non-track ground sprite and a rail overlay. More...
 
static void DrawTile_Station (TileInfo *ti)
 
void StationPickerDrawSprite (int x, int y, StationType st, RailType railtype, RoadType roadtype, int image)
 
static int GetSlopePixelZ_Station (TileIndex tile, uint, uint, bool)
 
static Foundation GetFoundation_Station (TileIndex, Slope tileh)
 
static void FillTileDescRoadStop (TileIndex tile, TileDesc *td)
 
void FillTileDescRailStation (TileIndex tile, TileDesc *td)
 
void FillTileDescAirport (TileIndex tile, TileDesc *td)
 
static void GetTileDesc_Station (TileIndex tile, TileDesc *td)
 
static TrackStatus GetTileTrackStatus_Station (TileIndex tile, TransportType mode, uint sub_mode, DiagDirection side)
 
static void TileLoop_Station (TileIndex tile)
 
static void AnimateTile_Station (TileIndex tile)
 
static bool ClickTile_Station (TileIndex tile)
 
static VehicleEnterTileStatus VehicleEnter_Station (Vehicle *v, TileIndex tile, int x, int y)
 
void TriggerWatchedCargoCallbacks (Station *st)
 Run the watched cargo callback for all houses in the catchment area. More...
 
static bool StationHandleBigTick (BaseStation *st)
 This function is called for each station once every 250 ticks. More...
 
static void byte_inc_sat (uint8_t *p)
 
static void TruncateCargo (const CargoSpec *cs, GoodsEntry *ge, uint amount=UINT_MAX)
 Truncate the cargo by a specific amount. More...
 
static void UpdateStationRating (Station *st)
 
void RerouteCargo (Station *st, CargoID c, StationID avoid, StationID avoid2)
 Reroute cargo of type c at station st or in any vehicles unloading there. More...
 
void DeleteStaleLinks (Station *from)
 Check all next hops of cargo packets in this station for existence of a a valid link they may use to travel on. More...
 
void IncreaseStats (Station *st, CargoID cargo, StationID next_station_id, uint capacity, uint usage, uint32_t time, EdgeUpdateMode mode)
 Increase capacity for a link stat given by station cargo and next hop. More...
 
void IncreaseStats (Station *st, const Vehicle *front, StationID next_station_id, uint32_t time)
 Increase capacity for all link stats associated with vehicles in the given consist. More...
 
static void StationHandleSmallTick (BaseStation *st)
 
void OnTick_Station ()
 
void ModifyStationRatingAround (TileIndex tile, Owner owner, int amount, uint radius)
 
static uint UpdateStationWaiting (Station *st, CargoID type, uint amount, SourceType source_type, SourceID source_id)
 
static bool IsUniqueStationName (const std::string &name)
 
CommandCost CmdRenameStation (DoCommandFlag flags, StationID station_id, const std::string &text)
 Rename a station. More...
 
static void AddNearbyStationsByCatchment (TileIndex tile, StationList *stations, StationList &nearby)
 
static bool CanMoveGoodsToStation (const Station *st, CargoID type)
 
uint MoveGoodsToStation (CargoID type, uint amount, SourceType source_type, SourceID source_id, const StationList *all_stations, Owner exclusivity)
 
void UpdateStationDockingTiles (Station *st)
 
void BuildOilRig (TileIndex tile)
 
void DeleteOilRig (TileIndex tile)
 
static void ChangeTileOwner_Station (TileIndex tile, Owner old_owner, Owner new_owner)
 
static CommandCost CanRemoveRoadWithStop (TileIndex tile, DoCommandFlag flags)
 Check if a drive-through road stop tile can be cleared. More...
 
static CommandCost TerraformTile_Station (TileIndex tile, DoCommandFlag flags, int z_new, Slope tileh_new)
 

Variables

static const TileIndexDiffC _dock_tileoffs_chkaround []
 
static const uint8_t _dock_w_chk [4] = { 2, 1, 2, 1 }
 
static const uint8_t _dock_h_chk [4] = { 1, 2, 1, 2 }
 
static IntervalTimer< TimerGameEconomy_economy_stations_monthly ({TimerGameEconomy::MONTH, TimerGameEconomy::Priority::STATION}, [](auto) { for(Station *st :Station::Iterate()) { for(GoodsEntry &ge :st->goods) { SB(ge.status, GoodsEntry::GES_LAST_MONTH, 1, GB(ge.status, GoodsEntry::GES_CURRENT_MONTH, 1));ClrBit(ge.status, GoodsEntry::GES_CURRENT_MONTH);} } })
 Economy monthly loop for stations.
 
const TileTypeProcs _tile_type_station_procs
 

Detailed Description

Handling of station tiles.

Definition in file station_cmd.cpp.

Typedef Documentation

◆ CMSAMatcher

typedef bool(* CMSAMatcher) (TileIndex tile)

Function to check whether the given tile matches some criterion.

Parameters
tilethe tile to check
Returns
true if it matches, false otherwise

Definition at line 144 of file station_cmd.cpp.

Function Documentation

◆ AirportGetNearestTown() [1/2]

Town* AirportGetNearestTown ( const AirportSpec as,
Direction  rotation,
TileIndex  tile,
TileIterator &&  it,
uint &  mindist 
)

Finds the town nearest to given airport.

Based on minimal manhattan distance to any airport's tile. If two towns have the same distance, town with lower index is returned.

Parameters
asairport's description
rotationairport's rotation
tileorigin tile (top corner of the airport)
itAn iterator over all airport tiles (consumed)
[out]mindistMinimum distance to town
Returns
nearest town to airport

Definition at line 2455 of file station_cmd.cpp.

References CalcClosestTownFromTile(), DIR_E, DIR_W, DistanceManhattan(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_town_pool >::GetNumItems(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem< Tpool >::index, INVALID_TILE, IsInsideBS(), AirportSpec::size_x, AirportSpec::size_y, TileX(), TileY(), and Town::xy.

Referenced by AirportGetNearestTown(), RemoveAirport(), and UpdateAirportsNoise().

◆ AirportGetNearestTown() [2/2]

static Town* AirportGetNearestTown ( const Station st,
uint &  mindist 
)
static

Finds the town nearest to given existing airport.

Based on minimal manhattan distance to any airport's tile. If two towns have the same distance, town with lower index is returned.

Parameters
stationexisting station with airport
[out]mindistMinimum distance to town
Returns
nearest town to airport

Definition at line 2498 of file station_cmd.cpp.

References Station::airport, AirportGetNearestTown(), Airport::GetSpec(), Airport::rotation, and OrthogonalTileArea::tile.

◆ BuildStationPart()

static CommandCost BuildStationPart ( Station **  st,
DoCommandFlag  flags,
bool  reuse,
TileArea  area,
StationNaming  name_class 
)
static

Common part of building various station parts and possibly attaching them to an existing one.

Parameters
[in,out]stStation to attach to
flagsCommand flags
reuseWhether to try to reuse a deleted station (gray sign) if possible
areaArea occupied by the new part
name_classStation naming class to use to generate the new station's name
Returns
Command error that occurred, if any

Definition at line 701 of file station_cmd.cpp.

References _current_company, Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_station_pool >::CanAllocateItem(), CMD_ERROR, DC_EXEC, CommandCost::Failed(), GetClosestDeletedStation(), OrthogonalTileArea::h, return_cmd_error, OrthogonalTileArea::tile, and OrthogonalTileArea::w.

◆ CalculateRailStationCost()

static CommandCost CalculateRailStationCost ( TileArea  tile_area,
DoCommandFlag  flags,
Axis  axis,
StationID *  station,
RailType  rt,
std::vector< Train * > &  affected_vehicles,
StationClassID  spec_class,
uint16_t  spec_index,
uint8_t  plat_len,
uint8_t  numtracks 
)
static

Calculates cost of new rail stations within the area.

Parameters
tile_areaArea to check.
flagsOperation to perform.
axisRail station axis.
stationStationID to be queried and returned if available.
rtThe rail type to check for (overbuilding rail stations over rail).
affected_vehiclesList of trains with PBS reservations on the tiles
spec_classStation class.
spec_indexIndex into the station class.
plat_lenPlatform length.
numtracksNumber of platforms.
Returns
The cost in case of success, or an error code if it failed.

Definition at line 1269 of file station_cmd.cpp.

◆ CalculateRoadStopCost()

CommandCost CalculateRoadStopCost ( TileArea  tile_area,
DoCommandFlag  flags,
bool  is_drive_through,
StationType  station_type,
Axis  axis,
DiagDirection  ddir,
StationID *  est,
RoadType  rt,
Money  unit_cost 
)

Calculates cost of new road stops within the area.

Parameters
tile_areaArea to check.
flagsOperation to perform.
is_drive_throughTrue if trying to build a drive-through station.
station_typeStation type (bus, truck or road waypoint).
axisAxis of a drive-through road stop.
ddirEntrance direction (DiagDirection) for normal stops. Converted to the axis for drive-through stops.
stationStationID to be queried and returned if available.
rtRoad type to build, may be INVALID_ROADTYPE if an existing road is required.
unit_costThe cost to build one road stop of the current type.
Returns
The cost in case of success, or an error code if it failed.

Definition at line 1919 of file station_cmd.cpp.

References CommandCost::AddCost(), AxisToDiagDir(), CheckFlatLandRoadStop(), EXPENSES_CONSTRUCTION, CommandCost::Failed(), IsAnyRoadStop(), IsTileType(), MP_STATION, ReverseDiagDir(), and SetBit().

◆ CanExpandRailStation()

CommandCost CanExpandRailStation ( const BaseStation st,
TileArea new_ta 
)

Check whether we can expand the rail part of the given station.

Parameters
stthe station to expand
new_tathe current (and if all is fine new) tile area of the rail part of the station
Returns
Succeeded or failed command.

Definition at line 1081 of file station_cmd.cpp.

References BaseStation::train_station.

◆ CanRemoveRoadWithStop()

static CommandCost CanRemoveRoadWithStop ( TileIndex  tile,
DoCommandFlag  flags 
)
static

Check if a drive-through road stop tile can be cleared.

Road stops built on town-owned roads check the conditions that would allow clearing of the original road.

Parameters
tileThe road stop tile to check.
flagsCommand flags.
Returns
A succeeded command if the road can be removed, a failed command with the relevant error message otherwise.

Definition at line 4665 of file station_cmd.cpp.

References _current_company, and OWNER_WATER.

◆ CheckBuildableTile()

CommandCost CheckBuildableTile ( TileIndex  tile,
uint  invalid_dirs,
int &  allowed_z,
bool  allow_steep,
bool  check_bridge = true 
)

Checks if the given tile is buildable, flat and has a certain height.

Parameters
tileTileIndex to check.
invalid_dirsProhibited directions for slopes (set of DiagDirection).
allowed_zHeight allowed for the tile. If allowed_z is negative, it will be set to the height of this tile.
allow_steepWhether steep slopes are allowed.
check_bridgeCheck for the existence of a bridge.
Returns
The cost in case of success, or an error code if it failed.

Definition at line 803 of file station_cmd.cpp.

References _settings_game, CommandCost::AddCost(), ConstructionSettings::build_on_slopes, CanBuildDepotByTileh(), GameSettings::construction, DIAGDIR_BEGIN, DIAGDIR_END, EnsureNoVehicleOnGround(), EXPENSES_CONSTRUCTION, CommandCost::Failed(), GetSlopeMaxZ(), GetTileSlopeZ(), HasBit(), IsBridgeAbove(), IsSteepSlope(), return_cmd_error, and SLOPE_FLAT.

Referenced by CheckFlatLandAirport(), and CheckFlatLandRoadStop().

◆ CheckFlatLandAirport()

static CommandCost CheckFlatLandAirport ( AirportTileTableIterator  tile_iter,
DoCommandFlag  flags 
)
static

Checks if an airport can be built at the given location and clear the area.

Parameters
tile_iterAirport tile iterator.
flagsOperation to perform.
Returns
The cost in case of success, or an error code if it failed.

Definition at line 852 of file station_cmd.cpp.

References CommandCost::AddCost(), CheckBuildableTile(), EXPENSES_CONSTRUCTION, CommandCost::Failed(), and INVALID_TILE.

◆ CheckFlatLandRailStation()

static CommandCost CheckFlatLandRailStation ( TileIndex  tile_cur,
TileIndex  north_tile,
int &  allowed_z,
DoCommandFlag  flags,
Axis  axis,
StationID *  station,
RailType  rt,
std::vector< Train * > &  affected_vehicles,
StationClassID  spec_class,
uint16_t  spec_index,
uint8_t  plat_len,
uint8_t  numtracks 
)
static

Checks if a rail station can be built at the given tile.

Parameters
tile_curTile to check.
north_tileNorth tile of the area being checked.
allowed_zHeight allowed for the tile. If allowed_z is negative, it will be set to the height of this tile.
flagsOperation to perform.
axisRail station axis.
stationStationID to be queried and returned if available.
rtThe rail type to check for (overbuilding rail stations over rail).
affected_vehiclesList of trains with PBS reservations on the tiles
spec_classStation class.
spec_indexIndex into the station class.
plat_lenPlatform length.
numtracksNumber of platforms.
Returns
The cost in case of success, or an error code if it failed.

Definition at line 886 of file station_cmd.cpp.

◆ CheckFlatLandRoadStop()

CommandCost CheckFlatLandRoadStop ( TileIndex  cur_tile,
int &  allowed_z,
DoCommandFlag  flags,
uint  invalid_dirs,
bool  is_drive_through,
StationType  station_type,
Axis  axis,
StationID *  station,
RoadType  rt 
)

Checks if a road stop can be built at the given tile.

Parameters
cur_tileTile to check.
allowed_zHeight allowed for the tile. If allowed_z is negative, it will be set to the height of this tile.
flagsOperation to perform.
invalid_dirsProhibited directions (set of DiagDirections).
is_drive_throughTrue if trying to build a drive-through station.
station_typeStation type (bus, truck or road waypoint).
axisAxis of a drive-through road stop.
stationStationID to be queried and returned if available.
rtRoad type to build, may be INVALID_ROADTYPE if an existing road is required.
Returns
The cost in case of success, or an error code if it failed.

Definition at line 968 of file station_cmd.cpp.

References CommandCost::AddCost(), CheckBuildableTile(), ClearTile_Station(), DC_AUTO, EXPENSES_CONSTRUCTION, CommandCost::Failed(), GetDriveThroughStopAxis(), GetStationIndex(), GetStationType(), IsAnyRoadStop(), IsDriveThroughStopTile(), IsTileType(), MP_STATION, and return_cmd_error.

Referenced by CalculateRoadStopCost().

◆ ClearDockingTilesCheckingNeighbours()

void ClearDockingTilesCheckingNeighbours ( TileIndex  tile)

Clear docking tile status from tiles around a removed dock, if the tile has no neighbours which would keep it as a docking tile.

Parameters
tileEx-dock tile to check.

Definition at line 2902 of file station_cmd.cpp.

References DIAGDIR_BEGIN, DIAGDIR_END, IsValidTile(), and TileOffsByDiagDir().

◆ ClearTile_Station()

CommandCost ClearTile_Station ( TileIndex  tile,
DoCommandFlag  flags 
)

Clear a single tile of a station.

Parameters
tileThe tile to clear.
flagsThe DoCommand flags related to the "command".
Returns
The cost, or error of clearing.

Definition at line 4700 of file station_cmd.cpp.

References DC_AUTO, and GetStationType().

Referenced by CheckFlatLandRoadStop(), and IsValidTileForWaypoint().

◆ CmdBuildAirport()

CommandCost CmdBuildAirport ( DoCommandFlag  flags,
TileIndex  tile,
uint8_t  airport_type,
uint8_t  layout,
StationID  station_to_join,
bool  allow_adjacent 
)

Place an Airport.

Parameters
flagsoperation to perform
tiletile where airport will be built
airport_typeairport type,
See also
airport.h
Parameters
layoutairport layout
station_to_joinstation ID to join (NEW_STATION if build new one)
allow_adjacentallow airports directly adjacent to other airports.
Returns
the cost of this operation or an error

Definition at line 2528 of file station_cmd.cpp.

◆ CmdBuildDock()

CommandCost CmdBuildDock ( DoCommandFlag  flags,
TileIndex  tile,
StationID  station_to_join,
bool  adjacent 
)

Build a dock/haven.

Parameters
flagsoperation to perform
tiletile where dock will be built
station_to_joinstation ID to join (NEW_STATION if build new one)
adjacentallow docks directly adjacent to other docks.
Returns
the cost of this operation or an error

Definition at line 2795 of file station_cmd.cpp.

◆ CmdBuildRailStation()

CommandCost CmdBuildRailStation ( DoCommandFlag  flags,
TileIndex  tile_org,
RailType  rt,
Axis  axis,
uint8_t  numtracks,
uint8_t  plat_len,
StationClassID  spec_class,
uint16_t  spec_index,
StationID  station_to_join,
bool  adjacent 
)

Build rail station.

Parameters
flagsoperation to perform
tile_orgnorthern most position of station dragging/placement
rtrailtype
axisorientation (Axis)
numtracksnumber of tracks
plat_lenplatform length
spec_classcustom station class
spec_indexcustom station id
station_to_joinstation ID to join (NEW_STATION if build new one)
adjacentallow stations directly adjacent to other stations.
Returns
the cost of this operation or an error

Definition at line 1344 of file station_cmd.cpp.

◆ CmdBuildRoadStop()

CommandCost CmdBuildRoadStop ( DoCommandFlag  flags,
TileIndex  tile,
uint8_t  width,
uint8_t  length,
RoadStopType  stop_type,
bool  is_drive_through,
DiagDirection  ddir,
RoadType  rt,
RoadStopClassID  spec_class,
uint16_t  spec_index,
StationID  station_to_join,
bool  adjacent 
)

Build a bus or truck stop.

Parameters
flagsOperation to perform.
tileNorthernmost tile of the stop.
widthWidth of the road stop.
lengthLength of the road stop.
stop_typeType of road stop (bus/truck).
is_drive_throughFalse for normal stops, true for drive-through.
ddirEntrance direction (DiagDirection) for normal stops. Converted to the axis for drive-through stops.
rtThe roadtype.
spec_classRoad stop spec class.
spec_indexRoad stop spec index.
station_to_joinStation ID to join (NEW_STATION if build new one).
adjacentAllow stations directly adjacent to other stations.
Returns
The cost of this operation or an error.

Definition at line 1964 of file station_cmd.cpp.

◆ CmdOpenCloseAirport()

◆ CmdRemoveFromRailStation()

CommandCost CmdRemoveFromRailStation ( DoCommandFlag  flags,
TileIndex  start,
TileIndex  end,
bool  keep_rail 
)

Remove a single tile from a rail station.

This allows for custom-built station with holes and weird layouts

Parameters
flagsoperation to perform
starttile of station piece to remove
endother edge of the rect to remove
keep_railif set keep the rail
Returns
the cost of this operation or an error

Definition at line 1749 of file station_cmd.cpp.

References CMD_ERROR, RemoveFromRailBaseStation(), and Map::Size().

◆ CmdRemoveFromRailWaypoint()

CommandCost CmdRemoveFromRailWaypoint ( DoCommandFlag  flags,
TileIndex  start,
TileIndex  end,
bool  keep_rail 
)

Remove a single tile from a waypoint.

This allows for custom-built waypoint with holes and weird layouts

Parameters
flagsoperation to perform
starttile of waypoint piece to remove
endother edge of the rect to remove
keep_railif set keep the rail
Returns
the cost of this operation or an error

Definition at line 1782 of file station_cmd.cpp.

References CMD_ERROR, RemoveFromRailBaseStation(), and Map::Size().

◆ CmdRemoveFromRoadWaypoint()

CommandCost CmdRemoveFromRoadWaypoint ( DoCommandFlag  flags,
TileIndex  start,
TileIndex  end 
)

Remove road waypoints.

Parameters
flagsoperation to perform
starttile of road waypoint piece to remove
endother edge of the rect to remove
Returns
the cost of this operation or an error

Definition at line 2406 of file station_cmd.cpp.

References CMD_ERROR, RemoveGenericRoadStop(), and Map::Size().

◆ CmdRemoveRoadStop()

CommandCost CmdRemoveRoadStop ( DoCommandFlag  flags,
TileIndex  tile,
uint8_t  width,
uint8_t  height,
RoadStopType  stop_type,
bool  remove_road 
)

Remove bus or truck stops.

Parameters
flagsOperation to perform.
tileNorthernmost tile of the removal area.
widthWidth of the removal area.
heightHeight of the removal area.
stop_typeType of stop (bus/truck).
remove_roadRemove roads of drive-through stops?
Returns
The cost of this operation or an error.

Definition at line 2384 of file station_cmd.cpp.

References CMD_ERROR, DC_BANKRUPT, INVALID_TILE, IsValidTile(), RemoveGenericRoadStop(), ROADSTOP_BUS, ROADSTOP_END, and TileAddWrap().

◆ CmdRenameStation()

CommandCost CmdRenameStation ( DoCommandFlag  flags,
StationID  station_id,
const std::string &  text 
)

Rename a station.

Parameters
flagsoperation to perform
station_idstation ID that is to be renamed
textthe new name or an empty string when resetting to the default
Returns
the cost of this operation or an error

Definition at line 4317 of file station_cmd.cpp.

References CheckOwnership(), CMD_ERROR, CommandCost::Failed(), SpecializedStation< Station, false >::GetIfValid(), MAX_LENGTH_STATION_NAME_CHARS, BaseStation::owner, and Utf8StringLength().

◆ CMSAMine()

static bool CMSAMine ( TileIndex  tile)
static

Check whether the tile is a mine.

Parameters
tilethe tile to investigate.
Returns
true if and only if the tile is a mine

Definition at line 171 of file station_cmd.cpp.

References CC_LIQUID, CC_MAIL, CC_PASSENGERS, CargoSpec::classes, CargoSpec::Get(), Industry::GetByTile(), GetIndustrySpec(), INDUSTRYLIFE_EXTRACTIVE, IsTileType(), IsValidCargoID(), IndustrySpec::life_type, MP_INDUSTRY, Industry::produced, and Industry::type.

◆ CMSATree()

static bool CMSATree ( TileIndex  tile)
static

Check whether the tile is a tree.

Parameters
tilethe tile to investigate.
Returns
true if and only if the tile is a tree tile

Definition at line 208 of file station_cmd.cpp.

References IsTileType(), and MP_TREES.

◆ CMSAWater()

static bool CMSAWater ( TileIndex  tile)
static

Check whether the tile is water.

Parameters
tilethe tile to investigate.
Returns
true if and only if the tile is a water tile

Definition at line 198 of file station_cmd.cpp.

References IsTileType(), IsWater(), and MP_WATER.

◆ CountMapSquareAround()

static int CountMapSquareAround ( TileIndex  tile,
CMSAMatcher  cmp 
)
static

Counts the numbers of tiles matching a specific type in the area around.

Parameters
tilethe center tile of the 'count area'
cmpthe comparator/matcher (
See also
CMSAMatcher)
Returns
the number of matching tiles around

Definition at line 152 of file station_cmd.cpp.

References INVALID_TILE, and TileAddWrap().

◆ DeleteStaleLinks()

void DeleteStaleLinks ( Station from)

Check all next hops of cargo packets in this station for existence of a a valid link they may use to travel on.

Reroute any cargo not having a valid link and remove timed out links found like this from the linkgraph. We're not all links here as that is expensive and useless. A link no one is using doesn't hurt either.

Parameters
fromStation to check.

Definition at line 4028 of file station_cmd.cpp.

References _settings_game, TimerGameEconomy::date, DistanceManhattan(), DT_MANUAL, SpecializedStation< Station, false >::Get(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_link_graph_pool >::GetIfValid(), Station::goods, Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_orderlist_pool >::Iterate(), GoodsEntry::link_graph, GameSettings::linkgraph, LinkGraph::MIN_TIMEOUT_DISTANCE, Order::next, GoodsEntry::node, NUM_CARGO, and BaseStation::xy.

◆ DeleteStationIfEmpty()

static void DeleteStationIfEmpty ( BaseStation st)
static

This is called right after a station was deleted.

It checks if the whole station is free of substations, and if so, the station will be deleted after a little while.

Parameters
stStation

Definition at line 738 of file station_cmd.cpp.

References BaseStation::delete_ctr, InvalidateWindowData(), BaseStation::IsInUse(), BaseStation::owner, and WC_STATION_LIST.

◆ FindDockLandPart()

static TileIndex FindDockLandPart ( TileIndex  t)
static

Find the part of a dock that is land-based.

Parameters
tDock tile to find land part of
Returns
tile of land part of dock

Definition at line 2923 of file station_cmd.cpp.

References DIAGDIR_BEGIN, DIAGDIR_END, GetDockDirection(), GetStationGfx(), GFX_DOCK_BASE_WATER_PART, INVALID_TILE, IsDockTile(), IsValidTile(), and TileOffsByDiagDir().

Referenced by RemoveDock().

◆ FindJoiningBaseStation()

template<class T , StringID error_message, class F >
CommandCost FindJoiningBaseStation ( StationID  existing_station,
StationID  station_to_join,
bool  adjacent,
TileArea  ta,
T **  st,
filter 
)

Find a nearby station that joins this station.

Template Parameters
Tthe class to find a station for
error_messagethe error message when building a station on top of others
Fthe filter functor type
Parameters
existing_stationan existing station we build over
station_to_jointhe station to join to
adjacentwhether adjacent stations are allowed
tathe area of the newly build station
st'return' pointer for the found station
Returns
command cost with the error or 'okay'

Definition at line 1163 of file station_cmd.cpp.

◆ FindJoiningRoadStop()

static CommandCost FindJoiningRoadStop ( StationID  existing_stop,
StationID  station_to_join,
bool  adjacent,
TileArea  ta,
Station **  st 
)
static

Find a nearby station that joins this road stop.

Parameters
existing_stopan existing road stop we build over
station_to_jointhe station to join to
adjacentwhether adjacent stations are allowed
tathe area of the newly build station
st'return' pointer for the found station
Returns
command cost with the error or 'okay'

Definition at line 1901 of file station_cmd.cpp.

◆ FindJoiningStation()

static CommandCost FindJoiningStation ( StationID  existing_station,
StationID  station_to_join,
bool  adjacent,
TileArea  ta,
Station **  st 
)
static

Find a nearby station that joins this station.

Parameters
existing_stationan existing station we build over
station_to_jointhe station to join to
adjacentwhether adjacent stations are allowed
tathe area of the newly build station
st'return' pointer for the found station
Returns
command cost with the error or 'okay'

Definition at line 1207 of file station_cmd.cpp.

◆ FindJoiningWaypoint()

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.

Parameters
existing_waypointan existing waypoint we build over
waypoint_to_jointhe waypoint to join to
adjacentwhether adjacent waypoints are allowed
tathe area of the newly build waypoint
wp'return' pointer for the found waypoint
is_roadwhether to find a road waypoint
Returns
command cost with the error or 'okay'

Definition at line 1222 of file station_cmd.cpp.

References HasBit(), Waypoint::waypoint_flags, and WPF_ROAD.

◆ FindNearIndustryName()

static bool FindNearIndustryName ( TileIndex  tile,
void *  user_data 
)
static

Find a station action 0 property 24 station name, or reduce the free_names if needed.

Parameters
tilethe tile to search
user_datathe StationNameInformation to base the search on
Returns
true if the tile contains an industry that has not given its name to one of the other stations in town.

Definition at line 238 of file station_cmd.cpp.

References StationNameInformation::free_names, GetIndustrySpec(), GetIndustryType(), IsTileType(), and MP_INDUSTRY.

◆ FindRoadStopSpot()

static RoadStop** FindRoadStopSpot ( bool  truck_station,
Station st 
)
static
Parameters
truck_stationDetermines whether a stop is ROADSTOP_BUS or ROADSTOP_TRUCK
stThe Station to do the whole procedure for
Returns
a pointer to where to link a new RoadStop*

Definition at line 1874 of file station_cmd.cpp.

References Station::bus_stops, RoadStop::next, and Station::truck_stops.

◆ FreeTrainReservation()

static void FreeTrainReservation ( Train v)
static

Clear platform reservation during station building/removing.

Parameters
vvehicle which holds reservation

Definition at line 1235 of file station_cmd.cpp.

References FreeTrainTrackReservation(), Train::GetVehicleTrackdir(), IsRailStationTile(), SpecializedVehicle< T, Type >::Last(), ReverseTrackdir(), SetRailStationPlatformReservation(), Vehicle::tile, and TrackdirToExitdir().

◆ GenerateStationName()

static StringID GenerateStationName ( Station st,
TileIndex  tile,
StationNaming  name_class 
)
static

Bitmask of remaining station names that can be used when a more specific name has not been used.

Definition at line 254 of file station_cmd.cpp.

◆ GetAcceptanceAroundStation()

static CargoArray GetAcceptanceAroundStation ( const Station st,
CargoTypes *  always_accepted 
)
static

Get the acceptance of cargoes around the station in.

Parameters
stStation to get acceptance of.
always_acceptedbitmask of cargo accepted by houses and headquarters; can be nullptr

Definition at line 607 of file station_cmd.cpp.

References Station::catchment_tiles, and INVALID_TILE.

Referenced by UpdateStationAcceptance().

◆ GetAcceptanceAroundTiles()

CargoArray GetAcceptanceAroundTiles ( TileIndex  center_tile,
int  w,
int  h,
int  rad,
CargoTypes *  always_accepted 
)

Get the acceptance of cargoes around the tile in 1/8.

Parameters
center_tileCenter of the search area
wX extent of area
hY extent of area
radSearch radius in addition to given area
always_acceptedbitmask of cargo accepted by houses and headquarters; can be nullptr
indIndustry associated with neutral station (e.g. oil rig) or nullptr

Definition at line 585 of file station_cmd.cpp.

References _settings_game, OrthogonalTileArea::Expand(), Industry::GetByTile(), IsTileType(), MP_INDUSTRY, StationSettings::serve_neutral_industries, and GameSettings::station.

◆ GetAcceptanceMask()

CargoTypes GetAcceptanceMask ( const Station st)

Get a mask of the cargo types that the station accepts.

Parameters
stStation to query
Returns
the expected mask

Definition at line 501 of file station_cmd.cpp.

References GoodsEntry::GES_ACCEPTANCE, Station::goods, HasBit(), and SetBit().

Referenced by StationViewWindow::DrawAcceptedCargo(), and UpdateStationAcceptance().

◆ GetAirportNoiseLevelForDistance()

uint8_t GetAirportNoiseLevelForDistance ( const AirportSpec as,
uint  distance 
)

Get a possible noise reduction factor based on distance from town center.

The further you get, the less noise you generate. So all those folks at city council can now happily slee... work in their offices

Parameters
asairport information
distanceminimum distance between town and airport
Returns
the noise that will be generated, according to distance

Definition at line 2424 of file station_cmd.cpp.

References _settings_game, GameSettings::difficulty, AirportSpec::noise_level, and DifficultySettings::town_council_tolerance.

Referenced by RemoveAirport(), and UpdateAirportsNoise().

◆ GetClosestDeletedStation()

static Station* GetClosestDeletedStation ( TileIndex  tile)
static

Find the closest deleted station of the current company.

Parameters
tilethe tile to search from.
Returns
the closest station or nullptr if too far.

Definition at line 388 of file station_cmd.cpp.

References _current_company, ForAllStationsRadius(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem< Tpool >::index, BaseStation::IsInUse(), and BaseStation::owner.

Referenced by BuildStationPart().

◆ GetEmptyMask()

CargoTypes GetEmptyMask ( const Station st)

Get a mask of the cargo types that are empty at the station.

Parameters
stStation to query
Returns
the empty mask

Definition at line 516 of file station_cmd.cpp.

References Station::goods, and SetBit().

Referenced by TriggerRoadStopRandomisation().

◆ GetProductionAroundTiles()

CargoArray GetProductionAroundTiles ( TileIndex  north_tile,
int  w,
int  h,
int  rad 
)

Get the cargo types being produced around the tile (in a rectangle).

Parameters
north_tileNorthern most tile of area
wX extent of the area
hY extent of the area
radSearch radius in addition to the given area

Definition at line 547 of file station_cmd.cpp.

References OrthogonalTileArea::Expand(), GetIndustryIndex(), IsTileType(), and MP_INDUSTRY.

◆ GetStationAround()

template<class T , class F >
CommandCost GetStationAround ( TileArea  ta,
StationID  closest_station,
CompanyID  company,
T **  st,
filter 
)

Look for a station owned by the given company around the given tile area.

Parameters
tathe area to search over
closest_stationthe closest owned station found so far
companythe company whose stations to look for
stto 'return' the found station
filterFilter function
Returns
Succeeded command (if zero or one station found) or failed command (for two or more stations found).

Definition at line 119 of file station_cmd.cpp.

◆ GetStationLayout()

void GetStationLayout ( uint8_t *  layout,
uint  numtracks,
uint  plat_len,
const StationSpec statspec 
)

Create the station layout for the given number of tracks and platform length.

Parameters
layoutThe layout to write to.
numtracksThe number of tracks to write.
plat_lenThe length of the platforms.
statspecThe specification of the station to (possibly) get the layout from.

Definition at line 1126 of file station_cmd.cpp.

References GetStationLayoutKey(), and StationSpec::layouts.

◆ GetStationTileFlags()

static StationSpec::TileFlags GetStationTileFlags ( StationGfx  gfx,
const StationSpec statspec 
)
static

Get station tile flags for the given StationGfx.

Parameters
gfxStationGfx of station tile.
statspecStation spec of station tile.
Returns
Tile flags to apply.

Definition at line 1310 of file station_cmd.cpp.

References StationSpec::Pylons, and StationSpec::tileflags.

Referenced by SetRailStationTileFlags().

◆ GetStationTileLayout()

const DrawTileSprites* GetStationTileLayout ( StationType  st,
uint8_t  gfx 
)

Get station tile layout for a station type and its station gfx.

Parameters
stStation type to draw.
gfxStationGfx of tile to draw.
Returns
Tile layout to draw.

Definition at line 3018 of file station_cmd.cpp.

◆ HasStationInUse()

bool HasStationInUse ( StationID  station,
bool  include_company,
CompanyID  company 
)

Tests whether the company's vehicles have this station in orders.

Parameters
stationstation ID
include_companyIf true only check vehicles of company, if false only check vehicles of other companies
companycompany ID

Definition at line 2762 of file station_cmd.cpp.

References Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_orderlist_pool >::Iterate(), Order::next, and Vehicle::owner.

Referenced by CompanyStationsWindow::BuildStationsList(), and RemoveBuoy().

◆ IncreaseStats() [1/2]

void IncreaseStats ( Station st,
CargoID  cargo,
StationID  next_station_id,
uint  capacity,
uint  usage,
uint32_t  time,
EdgeUpdateMode  mode 
)

Increase capacity for a link stat given by station cargo and next hop.

Parameters
stStation to get the link stats from.
cargoCargo to increase stat for.
next_station_idStation the consist will be travelling to next.
capacityCapacity to add to link stat.
usageUsage to add to link stat.
modeUpdate mode to be applied.

Definition at line 4122 of file station_cmd.cpp.

References SpecializedStation< Station, false >::Get(), Station::goods, and GoodsEntry::link_graph.

Referenced by IncreaseStats().

◆ IncreaseStats() [2/2]

void IncreaseStats ( Station st,
const Vehicle front,
StationID  next_station_id,
uint32_t  time 
)

Increase capacity for all link stats associated with vehicles in the given consist.

Parameters
stStation to get the link stats from.
frontFirst vehicle in the consist.
next_station_idStation the consist will be travelling to next.

Definition at line 4174 of file station_cmd.cpp.

References Vehicle::cargo, Vehicle::cargo_type, EUM_INCREASE, IncreaseStats(), Vehicle::Next(), Vehicle::refit_cap, and VehicleCargoList::StoredCount().

◆ IsHangar()

bool IsHangar ( Tile  t)

Check whether the given tile is a hangar.

Parameters
tthe tile to of whether it is a hangar.
Precondition
IsTileType(t, MP_STATION)
Returns
true if and only if the tile is a hangar.

Definition at line 92 of file station_cmd.cpp.

References Station::airport, AirportSpec::depots, SpecializedStation< Station, false >::GetByTile(), Airport::GetRotatedTileFromOffset(), Airport::GetSpec(), IsAirport(), IsTileType(), and MP_STATION.

Referenced by IsHangarTile().

◆ RemoveAirport()

◆ RemoveDock()

static CommandCost RemoveDock ( TileIndex  tile,
DoCommandFlag  flags 
)
static

Remove a dock.

Parameters
tileTileIndex been queried
flagsoperation to perform
Returns
cost or failure of operation

Definition at line 2946 of file station_cmd.cpp.

References CheckOwnership(), CMD_ERROR, DC_EXEC, EnsureNoVehicleOnGround(), CommandCost::Failed(), FindDockLandPart(), SpecializedStation< Station, false >::GetByTile(), GetDockDirection(), INVALID_TILE, IsDockTile(), BaseStation::owner, CommandCost::Succeeded(), and TileOffsByDiagDir().

◆ RemoveFromRailBaseStation()

template<class T >
CommandCost RemoveFromRailBaseStation ( TileArea  ta,
std::vector< T * > &  affected_stations,
DoCommandFlag  flags,
Money  removal_cost,
bool  keep_rail 
)

Remove a number of tiles from any rail station within the area.

Parameters
tathe area to clear station tile from.
affected_stationsthe stations affected.
flagsthe command flags.
removal_costthe cost for removing the tile, including the rail.
keep_railwhether to keep the rail of the station.
Template Parameters
Tthe type of station to remove.
Returns
the number of cleared tiles or an error.

Definition at line 1642 of file station_cmd.cpp.

References CommandCost::AddCost(), EnsureNoVehicleOnGround(), EXPENSES_CONSTRUCTION, CommandCost::Failed(), and HasStationTileRail().

Referenced by CmdRemoveFromRailStation(), and CmdRemoveFromRailWaypoint().

◆ RemoveGenericRoadStop()

static CommandCost RemoveGenericRoadStop ( DoCommandFlag  flags,
const TileArea roadstop_area,
StationType  station_type,
bool  remove_road 
)
static

Remove a tile area of road stop or road waypoints.

Parameters
flagsoperation to perform
roadstop_areatile area of road stop or road waypoint tiles to remove
station_typestation type to remove
remove_roadRemove roads of drive-through stops?
Returns
the cost of this operation or an error

Definition at line 2321 of file station_cmd.cpp.

References EXPENSES_CONSTRUCTION, GetStationType(), INVALID_ROADTYPE, IsAnyRoadStop(), IsDriveThroughStopTile(), IsTileType(), MP_STATION, OWNER_NONE, and ROAD_NONE.

Referenced by CmdRemoveFromRoadWaypoint(), and CmdRemoveRoadStop().

◆ RemoveRailStation() [1/2]

template<class T >
CommandCost RemoveRailStation ( T *  st,
DoCommandFlag  flags,
Money  removal_cost 
)

Remove a rail station/waypoint.

Parameters
stThe station/waypoint to remove the rail part from
flagsoperation to perform
removal_costthe cost for removing a tile
Template Parameters
Tthe type of station to remove
Returns
cost or failure of operation

Definition at line 1803 of file station_cmd.cpp.

Referenced by RemoveRailStation(), and RemoveRailWaypoint().

◆ RemoveRailStation() [2/2]

static CommandCost RemoveRailStation ( TileIndex  tile,
DoCommandFlag  flags 
)
static

Remove a rail station.

Parameters
tileTile of the station.
flagsoperation to perform
Returns
cost or failure of operation

Definition at line 1837 of file station_cmd.cpp.

References _current_company, DC_EXEC, SpecializedStation< Station, false >::GetByTile(), OWNER_WATER, and RemoveRailStation().

◆ RemoveRailWaypoint()

static CommandCost RemoveRailWaypoint ( TileIndex  tile,
DoCommandFlag  flags 
)
static

Remove a rail waypoint.

Parameters
tileTile of the waypoint.
flagsoperation to perform
Returns
cost or failure of operation

Definition at line 1858 of file station_cmd.cpp.

References _current_company, DC_EXEC, SpecializedStation< Waypoint, true >::GetByTile(), OWNER_WATER, and RemoveRailStation().

◆ RemoveRoadStop()

static CommandCost RemoveRoadStop ( TileIndex  tile,
DoCommandFlag  flags,
int  replacement_spec_index 
)
static

Remove a bus station/truck stop.

Parameters
tileTileIndex been queried
flagsoperation to perform
replacement_spec_indexreplacement spec index to avoid deallocating, if < 0, tile is not being replaced
Returns
cost or failure of operation

Definition at line 2140 of file station_cmd.cpp.

References _current_company, Station::bus_stops, CheckOwnership(), DC_BANKRUPT, DC_EXEC, CommandCost::Failed(), FindVehicleOnPos(), SpecializedStation< Station, false >::GetByTile(), RoadStop::GetByTile(), IsDriveThroughStopTile(), IsTruckStop(), BaseStation::owner, OWNER_WATER, ROADSTOP_BUS, ROADSTOP_TRUCK, and Station::truck_stops.

◆ RemoveRoadWaypointStop()

CommandCost RemoveRoadWaypointStop ( TileIndex  tile,
DoCommandFlag  flags,
int  replacement_spec_index 
)

Remove a road waypoint.

Parameters
tileTileIndex been queried
flagsoperation to perform
replacement_spec_indexreplacement spec index to avoid deallocating, if < 0, tile is not being replaced
Returns
cost or failure of operation

Definition at line 2255 of file station_cmd.cpp.

References _current_company, CheckOwnership(), DC_BANKRUPT, EnsureNoVehicleOnGround(), CommandCost::Failed(), SpecializedStation< Waypoint, true >::GetByTile(), BaseStation::owner, and OWNER_WATER.

◆ RerouteCargo()

void RerouteCargo ( Station st,
CargoID  c,
StationID  avoid,
StationID  avoid2 
)

Reroute cargo of type c at station st or in any vehicles unloading there.

Make sure the cargo's new next hop is neither "avoid" nor "avoid2".

Parameters
stStation to be rerouted at.
cType of cargo.
avoidOriginal next hop of cargo, avoid this.
avoid2Another station to be avoided when rerouting.

Definition at line 4004 of file station_cmd.cpp.

References GoodsEntry::cargo, Station::goods, Vehicle::Next(), and StationCargoList::Reroute().

◆ RestoreTrainReservation()

static void RestoreTrainReservation ( Train v)
static

Restore platform reservation during station building/removing.

Parameters
vvehicle which held reservation

Definition at line 1247 of file station_cmd.cpp.

References Train::GetVehicleTrackdir(), IsRailStationTile(), SpecializedVehicle< T, Type >::Last(), ReverseTrackdir(), SetRailStationPlatformReservation(), Vehicle::tile, TrackdirToExitdir(), and TryPathReserve().

◆ SetRailStationTileFlags()

void SetRailStationTileFlags ( TileIndex  tile,
const StationSpec statspec 
)

Set rail station tile flags for the given tile.

Parameters
tileTile to set flags on.
statspecStatspec of the tile.

Definition at line 1322 of file station_cmd.cpp.

References StationSpec::Blocked, GetStationGfx(), GetStationTileFlags(), HasFlag(), StationSpec::NoWires, StationSpec::Pylons, SetStationTileBlocked(), SetStationTileHavePylons(), and SetStationTileHaveWires().

◆ ShowRejectOrAcceptNews()

static void ShowRejectOrAcceptNews ( const Station st,
CargoTypes  cargoes,
bool  reject 
)
static

Add news item for when a station changes which cargoes it accepts.

Parameters
stStation of cargo change.
cargoesBit mask of cargo types to list.
rejectTrue iff the station rejects the cargo types.

Definition at line 532 of file station_cmd.cpp.

References AddNewsItem(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem< Tpool >::index, NF_INCOLOUR, NF_SMALL, NR_STATION, NT_ACCEPTANCE, and SetDParam().

Referenced by UpdateStationAcceptance().

◆ SplitGroundSpriteForOverlay()

bool SplitGroundSpriteForOverlay ( const TileInfo ti,
SpriteID ground,
RailTrackOffset overlay_offset 
)

Check whether a sprite is a track sprite, which can be replaced by a non-track ground sprite and a rail overlay.

If the ground sprite is suitable, ground is replaced with the new non-track ground sprite, and overlay_offset is set to the overlay to draw.

Parameters
tiPositional info for the tile to decide snowyness etc. May be nullptr.
[in,out]groundGroundsprite to draw.
[out]overlay_offsetOverlay to draw.
Returns
true if overlay can be drawn.

Definition at line 3034 of file station_cmd.cpp.

◆ StationHandleBigTick()

static bool StationHandleBigTick ( BaseStation st)
static

This function is called for each station once every 250 ticks.

Not all stations will get the tick at the same time.

Parameters
stthe station receiving the tick.
Returns
true if the station is still valid (wasn't deleted)

Definition at line 3788 of file station_cmd.cpp.

References ClrBit(), BaseStation::delete_ctr, FACIL_WAYPOINT, BaseStation::facilities, SpecializedStation< Station, false >::From(), GoodsEntry::GES_ACCEPTED_BIGTICK, SpecializedStation< Station, false >::IsExpected(), BaseStation::IsInUse(), GoodsEntry::status, TriggerWatchedCargoCallbacks(), and UpdateStationAcceptance().

◆ TriggerWatchedCargoCallbacks()

void TriggerWatchedCargoCallbacks ( Station st)

Run the watched cargo callback for all houses in the catchment area.

Parameters
stStation.

Definition at line 3762 of file station_cmd.cpp.

References Station::catchment_tiles, GoodsEntry::GES_ACCEPTED_BIGTICK, Station::goods, HasBit(), INVALID_TILE, IsTileType(), MP_HOUSE, NUM_CARGO, SetBit(), GoodsEntry::status, and WatchedCargoCallback().

Referenced by StationHandleBigTick().

◆ TruncateCargo()

static void TruncateCargo ( const CargoSpec cs,
GoodsEntry ge,
uint  amount = UINT_MAX 
)
static

Truncate the cargo by a specific amount.

Parameters
csThe type of cargo to perform the truncation for.
geThe goods entry, of the station, to truncate.
amountThe amount to truncate the cargo by.

Definition at line 3821 of file station_cmd.cpp.

References GoodsEntry::cargo, SpecializedStation< Station, false >::GetIfValid(), Station::goods, CargoSpec::Index(), GoodsEntry::max_waiting_cargo, and StationCargoList::Truncate().

◆ UpdateStationAcceptance()

Variable Documentation

◆ _dock_tileoffs_chkaround

const TileIndexDiffC _dock_tileoffs_chkaround[]
static
Initial value:
= {
{-1, 0},
{ 0, 0},
{ 0, 0},
{ 0, -1}
}

Definition at line 2778 of file station_cmd.cpp.

◆ _tile_type_station_procs

const TileTypeProcs _tile_type_station_procs
extern
Initial value:
= {
DrawTile_Station,
GetSlopePixelZ_Station,
nullptr,
GetTileDesc_Station,
GetTileTrackStatus_Station,
ClickTile_Station,
AnimateTile_Station,
TileLoop_Station,
ChangeTileOwner_Station,
nullptr,
VehicleEnter_Station,
GetFoundation_Station,
TerraformTile_Station,
}
CommandCost ClearTile_Station(TileIndex tile, DoCommandFlag flags)
Clear a single tile of a station.

Definition at line 53 of file landscape.cpp.