Shortcut.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.shortcuts;
 
import com.realtime.crossfire.jxclient.faces.Face;
import com.realtime.crossfire.jxclient.spells.Spell;
import com.realtime.crossfire.jxclient.util.EventListenerList2;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
 
public class Shortcut {
 
    @NotNull
    private String command;
 
    @Nullable
    private final Spell spell;
 
    @NotNull
    private final EventListenerList2<ShortcutListener> listeners = new EventListenerList2<>();
 
    public Shortcut(@NotNull final String command, @Nullable final Spell spell) {
        this.command = command;
        this.spell = spell;
 
        if (this.spell != null) {
            this.spell.addSpellListener(this::fireModifiedEvent);
        }
    }
 
    @NotNull
    public String getCommand() {
        return command;
    }
 
    @Nullable
    public Spell getSpell() {
        return spell;
    }
 
    public void dispose() {
        if (spell != null) {
            spell.removeSpellListener(this::fireModifiedEvent);
        }
    }
 
    public void addShortcutListener(@NotNull final ShortcutListener listener) {
        listeners.add(listener);
    }
 
    public void removeShortcutListener(@NotNull final ShortcutListener listener) {
        listeners.add(listener);
    }
 
    private void fireModifiedEvent() {
        for (ShortcutListener listener : listeners) {
            listener.shortcutModified();
        }
    }
 
    @NotNull
    public String getTooltipText() {
        if (spell != null) {
            return command+"\n"+spell.getTooltipText();
        }
        return command;
    }
 
    public boolean displaysFace(@NotNull final Face face) {
        return spell != null && face.getFaceNum() == spell.getFaceNum();
    }
 
    public boolean isImmediate() {
        return command.startsWith("invoke ") || command.startsWith("use_skill ");
    }
 
    public void toggleImmediate() {
        if (command.startsWith("cast ")) {
            command = "invoke "+command.substring(5);
            fireModifiedEvent();
        } else if (command.startsWith("invoke ")) {
            command = "cast "+command.substring(7);
            fireModifiedEvent();
        } else if (command.startsWith("ready_skill ")) {
            command = "use_skill "+command.substring(12);
            fireModifiedEvent();
        } else if (command.startsWith("use_skill ")) {
            command = "ready_skill "+command.substring(10);
            fireModifiedEvent();
        }
    }
 
}