Entry point for OpenTTD to YAPF. More...

#include "../../direction_type.h"
#include "../../track_type.h"
#include "../../vehicle_type.h"
#include "../../ship.h"
#include "../../roadveh.h"
#include "../pathfinder_type.h"

Functions
Track	YapfShipChooseTrack (const Ship *v, TileIndex tile, bool &path_found, ShipPathCache &path_cache)
	Finds the best path for given ship using YAPF.

bool	YapfShipCheckReverse (const Ship v, Trackdir trackdir)
	Returns true if it is better to reverse the ship before leaving depot using YAPF.

Trackdir	YapfRoadVehicleChooseTrack (const RoadVehicle *v, TileIndex tile, DiagDirection enterdir, TrackdirBits trackdirs, bool &path_found, RoadVehPathCache &path_cache)
	Finds the best path for given road vehicle using YAPF.

Track	YapfTrainChooseTrack (const Train v, TileIndex tile, DiagDirection enterdir, TrackBits tracks, bool &path_found, bool reserve_track, struct PBSTileInfo target, TileIndex *dest)
	Finds the best path for given train using YAPF.

FindDepotData	YapfRoadVehicleFindNearestDepot (const RoadVehicle *v, int max_penalty)
	Used when user sends road vehicle to the nearest depot or if road vehicle needs servicing using YAPF.

FindDepotData	YapfTrainFindNearestDepot (const Train *v, int max_distance)
	Used when user sends train to the nearest depot or if train needs servicing using YAPF.

bool	YapfTrainCheckReverse (const Train *v)
	Returns true if it is better to reverse the train before leaving station using YAPF.

bool	YapfTrainFindNearestSafeTile (const Train *v, TileIndex tile, Trackdir td, bool override_railtype)
	Try to extend the reserved path of a train to the nearest safe tile using YAPF.

Detailed Description

Entry point for OpenTTD to YAPF.

Definition in file yapf.h.

Function Documentation

◆ YapfRoadVehicleChooseTrack()

Trackdir YapfRoadVehicleChooseTrack	(	const RoadVehicle *	v,
		TileIndex	tile,
		DiagDirection	enterdir,
		TrackdirBits	trackdirs,
		bool &	path_found,
		RoadVehPathCache &	path_cache
	)

Finds the best path for given road vehicle using YAPF.

Parameters

v	the RV that needs to find a path
tile	the tile to find the path from (should be next tile the RV is about to enter)
enterdir	diagonal direction which the RV will enter this new tile from
trackdirs	available trackdirs on the new tile (to choose from)
path_found	[out] Whether a path has been found (true) or has been guessed (false)

Returns: the best trackdir for next turn or INVALID_TRACKDIR if the path could not be found

Definition at line 529 of file yapf_road.cpp.

References _settings_game, YAPFSettings::disable_node_optimization, FindFirstBit(), INVALID_TRACKDIR, GameSettings::pf, and PathfinderSettings::yapf.

Referenced by RoadFindPathToDest().

◆ YapfRoadVehicleFindNearestDepot()

FindDepotData YapfRoadVehicleFindNearestDepot	(	const RoadVehicle *	v,
		int	max_penalty
	)

Used when user sends road vehicle to the nearest depot or if road vehicle needs servicing using YAPF.

Parameters

v	vehicle that needs to go to some depot
max_penalty	max distance (in pathfinder penalty) from the current vehicle position (used also as optimization - the pathfinder can stop path finding if max_penalty was reached and no depot was seen)

Returns: the data about the depot

Definition at line 538 of file yapf_road.cpp.

References _settings_game, YAPFSettings::disable_node_optimization, GetTrackdirBitsForRoad(), RoadVehicle::GetVehicleTrackdir(), HasTrackdir(), GameSettings::pf, RoadVehicle::roadtype, Vehicle::tile, and PathfinderSettings::yapf.

◆ YapfShipCheckReverse()

bool YapfShipCheckReverse	(	const Ship *	v,
		Trackdir *	trackdir
	)

Returns true if it is better to reverse the ship before leaving depot using YAPF.

Parameters

v	the ship leaving the depot
trackdir	[out] the best of all possible reversed trackdirs

Returns: true if reversing is better

Definition at line 436 of file yapf_ship.cpp.

◆ YapfShipChooseTrack()

Track YapfShipChooseTrack	(	const Ship *	v,
		TileIndex	tile,
		bool &	path_found,
		ShipPathCache &	path_cache
	)

Finds the best path for given ship using YAPF.

Parameters

