Archives/OpenTTD-patches
2
0
Fork 0
mirror of https://github.com/JGRennison/OpenTTD-patches.git synced 2024-11-17 21:25:40 +00:00
Code Issues Packages Projects Releases Wiki Activity

(svn r18368) -Fix: alignment of comment and 'add' some missing comments

Browse Source
This commit is contained in:
rubidium 2009-12-02 00:01:07 +00:00
parent 76fe20cdcc
commit 9d5ff5def0
4 changed files with 21 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/pathfinder/npf/npf.cpp
View File

@ -1133,9 +1133,9 @@ Track NPFShipChooseTrack(Ship *v, TileIndex tile, DiagDirection enterdir, TrackB
NPFFoundTargetData ftd = NPFRouteToStationOrTile(tile - TileOffsByDiagDir(enterdir), trackdir, true, &fstd, TRANSPORT_WATER, 0, v->owner, INVALID_RAILTYPES); NPFFoundTargetData ftd = NPFRouteToStationOrTile(tile - TileOffsByDiagDir(enterdir), trackdir, true, &fstd, TRANSPORT_WATER, 0, v->owner, INVALID_RAILTYPES);
/* If ftd.best_bird_dist is 0, we found our target and ftd.best_trackdir contains /* If ftd.best_bird_dist is 0, we found our target and ftd.best_trackdir contains
* the direction we need to take to get there, if ftd.best_bird_dist is not 0, * the direction we need to take to get there, if ftd.best_bird_dist is not 0,
* we did not find our target, but ftd.best_trackdir contains the direction leading * we did not find our target, but ftd.best_trackdir contains the direction leading
* to the tile closest to our target. */ * to the tile closest to our target. */
if (ftd.best_trackdir == 0xff) return INVALID_TRACK; if (ftd.best_trackdir == 0xff) return INVALID_TRACK;
return TrackdirToTrack(ftd.best_trackdir); return TrackdirToTrack(ftd.best_trackdir);
} }

8
src/pathfinder/npf/npf_func.h
View File

@ -12,6 +12,14 @@
#ifndef NPF_FUNC_H #ifndef NPF_FUNC_H
#define NPF_FUNC_H #define NPF_FUNC_H
/**
* Finds the best path for given ship using NPF.
* @param v the ship that needs to find a path
* @param tile the tile to find the path from (should be next tile the ship is about to enter)
* @param enterdir diagonal direction which the ship will enter this new tile from
* @param tracks available tracks on the new tile (to choose from)
* @return the best trackdir for next turn or INVALID_TRACK if the path could not be found
*/
Track NPFShipChooseTrack(class Ship *v, TileIndex tile, DiagDirection enterdir, TrackBits tracks); Track NPFShipChooseTrack(class Ship *v, TileIndex tile, DiagDirection enterdir, TrackBits tracks);
#endif /* NPF_FUNC_H */ #endif /* NPF_FUNC_H */

8
src/pathfinder/opf/opf_ship.h
View File

@ -12,6 +12,14 @@
#ifndef OPF_SHIP_H #ifndef OPF_SHIP_H
#define OPF_SHIP_H #define OPF_SHIP_H
/**
* Finds the best path for given ship using OPF.
* @param v the ship that needs to find a path
* @param tile the tile to find the path from (should be next tile the ship is about to enter)
* @param enterdir diagonal direction which the ship will enter this new tile from
* @param tracks available tracks on the new tile (to choose from)
* @return the best trackdir for next turn or INVALID_TRACK if the path could not be found
*/
Track OPFShipChooseTrack(Ship *v, TileIndex tile, DiagDirection enterdir, TrackBits tracks); Track OPFShipChooseTrack(Ship *v, TileIndex tile, DiagDirection enterdir, TrackBits tracks);
#endif /* OPF_SHIP_H */ #endif /* OPF_SHIP_H */

3
src/pathfinder/yapf/yapf.h
View File

@ -15,7 +15,8 @@
#include "../../direction_type.h" #include "../../direction_type.h"
#include "../../station_type.h" #include "../../station_type.h"
/** Finds the best path for given ship. /**
* Finds the best path for given ship using YAPF.
* @param v the ship that needs to find a path * @param v the ship that needs to find a path
* @param tile the tile to find the path from (should be next tile the ship is about to enter) * @param tile the tile to find the path from (should be next tile the ship is about to enter)
* @param enterdir diagonal direction which the ship will enter this new tile from * @param enterdir diagonal direction which the ship will enter this new tile from