Road related functions. More...

#include "direction_type.h"
#include "road_type.h"
#include "command_type.h"
#include "station_type.h"
#include "town_type.h"

Functions
void	DrawRoadDepotSprite (int x, int y, DiagDirection dir, RoadType rt)
	Draw the road depot sprite.
void	UpdateNearestTownForRoadTiles (bool invalidate)
	Updates cached nearest town for all road tiles.
CommandCost	CmdBuildLongRoad (DoCommandFlags flags, TileIndex end_tile, TileIndex start_tile, RoadType rt, Axis axis, DisallowedRoadDirections drd, bool start_half, bool end_half, bool is_ai)
	Build a long piece of road.
std::tuple< CommandCost, Money >	CmdRemoveLongRoad (DoCommandFlags flags, TileIndex end_tile, TileIndex start_tile, RoadType rt, Axis axis, bool start_half, bool end_half)
	Remove a long piece of road.
CommandCost	CmdBuildRoad (DoCommandFlags flags, TileIndex tile, RoadBits pieces, RoadType rt, DisallowedRoadDirections toggle_drd, TownID town_id)
	Build a piece of road.
CommandCost	CmdBuildRoadDepot (DoCommandFlags flags, TileIndex tile, RoadType rt, DiagDirection dir)
	Build a road depot.
CommandCost	CmdConvertRoad (DoCommandFlags flags, TileIndex tile, TileIndex area_start, RoadType to_type, bool diagonal)
	Convert one road subtype to another.
void	CcRoadDepot (Commands cmd, const CommandCost &result, TileIndex tile, RoadType rt, DiagDirection dir)
void	CcRoadStop (Commands, const CommandCost &result, TileIndex tile, uint8_t width, uint8_t length, RoadStopType, bool is_drive_through, DiagDirection dir, RoadType, RoadStopClassID spec_class, uint16_t spec_index, StationID, bool)
	Command callback for building road stops.

Variables
CommandCallback	CcPlaySound_CONSTRUCTION_OTHER
CommandCallback	CcBuildRoadTunnel

Detailed Description

Road related functions.

Definition in file road_cmd.h.

Function Documentation

◆ CcRoadDepot()

void CcRoadDepot	(	Commands	cmd,
		const CommandCost &	result,
		TileIndex	tile,
		RoadType	rt,
		DiagDirection	dir )

Definition at line 176 of file road_gui.cpp.

◆ CcRoadStop()

void CcRoadStop	(	Commands	,
		const CommandCost &	result,
		TileIndex	tile,
		uint8_t	width,
		uint8_t	length,
		RoadStopType	,
		bool	is_drive_through,
		DiagDirection	dir,
		RoadType	,
		RoadStopClassID	spec_class,
		uint16_t	spec_index,
		StationID	,
		bool	)

Command callback for building road stops.

Parameters

result	Result of the build road stop command.
tile	Start tile.
width	Width of the road stop.
length	Length of the road stop.
is_drive_through	False for normal stops, true for drive-through.
dir	Entrance direction (DiagDirection) for normal stops. Converted to the axis for drive-through stops.
spec_class	Road stop spec class.
spec_index	Road stop spec index.

See also: CmdBuildRoadStop

Definition at line 197 of file road_gui.cpp.

References _settings_client, ConnectRoadToStructure(), CommandCost::Failed(), NewGRFClass< RoadStopSpec, RoadStopClassID, ROADSTOP_CLASS_MAX >::Get(), NewGRFClass< RoadStopSpec, RoadStopClassID, ROADSTOP_CLASS_MAX >::GetClassCount(), NewGRFClass< Tspec, Tindex, Tmax >::GetSpec(), NoAutoRoadConnection, ResetObjectToPlace(), ReverseDiagDir(), SND_1F_CONSTRUCTION_OTHER, and BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Test().

Referenced by PlaceRoadStop().

◆ CmdBuildLongRoad()

CommandCost CmdBuildLongRoad	(	DoCommandFlags	flags,
		TileIndex	end_tile,
		TileIndex	start_tile,
		RoadType	rt,
		Axis	axis,
		DisallowedRoadDirections	drd,
		bool	start_half,
		bool	end_half,
		bool	is_ai )

Build a long piece of road.

