ExCommandHandler.java

package com.denizenscript.denizen.utilities.command;

import com.denizenscript.denizen.objects.NPCTag;
import com.denizenscript.denizen.objects.PlayerTag;
import com.denizenscript.denizen.utilities.FormattedTextHelper;
import com.denizenscript.denizen.utilities.Settings;
import com.denizenscript.denizencore.utilities.CoreConfiguration;
import com.denizenscript.denizen.utilities.depends.Depends;
import com.denizenscript.denizen.utilities.implementation.BukkitScriptEntryData;
import com.denizenscript.denizencore.scripts.ScriptBuilder;
import com.denizenscript.denizencore.scripts.ScriptEntry;
import com.denizenscript.denizencore.scripts.commands.core.FlagCommand;
import com.denizenscript.denizencore.scripts.queues.core.InstantQueue;
import com.denizenscript.denizencore.utilities.ExCommandHelper;
import org.bukkit.ChatColor;
import org.bukkit.command.*;
import org.bukkit.entity.Player;

import java.util.ArrayList;
import java.util.List;

public class ExCommandHandler implements CommandExecutor, TabCompleter {

    public void enableFor(PluginCommand command) {
        command.setExecutor(this);
        command.setTabCompleter(this);
    }

    @Override
    public boolean onCommand(CommandSender sender, Command cmd, String alias, String[] args) {

        // <--[language]
        // @name /ex command
        // @group Console Commands
        // @description
        // The '/ex' command is an easy way to run a single denizen script command in-game.
        // 'Ex' is short for 'Execute'.
        // Its syntax, aside from '/ex' is exactly the same as any other Denizen script command.
        // When running a command, some context is also supplied, such as '<player>' if being run by a player (versus the console),
        // as well as '<npc>' if a NPC is selected by using the '/npc sel' command.
        //
        // By default, ex command debug output is sent to the player that ran the ex command (if the command was ran by a player).
        // To avoid this, use '-q' at the start of the ex command.
        // Like: /ex -q narrate "wow no output"
        //
        // The '/ex' command creates a new queue each time it's run,
        // meaning for example '/ex define' would do nothing, as the definition will be lost immediately.
        //
        // If you need to sustain a queue between multiple executions, use '/exs' ("Execute Sustained").
        // A sustained queue will use the same queue on every execution until the queue stops (normally due to '/exs stop').
        // Be warned that waits will block the sustained queue - eg '/exs wait 10m' will make '/exs' effectively unusable for 10 minutes.
        //
        // Examples:
        // /ex flag <player> test_flag:!
        // /ex run npc_walk_script
        //
        // Need to '/ex' a command as a different player or NPC? Use <@link language The Player and NPC Arguments>.
        //
        // Examples:
        // /ex narrate player:<[aplayer]> 'Your health is <player.health.formatted>.'
        // /ex walk npc:<[some_npc]> <player.cursor_on>
        //
        // -->

        if (cmd.getName().equalsIgnoreCase("ex")) {
            List<Object> entries = new ArrayList<>();
            String entry = String.join(" ", args);
            boolean quiet = !Settings.showExDebug();
            if (entry.length() > 3 && entry.startsWith("-q ")) {
                quiet = !quiet;
                entry = entry.substring("-q ".length());
            }
            if (entry.length() < 2) {
                sender.sendMessage("/ex (-q) <denizen script command> (arguments)");
                return true;
            }
            if (Settings.showExHelp()) {
                if (CoreConfiguration.shouldShowDebug) {
                    if (quiet) {
                        sender.sendMessage(ChatColor.YELLOW + "Executing Denizen script command... check the console for full debug output!");
                    }
                    else {
                        //sender.sendMessage(ChatColor.YELLOW + "Executing Denizen script command...");
                    }
                }
                else {
                    sender.sendMessage(ChatColor.YELLOW + "Executing Denizen script command... to see debug, use /denizen debug");
                }
            }
            entries.add(entry);
            InstantQueue queue = new InstantQueue("EXCOMMAND");
            NPCTag npc = null;
            if (Depends.citizens != null && Depends.citizens.getNPCSelector().getSelected(sender) != null) {
                npc = new NPCTag(Depends.citizens.getNPCSelector().getSelected(sender));
            }
            List<ScriptEntry> scriptEntries = ScriptBuilder.buildScriptEntries(entries, null,
                    new BukkitScriptEntryData(sender instanceof Player ? new PlayerTag((Player) sender) : null, npc));
            queue.addEntries(scriptEntries);
            if (!quiet && sender instanceof Player) {
                final Player player = (Player) sender;
                queue.debugOutput = (s) -> {
                    player.spigot().sendMessage(FormattedTextHelper.parse(s.replace("<FORCE_ALIGN>", ""), net.md_5.bungee.api.ChatColor.WHITE));
                };
            }
            queue.start();
            return true;
        }
        return false;
    }

    @Override
    public List<String> onTabComplete(CommandSender sender, Command cmd, String cmdName, String[] rawArgs) {
        if ((!cmdName.equalsIgnoreCase("ex") && !cmdName.equalsIgnoreCase("exs")) || !sender.hasPermission("denizen.ex")) {
            return null;
        }
        return ExCommandHelper.buildTabCompletions(rawArgs, (dcmd, completionsBuilder) -> {
            if (dcmd instanceof FlagCommand) {
                if (sender instanceof Player) {
                    for (String flagName : new PlayerTag((Player) sender).getFlagTracker().listAllFlags()) {
                        if (!flagName.startsWith("__")) {
                            completionsBuilder.add(flagName);
                        }
                    }
                }
                if (Depends.citizens != null && Depends.citizens.getNPCSelector().getSelected(sender) != null) {
                    for (String flagName : new NPCTag(Depends.citizens.getNPCSelector().getSelected(sender)).getFlagTracker().listAllFlags()) {
                        if (!flagName.startsWith("__")) {
                            completionsBuilder.add(flagName);
                        }
                    }
                }
            }
        });
    }
}