CfItem.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-2011 Andreas Kirschbaum.
 */

package com.realtime.crossfire.jxclient.items;

import com.realtime.crossfire.jxclient.faces.Face;
import com.realtime.crossfire.jxclient.protocol.UpdItem;
import com.realtime.crossfire.jxclient.util.EventListenerList2;
import org.jetbrains.annotations.NotNull;

public class CfItem {

    private final int tag;

    private int flags;

    private int weight;

    @NotNull
    private Face face;

    @NotNull
    private String name;

    @NotNull
    private String namePl;

    private int anim;

    private int animSpeed;

    private int nrof;

    private int location;

    private final int type;

    private boolean modified = true;

    public static final int F_APPLIED = 0x000F;

    public static final int F_UNIDENTIFIED = 0x0010;

    public static final int F_BLESSED = 0x0100;

    public static final int F_UNPAID = 0x0200;

    public static final int F_MAGIC = 0x0400;

    public static final int F_CURSED = 0x0800;

    public static final int F_DAMNED = 0x1000;

    public static final int F_OPEN = 0x2000;

    public static final int F_NOPICK = 0x4000;

    public static final int F_LOCKED = 0x8000;

    private final EventListenerList2<CfItemListener> listeners = new EventListenerList2<>();

    public CfItem(final int location, final int tag, final int flags, final int weight, @NotNull final Face face, @NotNull final String name, @NotNull final String namePl, final int anim, final int animSpeed, final int nrof, final int type) {
        this.location = location;
        this.tag = tag;
        this.flags = flags;
        this.weight = weight;
        this.face = face;
        this.name = name;
        this.namePl = namePl;
        this.anim = anim;
        this.animSpeed = animSpeed;
        this.nrof = nrof;
        this.type = type;
    }

    private void setFlags(final int flags) {
        if (this.flags != flags) {
            this.flags = flags;
            modified = true;
        }
    }

    private void setWeight(final int weight) {
        if (this.weight != weight) {
            this.weight = weight;
            modified = true;
        }
    }

    private void setFace(@NotNull final Face face) {
        if (this.face != face) {
            this.face = face;
            modified = true;
        }
    }

    private void setName(@NotNull final String name, @NotNull final String namePl) {
        if (!this.name.equals(name) || !this.namePl.equals(namePl)) {
            this.name = name;
            this.namePl = namePl;
            modified = true;
        }
    }

    private void setAnim(final int anim) {
        if (this.anim != anim) {
            this.anim = anim;
            modified = true;
        }
    }

    private void setAnimSpeed(final int animSpeed) {
        if (this.animSpeed != animSpeed) {
            this.animSpeed = animSpeed;
            modified = true;
        }
    }

    private void setNrOf(final int nrof) {
        if (this.nrof != nrof) {
            this.nrof = nrof;
            modified = true;
        }
    }

    public void setLocation(final int location) {
        this.location = location;
    }

    public int getTag() {
        return tag;
    }

    public int getWeight() {
        return weight;
    }

    @NotNull
    public Face getFace() {
        return face;
    }

    @NotNull
    public String getName() {
        return nrof > 1 ? namePl : name;
    }

    public int getNrOf() {
        return nrof;
    }

    public boolean isApplied() {
        return (flags&F_APPLIED) != 0;
    }

    public boolean isUnidentified() {
        return (flags&F_UNIDENTIFIED) != 0;
    }

    public boolean isBlessed() {
        return (flags&F_BLESSED) != 0;
    }

    public boolean isUnpaid() {
        return (flags&F_UNPAID) != 0;
    }

    public boolean isMagic() {
        return (flags&F_MAGIC) != 0;
    }

    public boolean isCursed() {
        return (flags&F_CURSED) != 0;
    }

    public boolean isDamned() {
        return (flags&F_DAMNED) != 0;
    }

    public boolean isOpen() {
        return (flags&F_OPEN) != 0;
    }

    public boolean isNoPick() {
        return (flags&F_NOPICK) != 0;
    }

    public boolean isLocked() {
        return (flags&F_LOCKED) != 0;
    }

    public int getLocation() {
        return location;
    }

    public int getType() {
        return type;
    }

    public void update(final int updateFlags, final int flags, final int weight, @NotNull final Face face, @NotNull final String name, @NotNull final String namePl, final int anim, final int animSpeed, final int nrof) {
        if ((updateFlags&UpdItem.UPD_FLAGS) != 0) {
            setFlags(flags);
        }
        if ((updateFlags&UpdItem.UPD_WEIGHT) != 0) {
            setWeight(weight);
        }
        if ((updateFlags&UpdItem.UPD_FACE) != 0) {
            setFace(face);
        }
        if ((updateFlags&UpdItem.UPD_NAME) != 0) {
            setName(name, namePl);
        }
        if ((updateFlags&UpdItem.UPD_ANIM) != 0) {
            setAnim(anim);
        }
        if ((updateFlags&UpdItem.UPD_ANIMSPEED) != 0) {
            setAnimSpeed(animSpeed);
        }
        if ((updateFlags&UpdItem.UPD_NROF) != 0) {
            setNrOf(nrof);
        }
        fireModified();
    }

    private void fireModified() {
        if (!modified) {
            return;
        }
        modified = false;

        for (final CfItemListener listener : listeners) {
            listener.itemModified();
        }
    }

    public void addCfItemModifiedListener(@NotNull final CfItemListener listener) {
        listeners.add(listener);
    }

    public void removeCfItemModifiedListener(@NotNull final CfItemListener listener) {
        listeners.remove(listener);
    }

    @NotNull
    public String getTooltipText() {
        final String tooltipText1 = getTooltipText1();
        final String tooltipText2 = getTooltipText2();
        final String tooltipText3 = getTooltipText3();
        final StringBuilder sb = new StringBuilder(tooltipText1);
        if (!tooltipText2.isEmpty()) {
            sb.append("<br>");
            sb.append(tooltipText2);
        }
        if (!tooltipText3.isEmpty()) {
            sb.append("<br>");
            sb.append(tooltipText3);
        }
        return sb.toString();
    }

    @NotNull
    public String getTooltipText1() {
        return nrof > 1 ? nrof+" "+namePl : name;
    }

    @NotNull
    public String getTooltipText2() {
        final int totalWeight = nrof > 0 ? weight*nrof : weight;
        if (totalWeight <= 0) {
            return "";
        }
        if (totalWeight < 1000) {
            return totalWeight+" g";
        }
        if (totalWeight < 10000) {
            final int tmp = (totalWeight+50)/100;
            return tmp/10+"."+tmp%10+" kg";
        }
        final int tmp = (totalWeight+500)/1000;
        return tmp+" kg";
    }

    @NotNull
    public String getTooltipText3() {
        final StringBuilder sb = new StringBuilder();
        appendFlag(sb, F_UNIDENTIFIED, "unidentified");
        appendFlag(sb, F_BLESSED, "blessed");
        appendFlag(sb, F_MAGIC, "magic");
        appendFlag(sb, F_CURSED, "cursed");
        appendFlag(sb, F_DAMNED, "damned");
        appendFlag(sb, F_UNPAID, "unpaid");
        return sb.toString();
    }

    private void appendFlag(@NotNull final StringBuilder sb, final int flag, @NotNull final String ident) {
        if ((flags&flag) != 0) {
            sb.append('(');
            sb.append(ident);
            sb.append(')');
        }
    }

    public boolean isItemGroupButton() {
        return flags == 0 && weight == -1 && nrof == 0 && type == 0 && name.startsWith("Click here to see ");
    }

}