Parameters

flags	operation to perform
end_tile	end tile of drag
start_tile	start tile of drag
rt	road type
axis	direction
drd	set road direction
start_half	start tile starts in the 2nd half of tile (p2 & 1). Only used if `is_ai` is set or if we are building a single tile
end_half	end tile starts in the 2nd half of tile (p2 & 2). Only used if `is_ai` is set or if we are building a single tile
is_ai	defines two different behaviors for this command: false = Build up to an obstacle. Do not build the first and last roadbits unless they can be connected to something, or if we are building a single tile true = Fail if an obstacle is found. Always take into account start_half and end_half. This behavior is used for scripts

Returns: the cost of this operation or an error

Definition at line 966 of file road_cmd.cpp.

References CommandCost::AddCost(), AXIS_X, AXIS_Y, AxisToDiagDir(), AxisToRoadBits(), CanConnectToRoad(), CMD_ERROR, DiagDirToRoadBits(), DRD_BOTH, DRD_NORTHBOUND, DRD_SOUTHBOUND, EXPENSES_CONSTRUCTION, CommandCost::Failed(), CommandCost::GetCost(), CommandCost::GetErrorMessage(), GetTunnelBridgeDirection(), IsBridge(), IsTileType(), IsValidAxis(), IsValidDisallowedRoadDirections(), ReverseDiagDir(), Map::Size(), TileOffsByDiagDir(), TileX(), TileY(), TunnelBridge, and ValParamRoadType().

◆ CmdBuildRoad()

CommandCost CmdBuildRoad	(	DoCommandFlags	flags,
		TileIndex	tile,
		RoadBits	pieces,
		RoadType	rt,
		DisallowedRoadDirections	toggle_drd,
		TownID	town_id )

Build a piece of road.

Parameters

flags	operation to perform
tile	tile where to build road
pieces	road pieces to build (RoadBits)
rt	road type
toggle_drd	disallowed directions to toggle
town_id	the town that is building the road (TownID::Invalid() if not applicable)

Returns: the cost of this operation or an error

Definition at line 599 of file road_cmd.cpp.

References _current_company, _settings_game, CommandCost::AddCost(), AXIS_X, AXIS_Y, AxisToRoadBits(), AxisToTrack(), Town::cache, CalcClosestTownFromTile(), CheckOwnership(), CheckRoadSlope(), CheckTileOwnership(), CMD_ERROR, ComplementRoadBits(), CountBits(), Crossing, Depot, DiagDirToRoadBits(), DirtyCompanyInfrastructureWindows(), DistanceSquare(), DRD_NONE, EnsureNoVehicleOnGround(), Execute, EXPENSES_CONSTRUCTION, CommandCost::Failed(), GetAnyRoadBits(), CommandCost::GetCost(), GetCrossingRoadAxis(), GetCrossingRoadBits(), GetDisallowedRoadDirections(), GetDriveThroughStopAxis(), GetOtherTunnelBridgeEnd(), GetRailReservationTrackBits(), GetRailTileType(), GetRailType(), GetRoadBits(), GetRoadFoundation(), GetRoadOwner(), GetRoadTileType(), GetTileOwner(), GetTileSlope(), GetTileType(), GetTrackBits(), GetTunnelBridgeDirection(), GetTunnelBridgeLength(), GetTunnelBridgeTransportType(), HasBit(), HasExactlyOneBit(), HasPowerOnRoad(), HasRoadWorks(), HasTileRoadType(), Company::infrastructure, INVALID_ROADTYPE, IsBridge(), IsDriveThroughStopTile(), IsNormalRoad(), IsNormalRoadTile(), IsSteepSlope(), IsStraightRoad(), IsTileType(), IsValidDisallowedRoadDirections(), IsValidRoadBits(), LEVELCROSSING_TRACKBIT_FACTOR, MakeRoadCrossing(), MakeRoadNormal(), MarkBridgeDirty(), MarkDirtyAdjacentLevelCrossingTiles(), MarkTileDirtyByTile(), MirrorRoadBits(), Normal, OtherAxis(), OWNER_DEITY, OWNER_NONE, OWNER_TOWN, CompanyInfrastructure::rail, RailNoLevelCrossings(), Railway, Road, ROAD_NONE, ROAD_X, ROAD_Y, RoadBuildCost(), RoadNoLevelCrossing(), RTT_ROAD, RTT_TRAM, SetCrossingReservation(), SetDisallowedRoadDirections(), SetRoadBits(), SetRoadOwner(), SetRoadType(), SetTownIndex(), TownCache::squared_town_zone_radius, Station, BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Test(), to_underlying(), TownEdge, TRACK_BIT_X, TRACK_BIT_Y, TRANSPORT_ROAD, TunnelBridge, TUNNELBRIDGE_TRACKBIT_FACTOR, TunnelBridgeIsFree(), UpdateCompanyRoadInfrastructure(), UpdateLevelCrossing(), VALID_LEVEL_CROSSING_SLOPES, ValParamRoadType(), Town::xy, and YapfNotifyTrackLayoutChange().

