SpellsManager.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.spells;
 
import com.realtime.crossfire.jxclient.guistate.ClientSocketState;
import com.realtime.crossfire.jxclient.guistate.GuiStateListener;
import com.realtime.crossfire.jxclient.guistate.GuiStateManager;
import com.realtime.crossfire.jxclient.skills.Skill;
import com.realtime.crossfire.jxclient.skills.SkillSet;
import com.realtime.crossfire.jxclient.stats.Stats;
import com.realtime.crossfire.jxclient.util.EventListenerList2;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.Comparator;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.concurrent.CopyOnWriteArrayList;
import java.util.stream.Collectors;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
 
public class SpellsManager {
 
    public static final int UPD_SP_MANA = 1;
 
    public static final int UPD_SP_GRACE = 2;
 
    public static final int UPD_SP_DAMAGE = 4;
 
    @NotNull
    private final List<Spell> spells = new CopyOnWriteArrayList<>();
 
    @NotNull
    private final List<Spell> filteredSpells = new CopyOnWriteArrayList<>();
 
    private int skillFilter = -1;
 
    @NotNull
    private final Map<String, Spell> unknownSpells = new HashMap<>();
 
    @NotNull
    private final EventListenerList2<SpellsManagerListener> listeners = new EventListenerList2<>();
 
    @NotNull
    private final Comparator<Spell> spellNameComparator = new SpellComparator();
 
    @NotNull
    @SuppressWarnings("FieldCanBeLocal")
    private final GuiStateListener guiStateListener = new GuiStateListener() {
 
        @Override
        public void start() {
            // ignore
        }
 
        @Override
        public void metaserver() {
            // ignore
        }
 
        @Override
        public void preConnecting(@NotNull final String serverInfo) {
            // ignore
        }
 
        @Override
        public void connecting(@NotNull final String serverInfo) {
            spells.clear();
            spellSkills.clear();
            filteredSpells.clear();
        }
 
        @Override
        public void connecting(@NotNull final ClientSocketState clientSocketState, @NotNull final String param) {
            // ignore
        }
 
        @Override
        public void connected() {
            // ignore
        }
 
        @Override
        public void connectFailed(@NotNull final String reason) {
            // ignore
        }
 
    };
 
    private final SkillSet skillSet;
 
    private final Stats stats;
 
    private final Skill skillAll = new Skill("All spell skills");
 
    private final List<Skill> spellSkills = new ArrayList<>();
 
    public SpellsManager(@NotNull final GuiStateManager guiStateManager, @NotNull final SkillSet skillSet, @NotNull final Stats stats) {
        guiStateManager.addGuiStateListener(guiStateListener);
        this.skillSet = skillSet;
        this.stats = stats;
    }
 
    public void addCrossfireSpellChangedListener(@NotNull final SpellsManagerListener listener) {
        listeners.add(listener);
    }
 
    public void removeCrossfireSpellChangedListener(@NotNull final SpellsManagerListener listener) {
        listeners.remove(listener);
    }
 
    public void addSpell(final int tag, final int level, final int castingTime, final int mana, final int grace, final int damage, final int skill, final int path, final int faceNum, @NotNull final String spellName, @NotNull final String message) {
        final Spell key = new Spell(spellName, skillSet, stats);
        key.setParameters(faceNum, tag, message, level, castingTime, mana, grace, damage, skill, path); // set spell path which is used in the comparator
 
        int index = Collections.binarySearch(spells, key, spellNameComparator);
        final Spell spell;
        if (index < 0) {
            final Spell existingSpell;
            synchronized (unknownSpells) {
                existingSpell = unknownSpells.remove(spellName);
            }
            if (existingSpell == null) {
                spell = key;
            } else {
                spell = existingSpell;
                spell.setParameters(faceNum, tag, message, level, castingTime, mana, grace, damage, skill, path);
            }
            index = -index-1;
            spells.add(index, spell);
        } else {
            spell = spells.get(index);
            spell.setParameters(faceNum, tag, message, level, castingTime, mana, grace, damage, skill, path);
        }
 
        rebuildSkills();
        filterSpells();
 
        for (SpellsManagerListener listener : listeners) {
            listener.spellAdded(index);
        }
    }
 
