mirror of https://github.com/cabaletta/baritone
58 lines
1.8 KiB
Java
58 lines
1.8 KiB
Java
/*
|
|
* This file is part of Baritone.
|
|
*
|
|
* Baritone is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Lesser General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* Baritone is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public License
|
|
* along with Baritone. If not, see <https://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
package baritone.api.pathing.goals;
|
|
|
|
import net.minecraft.util.math.BlockPos;
|
|
|
|
/**
|
|
* An abstract Goal for pathing, can be anything from a specific block to just a Y coordinate.
|
|
*
|
|
* @author leijurv
|
|
*/
|
|
public interface Goal {
|
|
|
|
/**
|
|
* Returns whether or not the specified position
|
|
* meets the requirement for this goal based.
|
|
*
|
|
* @param x The goal X position
|
|
* @param y The goal Y position
|
|
* @param z The goal Z position
|
|
* @return Whether or not it satisfies this goal
|
|
*/
|
|
boolean isInGoal(int x, int y, int z);
|
|
|
|
/**
|
|
* Estimate the number of ticks it will take to get to the goal
|
|
*
|
|
* @param x The goal X position
|
|
* @param y The goal Y position
|
|
* @param z The goal Z position
|
|
* @return The estimate number of ticks to satisfy the goal
|
|
*/
|
|
double heuristic(int x, int y, int z);
|
|
|
|
default boolean isInGoal(BlockPos pos) {
|
|
return isInGoal(pos.getX(), pos.getY(), pos.getZ());
|
|
}
|
|
|
|
default double heuristic(BlockPos pos) {
|
|
return heuristic(pos.getX(), pos.getY(), pos.getZ());
|
|
}
|
|
}
|