Spell.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.skills.Skill;
import com.realtime.crossfire.jxclient.skills.SkillSet;
import com.realtime.crossfire.jxclient.stats.Stats;
import com.realtime.crossfire.jxclient.util.EventListenerList2;
import com.realtime.crossfire.jxclient.util.StringSplitter;
import java.util.Locale;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
 
public class Spell {
 
    @NotNull
    private final String name;
 
    @NotNull
    private final EventListenerList2<SpellListener> listeners = new EventListenerList2<>();
 
    private int faceNum;
 
    private int tag;
 
    @NotNull
    private String message = "";
 
    private int level;
 
    private int castingTime;
 
    private int mana;
 
    private int grace;
 
    private int damage;
 
    private int skill;
 
    private int path;
 
    private boolean unknown;
 
    private final SkillSet skillSet;
 
    private final Stats stats;
 
    public Spell(@NotNull final String name, @NotNull final SkillSet skillSet, @NotNull final Stats stats) {
        this.name = name;
        this.skillSet = skillSet;
        this.stats = stats;
    }
 
    public int getTag() {
        return tag;
    }
 
    public int getLevel() {
        return level;
    }
 
    public int getCastingTime() {
        return castingTime;
    }
 
    public int getMana() {
        return mana;
    }
 
    public int getGrace() {
        return grace;
    }
 
    public int getDamage() {
        return damage;
    }
 
    public int getSkill() {
        return skill;
    }
 
    public int getPath() {
        return path;
    }
 
    @NotNull
    public String getName() {
        return name;
    }
 
    @NotNull
    public String getMessage() {
        return message;
    }
 
    public int getFaceNum() {
        return faceNum;
    }
 
    public boolean isUnknown() {
        return unknown;
    }
 
    public void setUnknown(final boolean unknown) {
        if (this.unknown != unknown) {
            this.unknown = unknown;
            fireChanged();
        }
    }
 
    public void setParameters(final int faceNum, final int tag, @NotNull final String message, final int level, final int castingTime, final int mana, final int grace, final int damage, final int skill, final int path) {
        boolean changed = false;
 
        if (this.faceNum != faceNum) {
            this.faceNum = faceNum;
            changed = true;
        }
 
        if (this.tag != tag) {
            this.tag = tag;
            changed = true;
        }
 
        if (!this.message.equals(message)) {
            this.message = message;
            changed = true;
        }
 
        if (this.level != level) {
            this.level = level;
            changed = true;
        }
 
        if (this.castingTime != castingTime) {
            this.castingTime = castingTime;
            changed = true;
        }
 
        if (this.mana != mana) {
            this.mana = mana;
            changed = true;
        }
 
        if (this.grace != grace) {
            this.grace = grace;
            changed = true;
        }
 
        if (this.damage != damage) {
            this.damage = damage;
            changed = true;
        }
 
        if (this.skill != skill) {
            this.skill = skill;
            changed = true;
        }
 
        if (this.path != path) {
            this.path = path;
            changed = true;
        }
 
        if (unknown) {
            unknown = false;
            changed = true;
        }
 
        if (changed) {
            fireChanged();
        }
    }
 
    public void updateParameters(final boolean updateMana, final int mana, final boolean updateGrace, final int grace, final boolean updateDamage, final int damage) {
        boolean changed = false;
 
        if (updateMana && this.mana != mana) {
            this.mana = mana;
            changed = true;
        }
 
        if (updateGrace && this.grace != grace) {
            this.grace = grace;
            changed = true;
        }
 
        if (updateDamage && this.damage != damage) {
            this.damage = damage;
            changed = true;
        }
 
        if (changed) {
            fireChanged();
        }
    }
 
    @NotNull
    @Override
    public String toString() {
        return "Name:"+name+" ID:"+tag+" Level:"+level+" Time:"+castingTime+" Mana:"+mana+" Grace:"+grace+" Damage:"+damage+" Skill:"+skill+" Path:"+path+" Unknown:"+unknown;
    }
 
    @NotNull
    public String getTooltipText() {
        final StringBuilder sb = new StringBuilder("<b>");
        sb.append(name.substring(0, 1).toUpperCase(Locale.ENGLISH)).append(name.substring(1));
        sb.append("</b>");
        if (unknown) {
            sb.append(" (unknown)");
        }
        if (path != 0) {
            sb.append(Integer.bitCount(path) == 1 ? "<br>Spell path:" : "<br>Spell paths:");
            SpellPaths.appendSpellPaths(path, sb);
        }
        if ((path&stats.getStat(Stats.CS_STAT_SPELL_DENY)) == 0) {
            final Skill sk = skillSet.getSkill(skill);
            if (sk != null) {
                sb.append("<br>Skill: ").append(sk);
            }
            if (level > 0) {
                sb.append("<br>Level: ");
                if (sk != null && level <= sk.getLevel()) {
                    int effective = sk.getLevel()-level;
                    @Nullable final String supp;
                    if ((path&stats.getStat(Stats.CS_STAT_SPELL_ATTUNE)) != 0) {
                        effective += 2;
                        supp = " (attuned)";
                    } else if ((path&stats.getStat(Stats.CS_STAT_SPELL_REPEL)) != 0) {
                        effective -= 2;
                        supp = " (repelled)";
                    } else {
                        supp = null;
                    }
                    sb.append(effective);
                    if (supp != null) {
                        sb.append(supp);
                    }
                } else {
                    sb.append(level);
                }
            }
            if (mana > 0) {
                sb.append("<br>Mana: ").append(mana);
            }
            if (grace > 0) {
                sb.append("<br>Grace: ").append(grace);
            }
            if (damage > 0) {
                sb.append("<br>Damage: ").append(damage);
            }
        } else {
            sb.append("<br><b>You are denied from casting this spell.</b>");
        }
        if (!message.isEmpty()) {
            sb.append("<br>");
            sb.append(StringSplitter.splitAsHtml(message));
        }
        return sb.toString();
    }
 
    private void fireChanged() {
        for (SpellListener listener : listeners) {
            listener.spellChanged();
        }
    }
 
    public void addSpellListener(@NotNull final SpellListener listener) {
        listeners.add(listener);
    }
 
    public void removeSpellListener(@NotNull final SpellListener listener) {
        listeners.remove(listener);
    }
 
}