From 9afcdedf8100f5095bb00fb1e5d89c13730ebd19 Mon Sep 17 00:00:00 2001 From: Leijurv Date: Fri, 3 Aug 2018 12:52:25 -0400 Subject: [PATCH] javadocs --- .../baritone/bot/pathing/calc/PathNode.java | 29 +++++++++++++++++-- 1 file changed, 26 insertions(+), 3 deletions(-) diff --git a/src/main/java/baritone/bot/pathing/calc/PathNode.java b/src/main/java/baritone/bot/pathing/calc/PathNode.java index 9ee0dcb76..1472af672 100644 --- a/src/main/java/baritone/bot/pathing/calc/PathNode.java +++ b/src/main/java/baritone/bot/pathing/calc/PathNode.java @@ -12,20 +12,43 @@ import java.util.Objects; * @author leijurv */ class PathNode { - + /** + * The position of this node + */ final BlockPos pos; - + + /** + * The goal it's going towards + */ final Goal goal; + /** + * Cached, should always be equal to goal.heuristic(pos) + */ final double estimatedCostToGoal; - // These three fields are mutable and are changed by PathFinder + /** + * Total cost of getting from start to here + * Mutable and changed by PathFinder + */ double cost; + /** + * Should always be equal to estimatedCosttoGoal + cost + * Mutable and changed by PathFinder + */ public double combinedCost; + /** + * In the graph search, what previous node contributed to the cost + * Mutable and changed by PathFinder + */ PathNode previous; + /** + * In the graph search, what previous movement (edge) was taken to get to here + * Mutable and changed by PathFinder + */ Movement previousMovement; /**