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.world.entity.Entity;
021import net.minecraft.world.item.ItemStack;
022
023import java.util.List;
024import java.util.function.Predicate;
025
026/**
027 * @author Brady
028 * @since 9/23/2018
029 */
030public interface IFollowProcess extends IBaritoneProcess {
031
032    /**
033     * Set the follow target to any entities matching this predicate
034     *
035     * @param filter the predicate
036     */
037    void follow(Predicate<Entity> filter);
038
039    /**
040     * Try to pick up any items matching this predicate
041     *
042     * @param filter the predicate
043     */
044    void pickup(Predicate<ItemStack> filter);
045
046    /**
047     * @return The entities that are currently being followed. null if not currently following, empty if nothing matches the predicate
048     */
049    List<Entity> following();
050
051    Predicate<Entity> currentFilter();
052
053    /**
054     * Cancels the follow behavior, this will clear the current follow target.
055     */
056    default void cancel() {
057        onLostControl();
058    }
059}