001/*
002 * This file is part of Baritone.
003 *
004 * Baritone is free software: you can redistribute it and/or modify
005 * it under the terms of the GNU Lesser General Public License as published by
006 * the Free Software Foundation, either version 3 of the License, or
007 * (at your option) any later version.
008 *
009 * Baritone is distributed in the hope that it will be useful,
010 * but WITHOUT ANY WARRANTY; without even the implied warranty of
011 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
012 * GNU Lesser General Public License for more details.
013 *
014 * You should have received a copy of the GNU Lesser General Public License
015 * along with Baritone.  If not, see <https://www.gnu.org/licenses/>.
016 */
017
018package baritone.api.process;
019
020import net.minecraft.entity.Entity;
021
022import java.util.List;
023import java.util.function.Predicate;
024
025/**
026 * @author Brady
027 * @since 9/23/2018
028 */
029public interface IFollowProcess extends IBaritoneProcess {
030
031    /**
032     * Set the follow target to any entities matching this predicate
033     *
034     * @param filter the predicate
035     */
036    void follow(Predicate<Entity> filter);
037
038    /**
039     * @return The entities that are currently being followed. null if not currently following, empty if nothing matches the predicate
040     */
041    List<Entity> following();
042
043    Predicate<Entity> currentFilter();
044
045    /**
046     * Cancels the follow behavior, this will clear the current follow target.
047     */
048    default void cancel() {
049        onLostControl();
050    }
051}