skillcache.h

Go to the documentation of this file.

/*
 * skillcache.h
 *
 * Copyright (C) 2006 Atomic Blue (info@planeshift.it, http://www.atomicblue.org)
 *
 *
 * This program 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 (version 2 of the License)
 * This program 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 this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *
 */

#ifndef PS_SKILL_CACHE_H
#define PS_SKILL_CACHE_H

#include <csutil/list.h>
#include <csutil/csstring.h>

class MsgEntry;

class psSkillCacheItem {

    public:

        enum Oper {
            UPDATE_OR_ADD, 
            REMOVE         
        };

        psSkillCacheItem(psSkillCacheItem *item);

        psSkillCacheItem(unsigned int nameId);

        psSkillCacheItem(int skillId,
                         unsigned int nameId,
                         unsigned short R,
                         unsigned short AS,
                         unsigned short Y,
                         unsigned short YC,
                         unsigned short Z,
                         unsigned short ZC,
                         unsigned short CAT,
                         bool stat = false);

        ~psSkillCacheItem();

        void update(unsigned short R,
                    unsigned short AS,
                    unsigned short Y,
                    unsigned short YC,
                    unsigned short Z,
                    unsigned short ZC);

        void update(psSkillCacheItem *item);

        unsigned short size() const;

        void write(MsgEntry *);

        void read(MsgEntry *);

        bool isModified() const { return modified; }
        void setModified(bool modified) { this->modified = modified; }
        bool isRemoved() const { return removed; };
        void setRemoved(bool value) {removed = value; modified = true; }

        bool isStat() const { return stat; }
        int getSkillId() const { return skillId; }
        unsigned int getNameId() const { return nameId; }
        unsigned short getCategory() const { return category; }
        unsigned short getRank() const { return rank; }
        unsigned short getActualStat() const { return actualStat; }
        unsigned short getKnowledge() const { return knowledge; }
        unsigned short getKnowledgeCost() const { return knowledgeCost; }
        unsigned short getPractice() const { return practice; }
        unsigned short getPracticeCost() const { return practiceCost; }

    private:
        bool removed;
        bool modified;
        
        unsigned int nameId;
        int skillId;

        unsigned short rank;
        unsigned short actualStat;
        unsigned short knowledge;
        unsigned short practice;
        unsigned short knowledgeCost;
        unsigned short practiceCost;
        unsigned short category;
        bool stat;

};

typedef csList<psSkillCacheItem *>::Iterator psSkillCacheIter;

class psSkillCache {

    public:
        psSkillCache();
        ~psSkillCache();

        void apply(psSkillCache *list);

        void addItem(int skillId, psSkillCacheItem *item);

        psSkillCacheItem *getItemBySkillId(uint id);

        psSkillCacheIter iterBegin() { return psSkillCacheIter(skillCache); }

        void clear();

        void setModified(bool modified);

        bool isModified();
        
        void setRemoved(bool removed);
        
        bool hasRemoved();

        void setProgressionPoints(unsigned int points);
        unsigned int getProgressionPoints() const { return progressionPoints; }

        void setNew(bool value) { newList = value; }
        bool isNew() const { return newList; }

        unsigned short size() const;

        unsigned short count() const;

        void write(MsgEntry *);

        void read(MsgEntry *);

        csString ToString() const;

    private:
        csList<psSkillCacheItem *> skillCache;
        bool modified;
        bool removed;
        unsigned int progressionPoints;
        bool newList;

        bool deleteItem(psSkillCacheItem *item);

};

#endif