/*
 * SoulFire
 * Copyright (C) 2026  AlexProgrammerDE
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
package com.soulfiremc.server.pathfinding.goals;

import com.soulfiremc.server.pathfinding.MinecraftRouteNode;
import com.soulfiremc.server.pathfinding.SFVec3i;
import com.soulfiremc.server.pathfinding.execution.WorldAction;
import com.soulfiremc.server.pathfinding.graph.MinecraftGraph;

import java.util.List;

/// A goal represents something that the user wants the bot to achieve.
public interface GoalScorer {
  /// Calculates the estimated score for a given block position to the goal. Usually this means the
  /// distance from achieving the goal.
  ///
  /// @param graph         the graph to calculate the score for
  /// @param blockPosition the block position to calculate the score for
  /// @param actions       the actions that have been executed to reach the current state
  /// @return the score for the given world state
  double computeScore(MinecraftGraph graph, SFVec3i blockPosition, List<WorldAction> actions);

  /// Checks if the given world state indicates that the goal is reached.
  ///
  /// @param current the node to check
  /// @return true if the goal is reached, false otherwise
  boolean isFinished(MinecraftRouteNode current);
}
