ScriptkillCommand.java

Go to the documentation of this file.

/*
 * This file is part of JXClient, the Fullscreen Java Crossfire Client.
 *
 * JXClient is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * JXClient 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with JXClient; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 *
 */
 
package com.realtime.crossfire.jxclient.commands;
 
import com.realtime.crossfire.jxclient.scripts.ScriptManager;
import com.realtime.crossfire.jxclient.scripts.ScriptProcess;
import com.realtime.crossfire.jxclient.server.crossfire.CrossfireServerConnection;
import java.util.Collection;
import org.jetbrains.annotations.NotNull;
 
public class ScriptkillCommand extends AbstractCommand {
 
    @NotNull
    private final ScriptManager scriptManager;
 
    public ScriptkillCommand(@NotNull final ScriptManager scriptManager, @NotNull final CrossfireServerConnection crossfireServerConnection) {
        super("scriptkill", crossfireServerConnection);
        this.scriptManager = scriptManager;
    }
 
    @Override
    public boolean allArguments() {
        return false;
    }
 
    @Override
    public void execute(@NotNull final String args) {
        final Collection<ScriptProcess> scriptProcesses = scriptManager.getScripts(args);
        if (scriptProcesses.isEmpty()) {
            drawInfoError(scriptManager.hasScripts() ? "No matching scripts." : "No scripts running.");
            return;
        }
        if (scriptProcesses.size() > 1) {
            drawInfoError("More than one script matches: "+scriptProcesses+".");
            return;
        }
        final ScriptProcess scriptProcess = scriptProcesses.iterator().next();
        scriptProcess.killScript();
    }
 
    @NotNull
    @Override
    public String getHelp() {
        //noinspection StringBufferReplaceableByString
        final StringBuilder sb = new StringBuilder();
        sb.append("Stops a running client-sided script\n");
        sb.append("\n");
        sb.append("Usage: scriptkill\n");
        sb.append("Usage: scriptkill <script>\n");
        sb.append("\n");
        sb.append("Stops the running client-sided script <script>. ");
        sb.append("<script> is the ID of a running client-sided script or the partial name of a running client-sided script. ");
        sb.append("If only one client-sided script is running, <script> may be omitted.\n");
        sb.append("Note: Kill more than one or even all client-sided scripts: scriptkillall\n");
        return sb.toString();
    }
 
}