HelpCommand.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.queue.CommandQueue;
import com.realtime.crossfire.jxclient.server.crossfire.CrossfireServerConnection;
import org.jetbrains.annotations.NotNull;
 
public class HelpCommand extends AbstractCommand {
 
    @NotNull
    private final CommandQueue commandQueue;
 
    @NotNull
    private final Commands commands;
 
    public HelpCommand(@NotNull final CrossfireServerConnection crossfireServerConnection, @NotNull final CommandQueue commandQueue, @NotNull final Commands commands) {
        super("help", crossfireServerConnection);
        this.commandQueue = commandQueue;
        this.commands = commands;
    }
 
    @Override
    public boolean allArguments() {
        return false;
    }
 
    @Override
    public void execute(@NotNull final String args) {
        if (args.isEmpty()) {
            commandQueue.sendNcom(true, "help "+args);
            return;
        }
 
        if (args.equalsIgnoreCase("commands")) {
            final StringBuilder sb = new StringBuilder();
            String separator = "    Client-sided commands:\n";
            for (final String command : commands.getCommands()) {
                sb.append(separator).append(command);
                separator = " ";
            }
            sb.append("\n");
            drawInfo(sb.toString());
            commandQueue.sendNcom(true, "help "+args);
            return;
        }
 
        final Command command = commands.findCommand(args);
        if (command == null || command instanceof HelpCommand) {
            commandQueue.sendNcom(true, "help "+args);
            return;
        }
 
        drawInfo("Help about '"+args+"'\n"+command.getHelp().trim());
    }
 
    @NotNull
    @Override
    public String getHelp() {
        return "";
    }
 
}