    public void updateSpell(final int flags, final int tag, final int mana, final int grace, final int damage) {
        for (Spell spell : spells) {
            if (spell.getTag() == tag) {
                spell.updateParameters((flags&UPD_SP_MANA) != 0, mana, (flags&UPD_SP_GRACE) != 0, grace, (flags&UPD_SP_DAMAGE) != 0, damage);
                break;
            }
        }
    }
 
    public void deleteSpell(final int tag) {
        int index = 0;
        for (Spell spell : spells) {
            if (spell.getTag() == tag) {
                deleteSpellByIndex(index);
                break;
            }
            index++;
        }
        rebuildSkills();
        filterSpells();
    }
 
    private void deleteSpellByIndex(final int index) {
        final Spell spell = spells.remove(index);
        synchronized (unknownSpells) {
            unknownSpells.put(spell.getName(), spell);
        }
 
        for (SpellsManagerListener listener : listeners) {
            listener.spellRemoved(index);
        }
 
        spell.setUnknown(true);
 
        rebuildSkills();
    }
 
    @Nullable
    public Spell getSpell(@NotNull final String spellName) {
        for (Spell spell : spells) {
            if (spell.getName().equals(spellName)) {
                return spell;
            }
        }
 
        Spell result = null;
        for (Spell spell : spells) {
            if (spell.getName().startsWith(spellName)) {
                //noinspection VariableNotUsedInsideIf
                if (result != null) {
                    // prefix is not unique => pretend the spell does not exist
                    return null;
                }
                result = spell;
            }
        }
 
        return result;
    }
 
    @NotNull
    public Collection<Spell> getAllSpells() {
        return Collections.unmodifiableList(filteredSpells);
    }
 
    @NotNull
    public Collection<Spell> getFilteredSpells() {
        return Collections.unmodifiableList(filteredSpells);
    }
 
    public int getFilteredSpellsCount() {
        return filteredSpells.size();
    }
 
    @Nullable
    public Spell getFilteredSpell(final int index) {
        try {
            return filteredSpells.get(index);
        } catch (final IndexOutOfBoundsException ignored) {
            return null;
        }
    }
 
    public boolean displaysFace(final int faceNum) {
        for (Spell spell : spells) {
            if (spell.getFaceNum() == faceNum) {
                return true;
            }
        }
 
        return false;
    }
 
    public void selectCharacter() {
        spells.clear();
        filteredSpells.clear();
    }
 
    public void filterSkill(final int index) {
        if (index < 0 || index >= spellSkills.size()) {
            return;
        }
 
        final int id = skillSet.getSkillId(spellSkills.get(index).toString());
 
        if (skillFilter == id) {
            return;
        }
 
        skillFilter = id;
        filterSpells();
 
        for (SpellsManagerListener listener : listeners) {
            listener.spellAdded(0);
        }
    }
 
    private void filterSpells() {
        filteredSpells.clear();
        filteredSpells.addAll(spells.stream().filter(spell -> skillFilter == -1 || spell.getSkill() == skillFilter).collect(Collectors.toList()));
    }
 
    private void rebuildSkills() {
        spellSkills.clear();
        for (Spell spell : spells) {
            final Skill skill = skillSet.getSkill(spell.getSkill());
            if (skill != null && !spellSkills.contains(skill)) {
                spellSkills.add(skill);
            }
        }
        spellSkills.sort(Comparator.comparing(Skill::toString));
        spellSkills.add(0, skillAll);
    }
 
    public int getSpellSkills() {
        return spellSkills.size();
    }
 
    @Nullable
    public Skill getSpellSkill(final int index) {
        return 0 <= index && index < spellSkills.size() ? spellSkills.get(index) : null;
    }
 
}