ScriptCommand.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
 *
 * Copyright (C) 2005-2008 Yann Chachkoff
 * Copyright (C) 2006-2017,2019-2023 Andreas Kirschbaum
 * Copyright (C) 2010-2012,2014-2018,2020-2023 Nicolas Weeger
 */
 
package com.realtime.crossfire.jxclient.commands;
 
import com.realtime.crossfire.jxclient.scripts.ScriptManager;
import com.realtime.crossfire.jxclient.server.crossfire.CrossfireServerConnection;
import org.jetbrains.annotations.NotNull;
 
public class ScriptCommand extends AbstractCommand {
 
    @NotNull
    private final ScriptManager scriptManager;
 
    public ScriptCommand(@NotNull final ScriptManager scriptManager, @NotNull final CrossfireServerConnection crossfireServerConnection) {
        super("script", crossfireServerConnection);
        this.scriptManager = scriptManager;
    }
 
    @Override
    public boolean allArguments() {
        return false;
    }
 
    @Override
    public void execute(@NotNull final String args) {
        if (args.isEmpty()) {
            drawInfoError("Which script do you want to run?");
            return;
        }
 
        scriptManager.newScript(args);
    }
 
    @NotNull
    @Override
    public String getHelp() {
        //noinspection StringBufferReplaceableByString
        final StringBuilder sb = new StringBuilder();
        sb.append("Starts a client-sided script\n");
        sb.append("\n");
        sb.append("Usage: script <command>\n");
        sb.append("\n");
        sb.append("Starts the external command <command> as a client-sided script. ");
        sb.append("<command> is an arbitrary external program that implements the protocol for client-sided scripts.\n");
        sb.append("Note: List running client-sided scripts: scripts\n");
        sb.append("Note: Stop a client-sided script: scriptkill\n");
        return sb.toString();
    }
 
}