v	the ship that needs to find a path
tile	the tile to find the path from (should be next tile the ship is about to enter)
path_found	[out] Whether a path has been found (true) or has been guessed (false)

Returns: the best trackdir for next turn or INVALID_TRACK if the path could not be found

Finds the best path for given ship using YAPF.

Definition at line 428 of file yapf_ship.cpp.

References Ship::GetVehicleTrackdir(), INVALID_TRACK, INVALID_TRACKDIR, TRACKDIR_BIT_NONE, TrackdirToTrack(), and TrackdirToTrackdirBits().

Referenced by ChooseShipTrack().

◆ YapfTrainCheckReverse()

bool YapfTrainCheckReverse ( const Train * v )

Returns true if it is better to reverse the train before leaving station using YAPF.

Parameters

v	the train leaving the station

Returns: true if reversing is better

Definition at line 563 of file yapf_rail.cpp.

References _settings_game, DistanceManhattan(), PathfinderSettings::forbid_90_deg, GetOtherTunnelBridgeEnd(), GetTunnelBridgeDirection(), Train::GetVehicleTrackdir(), SpecializedVehicle< T, Type >::Last(), GameSettings::pf, ReverseTrackdir(), Vehicle::tile, TileVirtXY(), TRACK_BIT_WORMHOLE, TrackdirToExitdir(), Vehicle::x_pos, Vehicle::y_pos, and YAPF_TILE_LENGTH.

◆ YapfTrainChooseTrack()

Track YapfTrainChooseTrack	(	const Train *	v,
		TileIndex	tile,
		DiagDirection	enterdir,
		TrackBits	tracks,
		bool &	path_found,
		bool	reserve_track,
		struct PBSTileInfo *	target,
		TileIndex *	dest
	)

Finds the best path for given train using YAPF.

Parameters

v	the train that needs to find a path
tile	the tile to find the path from (should be next tile the train is about to enter)
enterdir	diagonal direction which the RV will enter this new tile from
tracks	available trackdirs on the new tile (to choose from)
path_found	[out] Whether a path has been found (true) or has been guessed (false)
reserve_track	indicates whether YAPF should try to reserve the found path
target	[out] the target tile of the reservation, free is set to true if path was reserved
dest	[out] the final tile of the best path found

Returns: the best track for next turn

Definition at line 554 of file yapf_rail.cpp.

References _settings_game, FindFirstTrack(), PathfinderSettings::forbid_90_deg, INVALID_TRACKDIR, GameSettings::pf, and TrackdirToTrack().

Referenced by DoTrainPathfind().

◆ YapfTrainFindNearestDepot()

FindDepotData YapfTrainFindNearestDepot	(	const Train *	v,
		int	max_distance
	)

Used when user sends train to the nearest depot or if train needs servicing using YAPF.

Parameters

v	train that needs to go to some depot
max_distance	max distance (int pathfinder penalty) from the current train position (used also as optimization - the pathfinder can stop path finding if max_penalty was reached and no depot was seen)

Returns: the data about the depot

Definition at line 616 of file yapf_rail.cpp.

References _settings_game, FollowTrainReservation(), PathfinderSettings::forbid_90_deg, Train::GetVehicleTrackdir(), SpecializedVehicle< T, Type >::Last(), GameSettings::pf, ReverseTrackdir(), PBSTileInfo::tile, Vehicle::tile, PBSTileInfo::trackdir, and YAPF_INFINITE_PENALTY.

Referenced by FindClosestTrainDepot().

◆ YapfTrainFindNearestSafeTile()

bool YapfTrainFindNearestSafeTile	(	const Train *	v,
		TileIndex	tile,
		Trackdir	td,
		bool	override_railtype
	)

Try to extend the reserved path of a train to the nearest safe tile using YAPF.

Parameters

v	The train that needs to find a safe tile.
tile	Last tile of the current reserved path.
td	Last trackdir of the current reserved path.
override_railtype	Should all physically compatible railtypes be searched, even if the vehicle can't run on them on its own?

Returns: True if the path could be extended to a safe tile.

Definition at line 629 of file yapf_rail.cpp.

References _settings_game, PathfinderSettings::forbid_90_deg, and GameSettings::pf.

Referenced by TryReserveSafeTrack().

Functions

Detailed Description

Function Documentation

◆ YapfRoadVehicleChooseTrack()

◆ YapfRoadVehicleFindNearestDepot()

◆ YapfShipCheckReverse()

◆ YapfShipChooseTrack()

◆ YapfTrainCheckReverse()

◆ YapfTrainChooseTrack()

◆ YapfTrainFindNearestDepot()

◆ YapfTrainFindNearestSafeTile()