diff options
Diffstat (limited to 'src/Mobs/PathFinder.h')
| -rw-r--r-- | src/Mobs/PathFinder.h | 37 |
1 files changed, 24 insertions, 13 deletions
diff --git a/src/Mobs/PathFinder.h b/src/Mobs/PathFinder.h index a4843744a..0c7c8aa5f 100644 --- a/src/Mobs/PathFinder.h +++ b/src/Mobs/PathFinder.h @@ -7,11 +7,12 @@ /** This class wraps cPath. cPath is a "dumb device" - You give it point A and point B, and it returns a full path path. cPathFinder - You give it a constant stream of point A (where you are) and point B (where you want to go), -and it tells you where to go next. It manages path recalculation internally, and is much more efficient that calling cPath every step. */ +and it tells you where to go next. It manages path recalculation internally, and is much more efficient that calling +cPath every step. */ class cPathFinder { -public: + public: /** Creates a cPathFinder instance. Each mob should have one cPathFinder throughout its lifetime. @param a_MobWidth The mob width. @param a_MobHeight The mob height. @@ -23,23 +24,32 @@ public: The mob is expected to call this function tick as long as it is following a path. @param a_Chunk The chunk in which the mob is currently at. @param a_Source The mob's position. a_Source's coordinates are expected to be within the chunk given in a_Chunk. - @param a_Destination The position the mob would like to reach. If a_ExactPath is true, the PathFinder may modify this. + @param a_Destination The position the mob would like to reach. If a_ExactPath is true, the PathFinder may modify + this. @param a_OutputWaypoint An output parameter: The next waypoint to go to. @param a_DontCare If true, the mob doesn't care where to go, and the Pathfinder may modify a_Destination. This should usually be false. An exception is a wandering idle mob which doesn't care about its final destination. In the future, idle mobs shouldn't use A* at all. Returns an ePathFinderStatus. - ePathFinderStatus:CALCULATING - The PathFinder is still processing a path. Nothing was written to a_OutputWaypoint. The mob should probably not move. - ePathFinderStatus:PATH_FOUND - The PathFinder has found a path to the target. The next waypoint was written a_OutputWaypoint. The mob should probably move to a_OutputWaypoint. - ePathFinderStatus:NEARBY_FOUND - The PathFinder did not find a destination to the target but did find a nearby spot. The next waypoint was written a_OutputWaypoint. The mob should probably move to a_OutputWaypoint. - ePathFinderStatus:PATH_NOT_FOUND - The PathFinder did not find a destination to the target. Nothing was written to a_OutputWaypoint. The mob should probably not move. + ePathFinderStatus:CALCULATING - The PathFinder is still processing a path. Nothing was written to a_OutputWaypoint. + The mob should probably not move. ePathFinderStatus:PATH_FOUND - The PathFinder has found a path to the target. The + next waypoint was written a_OutputWaypoint. The mob should probably move to a_OutputWaypoint. + ePathFinderStatus:NEARBY_FOUND - The PathFinder did not find a destination to the target but did find a nearby spot. + The next waypoint was written a_OutputWaypoint. The mob should probably move to a_OutputWaypoint. + ePathFinderStatus:PATH_NOT_FOUND - The PathFinder did not find a destination to the target. Nothing was written to + a_OutputWaypoint. The mob should probably not move. Note: Once NEARBY_FOUND is returned once, subsequent calls return PATH_FOUND. */ - ePathFinderStatus GetNextWayPoint(cChunk & a_Chunk, const Vector3d & a_Source, Vector3d * a_Destination, Vector3d * a_OutputWaypoint, bool a_DontCare = false); - -private: - + ePathFinderStatus GetNextWayPoint( + cChunk & a_Chunk, + const Vector3d & a_Source, + Vector3d * a_Destination, + Vector3d * a_OutputWaypoint, + bool a_DontCare = false + ); + + private: /** The width of the Mob which owns this PathFinder. */ float m_Width; @@ -78,11 +88,12 @@ private: /** Ensures the location is not in the air or under water. May change the Y coordinate of the given vector. 1. If a_Vector is the position of water, a_Vector's Y will be modified to point to the first air block above it. - 2. If a_Vector is the position of air, a_Vector's Y will be modified to point to the first airblock below it which has solid or water beneath. */ + 2. If a_Vector is the position of air, a_Vector's Y will be modified to point to the first airblock below it which + has solid or water beneath. */ bool EnsureProperPoint(Vector3d & a_Vector, cChunk & a_Chunk); /** Resets a pathfinding task, typically because m_FinalDestination has deviated too much from m_DeviationOrigin. */ - void ResetPathFinding(cChunk &a_Chunk); + void ResetPathFinding(cChunk & a_Chunk); /** Return true the the blocktype is either water or solid */ bool IsWaterOrSolid(BLOCKTYPE a_BlockType); |