ILookBehavior.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.behavior;

import baritone.api.Settings;
import baritone.api.behavior.look.IAimProcessor;
import baritone.api.utils.Rotation;

/**
 * @author Brady
 * @since 9/23/2018
 */
public interface ILookBehavior extends IBehavior {

    /**
     * Updates the current {@link ILookBehavior} target to target the specified rotations on the next tick. If any sort
     * of block interaction is required, {@code blockInteract} should be {@code true}. It is not guaranteed that the
     * rotations set by the caller will be the exact rotations expressed by the client (This is due to settings like
     * {@link Settings#randomLooking}). If the rotations produced by this behavior are required, then the
     * {@link #getAimProcessor() aim processor} should be used.
     *
     * @param rotation      The target rotations
     * @param blockInteract Whether the target rotations are needed for a block interaction
     */
    void updateTarget(Rotation rotation, boolean blockInteract);

    /**
     * Updates the current {@link ILookBehavior} target and optionally restarts
     * any active interpolation.
     *
     * @param rotation             The target rotations
     * @param blockInteract        Whether the target rotations are needed for a block interaction
     * @param restartInterpolation Whether active interpolation should restart
     *                             from its current sample
     * @see #updateTarget(Rotation, boolean)
     */
    default void updateTarget(
            Rotation rotation,
            boolean blockInteract,
            boolean restartInterpolation) {
        updateTarget(rotation, blockInteract);
    }

    /**
     * Updates the current {@link ILookBehavior} target and optionally uses it
     * without aim processing.
     *
     * @param rotation             The target rotations
     * @param blockInteract        Whether the target rotations are needed for a block interaction
     * @param restartInterpolation Whether active interpolation should restart
     *                             from its current sample
     * @param exactRotation        Whether the target rotation should skip aim processing
     * @see #updateTarget(Rotation, boolean, boolean)
     */
    default void updateTarget(
            Rotation rotation,
            boolean blockInteract,
            boolean restartInterpolation,
            boolean exactRotation) {
        updateTarget(rotation, blockInteract, restartInterpolation);
    }

    /**
     * The aim processor instance for this {@link ILookBehavior}, which is responsible for applying additional,
     * deterministic transformations to the target rotation set by {@link #updateTarget}.
     *
     * @return The aim processor
     * @see IAimProcessor#fork
     */
    IAimProcessor getAimProcessor();
}