◆ CmdBuildRoadDepot()

CommandCost CmdBuildRoadDepot	(	DoCommandFlags	flags,
		TileIndex	tile,
		RoadType	rt,
		DiagDirection	dir )

Build a road depot.

Parameters

tile	tile where to build the depot
flags	operation to perform
rt	road type
dir	entrance direction

Returns: the cost of this operation or an error

Todo: When checking for the tile slope, distinguish between "Flat land required" and "land sloped in wrong direction"

Definition at line 1137 of file road_cmd.cpp.

References _current_company, _settings_game, CommandCost::AddCost(), BuildDepotRoad, BuildFoundation, CanBuildDepotByTileh(), CheckTileOwnership(), CMD_ERROR, EnsureNoVehicleOnGround(), Execute, EXPENSES_CONSTRUCTION, CommandCost::Failed(), GetRoadDepotDirection(), GetTileSlope(), IsBridgeAbove(), IsRoadDepotTile(), IsValidDiagDirection(), MakeDefaultName(), MakeRoadDepot(), MarkTileDirtyByTile(), ROAD_DEPOT_TRACKBIT_FACTOR, SetRoadDepotExitDirection(), SLOPE_FLAT, BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Test(), UpdateCompanyRoadInfrastructure(), and ValParamRoadType().

◆ CmdConvertRoad()

CommandCost CmdConvertRoad	(	DoCommandFlags	flags,
		TileIndex	tile,
		TileIndex	area_start,
		RoadType	to_type,
		bool	diagonal )

Convert one road subtype to another.

Not meant to convert from road to tram.

Parameters

flags	operation to perform
tile	end tile of road conversion drag
area_start	start tile of drag
to_type	new roadtype to convert to.
diagonal	Whether a diagonal or orthogonal area is to be converted.

Returns: the cost of this operation or an error

Definition at line 2462 of file road_cmd.cpp.

References _current_company, _settings_game, CommandCost::AddCost(), CanConvertUnownedRoadType(), CheckforTownRating(), CheckOwnership(), ClosestTownFromTile(), CMD_ERROR, ConvertRoadTypeOwner(), CountBits(), TileIterator::Create(), EnsureNoVehicleOnGround(), Execute, EXPENSES_CONSTRUCTION, CommandCost::Failed(), SpecializedVehicle< RoadVehicle, Type >::From(), GetAnyRoadBits(), GetEncodedStringWithArgs(), GetOtherTunnelBridgeEnd(), GetParamsForOwnedBy(), GetRoadOwner(), GetTileType(), GetTunnelBridgeLength(), GetTunnelBridgeTransportType(), HasPowerOnRoad(), include(), INVALID_ROADTYPE, INVALID_TILE, InvalidateWindowData(), IsAnyRoadStop(), IsBayRoadStopTile(), IsBridge(), IsLevelCrossing(), IsLocalCompany(), IsRoadDepot(), IsRoadDepotTile(), CommandCost::MakeError(), MarkBridgeDirty(), MarkTileDirtyByTile(), MayHaveRoad(), OWNER_TOWN, Road, ROAD_DEPOT_TRACKBIT_FACTOR, ROAD_STOP_TRACKBIT_FACTOR, RoadConvertCost(), RoadNoLevelCrossing(), RoadRemove, RTT_ROAD, RTT_TRAM, CommandCost::SetEncodedMessage(), SetRoadType(), SetTunnelBridgeOwner(), Map::Size(), Station, BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Test(), TRANSPORT_ROAD, TunnelBridge, TUNNELBRIDGE_TRACKBIT_FACTOR, TunnelBridgeIsFree(), TunnelBridgeRemove, BaseVehicle::type, ValParamRoadType(), VEH_ROAD, WC_BUILD_VEHICLE, and WC_VEHICLE_DEPOT.

