iteminfo.h

Go to the documentation of this file.

/*
 *  The Mana Client
 *  Copyright (C) 2004-2009  The Mana World Development Team
 *  Copyright (C) 2009-2012  The Mana Developers
 *
 *  This file is part of The Mana Client.
 *
 *  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; either version 2 of the License, or
 *  any later version.
 *
 *  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, see <http://www.gnu.org/licenses/>.
 */
 
#pragma once
 
#include "being.h"
 
#include "resources/spritedef.h"
 
#include <map>
#include <string>
#include <vector>
 
enum class EquipmentSoundEvent
{
    Strike,
    Hit
};
 
enum ItemType
{
    ITEM_UNUSABLE = 0,
    ITEM_USABLE,
    ITEM_EQUIPMENT_ONE_HAND_WEAPON,
    ITEM_EQUIPMENT_TWO_HANDS_WEAPON,
    ITEM_EQUIPMENT_TORSO,
    ITEM_EQUIPMENT_ARMS, // 5
    ITEM_EQUIPMENT_HEAD,
    ITEM_EQUIPMENT_LEGS,
    ITEM_EQUIPMENT_SHIELD,
    ITEM_EQUIPMENT_RING,
    ITEM_EQUIPMENT_NECKLACE, // 10
    ITEM_EQUIPMENT_FEET,
    ITEM_EQUIPMENT_AMMO,
    ITEM_EQUIPMENT_CHARM,
    ITEM_SPRITE_RACE,
    ITEM_SPRITE_HAIR // 15
};
 
namespace TmwAthena {
class TaItemDB;
}
 
namespace ManaServ {
class ManaServItemDB;
}
 
enum ReplacementDirection : uint8_t
{
    DIRECTION_ALL = DIRECTION_DEFAULT,
    DIRECTION_DEAD = DIRECTION_INVALID,
    DIRECTION_UNKNOWN,
};
 
enum ReplacementSprite : uint8_t
{
    SPRITE_UNKNOWN = 254,
    SPRITE_ALL = 255,
};
 
struct Replacement
{
    struct Item
    {
        int from = 0;                   // ID to replace (0: any)
        int to = 0;                     // Replace with this ID (0: remove)
    };
 
    uint8_t sprite = SPRITE_ALL;        // sprite slot to replace
    uint8_t direction = DIRECTION_ALL;  // direction in which to replace
    std::vector<Item> items;            // specific items to replace (empty: remove)
};
 
class ItemInfo
{
    friend class ItemDB;
    friend class TmwAthena::TaItemDB;
    friend class ManaServ::ManaServItemDB;
 
public:
    ItemInfo() = default;
 
    // disable copying
    ItemInfo(const ItemInfo &) = delete;
    ItemInfo &operator=(const ItemInfo &) = delete;
 
    int id = 0;                         
    std::string name;
    SpriteDisplay display;              
    std::string description;            
    std::vector<std::string> effect;    
    int weight = 0;                     
    std::string missileParticleFile;
    int hitEffectId = 0;
    int criticalHitEffectId = 0;
 
    std::string attackAction = SpriteAction::INVALID;
 
    int attackRange = 0;
 
    bool equippable = false;            
    bool activatable = false;           
    ItemType type = ITEM_UNUSABLE;      
    std::vector<Replacement> replacements;
 
    const std::string &getSprite(Gender gender, int race) const;
    const std::string &getSound(EquipmentSoundEvent event) const;
 
private:
    void setSprite(const std::string &animationFile, Gender gender, int race);
    void addSound(EquipmentSoundEvent event, const std::string &filename);
 
    int mView = 0;                       
    std::map<int, std::string> mAnimationFiles;
 
    std::map<EquipmentSoundEvent, std::vector<std::string>> mSounds;
};
 
/*
 * TmwAthena specialization of the ItemInfo for TmwAthena
 */
namespace TmwAthena {
 
enum EquipmentSlot
{
    // Equipment rules:
    // 1 Brest equipment
    EQUIP_TORSO_SLOT = 0,
    // 1 arms equipment
    EQUIP_ARMS_SLOT = 1,
    // 1 head equipment
    EQUIP_HEAD_SLOT = 2,
    // 1 legs equipment
    EQUIP_LEGS_SLOT = 3,
    // 1 feet equipment
    EQUIP_FEET_SLOT = 4,
    // 2 rings
    EQUIP_RING1_SLOT = 5,
    EQUIP_RING2_SLOT = 6,
    // 1 necklace
    EQUIP_NECKLACE_SLOT = 7,
    // Fight:
    //   2 one-handed weapons
    //   or 1 two-handed weapon
    //   or 1 one-handed weapon + 1 shield.
    EQUIP_FIGHT1_SLOT = 8,
    EQUIP_FIGHT2_SLOT = 9,
    // Projectile:
    //   this item does not amount to one, it only indicates the chosen projectile.
    EQUIP_PROJECTILE_SLOT = 10,
    EQUIP_VECTOR_END = 11
};
 
} // namespace TmwAthena