baritone/src/main/java/baritone/utils/command/defaults/PauseResumeCommands.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.utils.command.defaults;

import baritone.api.IBaritone;
import baritone.api.Settings;
import baritone.api.process.IBaritoneProcess;
import baritone.api.process.PathingCommand;
import baritone.api.process.PathingCommandType;
import baritone.api.utils.command.Command;
import baritone.api.utils.command.exception.CommandInvalidStateException;
import baritone.api.utils.command.helpers.arguments.ArgConsumer;

import java.util.List;
import java.util.stream.Stream;

import static java.util.Arrays.asList;

/**
 * Contains the pause, resume, and paused commands.
 * <p>
 * This thing is scoped to hell, private so far you can't even access it using reflection, because you AREN'T SUPPOSED
 * TO USE THIS to pause and resume Baritone. Make your own process that returns {@link PathingCommandType#REQUEST_PAUSE
 * REQUEST_PAUSE} as needed.
 */
public class PauseResumeCommands {

    private final IBaritone baritone;
    Command pauseCommand;
    Command resumeCommand;
    Command pausedCommand;

    public PauseResumeCommands(IBaritone baritone) {
        this.baritone = baritone;
        // array for mutability, non-field so reflection can't touch it
        final boolean[] paused = {false};

        baritone.getPathingControlManager().registerProcess(
                new IBaritoneProcess() {
                    @Override
                    public boolean isActive() {
                        return paused[0];
                    }

                    @Override
                    public PathingCommand onTick(boolean calcFailed, boolean isSafeToCancel) {
                        return new PathingCommand(null, PathingCommandType.REQUEST_PAUSE);
                    }

                    @Override
                    public boolean isTemporary() {
                        return true;
                    }

                    @Override
                    public void onLostControl() {}

                    @Override
                    public double priority() {
                        return DEFAULT_PRIORITY + 1;
                    }

                    @Override
                    public String displayName0() {
                        return "Pause/Resume Commands";
                    }
                }
        );

        pauseCommand = new Command(baritone, "pause") {
            @Override
            protected void executed(String label, ArgConsumer args, Settings settings) {
                args.requireMax(0);

                if (paused[0]) {
                    throw new CommandInvalidStateException("Already paused");
                }

                paused[0] = true;
                logDirect("Paused");
            }

            @Override
            protected Stream<String> tabCompleted(String label, ArgConsumer args, Settings settings) {
                return Stream.empty();
            }

            @Override
            public String getShortDesc() {
                return "Pauses Baritone until you use resume";
            }

            @Override
            public List<String> getLongDesc() {
                return asList(
                        "The pause command tells Baritone to temporarily stop whatever it's doing.",
                        "",
                        "This can be used to pause pathing, building, following, whatever. A single use of the resume command will start it right back up again!",
                        "",
                        "Usage:",
                        "> pause"
                );
            }
        };

        resumeCommand = new Command(baritone, "resume") {
            @Override
            protected void executed(String label, ArgConsumer args, Settings settings) {
                args.requireMax(0);

                if (!paused[0]) {
                    throw new CommandInvalidStateException("Not paused");
                }

                paused[0] = false;
                logDirect("Resumed");
            }

            @Override
            protected Stream<String> tabCompleted(String label, ArgConsumer args, Settings settings) {
                return Stream.empty();
            }

            @Override
            public String getShortDesc() {
                return "Resumes Baritone after a pause";
            }

            @Override
            public List<String> getLongDesc() {
                return asList(
                        "The resume command tells Baritone to resume whatever it was doing when you last used pause.",
                        "",
                        "Usage:",
                        "> resume"
                );
            }
        };

        pausedCommand = new Command(baritone, "paused") {
            @Override
            protected void executed(String label, ArgConsumer args, Settings settings) {
                args.requireMax(0);

                logDirect(String.format("Baritone is %spaused", paused[0] ? "" : "not "));
            }

            @Override
            protected Stream<String> tabCompleted(String label, ArgConsumer args, Settings settings) {
                return Stream.empty();
            }

            @Override
            public String getShortDesc() {
                return "Tells you if Baritone is paused";
            }

            @Override
            public List<String> getLongDesc() {
                return asList(
                        "The paused command tells you if Baritone is currently paused by use of the pause command.",
                        "",
                        "Usage:",
                        "> paused"
                );
            }
        };
    }
}