◆ CmdRemoveLongRoad()

std::tuple< CommandCost, Money > CmdRemoveLongRoad	(	DoCommandFlags	flags,
		TileIndex	end_tile,
		TileIndex	start_tile,
		RoadType	rt,
		Axis	axis,
		bool	start_half,
		bool	end_half )

Remove a long piece of road.

Parameters

flags	operation to perform
end_tile	end tile of drag
start_tile	start tile of drag
rt	road type
axis	direction
start_half	start tile starts in the 2nd half of tile
end_half	end tile starts in the 2nd half of tile (p2 & 2)

Returns: the cost of this operation or an error

Definition at line 1063 of file road_cmd.cpp.

References CommandCost::AddCost(), AXIS_X, AXIS_Y, AxisToRoadBits(), CMD_ERROR, Execute, EXPENSES_CONSTRUCTION, GetAvailableMoneyForCommand(), CommandCost::GetCost(), CommandCost::GetErrorMessage(), IsValidAxis(), RemoveRoad(), ROAD_NE, ROAD_NW, ROAD_SE, ROAD_SW, Map::Size(), CommandCost::Succeeded(), BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Test(), TileOffsByAxis(), TileX(), TileY(), and ValParamRoadType().

◆ DrawRoadDepotSprite()

void DrawRoadDepotSprite	(	int	x,
		int	y,
		DiagDirection	dir,
		RoadType	rt )

Draw the road depot sprite.

Parameters

x	The x offset to draw at.
y	The y offset to draw at.
dir	The direction the depot must be facing.
rt	The road type of the depot to draw.

Definition at line 1902 of file road_cmd.cpp.

References _loaded_newgrf_features, _local_company, Catenary, DiagDirToRoadBits(), DrawRailTileSeqInGUI(), DrawSprite(), RoadTypeInfo::flags, GetCompanyPalette(), GetCustomRoadSprite(), GetRoadSpriteOffset(), GetRoadTypeInfo(), DrawTileSprites::ground, INVALID_TILE, ROTSG_DEPOT, ROTSG_OVERLAY, SLOPE_FLAT, PalSpriteID::sprite, BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Test(), and TRAMWAY_REPLACE_DEPOT_WITH_TRACK.

Referenced by BuildRoadDepotWindow::DrawWidget().

◆ UpdateNearestTownForRoadTiles()

void UpdateNearestTownForRoadTiles ( bool invalidate )

Updates cached nearest town for all road tiles.

Parameters

invalidate are we just invalidating cached data?

Precondition: invalidate == true implies _generating_world == true

Definition at line 1945 of file road_cmd.cpp.

References _generating_world, CalcClosestTownFromTile(), HasTownOwnedRoad(), IsRoadDepot(), IsTileType(), Map::Iterate(), Road, and SetTownIndex().

Referenced by AfterLoadGame(), CmdFoundTown(), FoundTownWindow::OnQueryTextFinished(), and Town::PostDestructor().

Variable Documentation

◆ CcBuildRoadTunnel

CommandCallback CcBuildRoadTunnel

Definition at line 37 of file road_cmd.h.

◆ CcPlaySound_CONSTRUCTION_OTHER

CommandCallback CcPlaySound_CONSTRUCTION_OTHER

Definition at line 36 of file road_cmd.h.

Functions

Variables

Detailed Description

Function Documentation

◆ CcRoadDepot()

◆ CcRoadStop()

◆ CmdBuildLongRoad()

◆ CmdBuildRoad()

◆ CmdBuildRoadDepot()

◆ CmdConvertRoad()

◆ CmdRemoveLongRoad()

◆ DrawRoadDepotSprite()

◆ UpdateNearestTownForRoadTiles()

Variable Documentation

◆ CcBuildRoadTunnel

◆ CcPlaySound_CONSTRUCTION_OTHER