Enchantments.h

Go to the documentation of this file.

// Enchantments.h
 
// Declares the cEnchantments class representing a storage for item enchantments and stored-enchantments
 
 
 
 
 
#pragma once
 
#include "Defines.h"
#include "FastRandom.h"
#include "WorldStorage/EnchantmentSerializer.h"
 
 
 
// fwd: "WorldStorage/FastNBT.h"
class cFastNBTWriter;
class cParsedNBT;
 
 
// fwd:
struct cWeightedEnchantment;
 
typedef std::vector<cWeightedEnchantment> cWeightedEnchantments;
 
 
 
 
 
// tolua_begin
class cEnchantments
{
public:
    enum eEnchantment
    {
        // Currently missing: Frost walker, curse of binding, sweeping edge, mending, and curse of vanishing.
        enchProtection           = 0,
        enchFireProtection       = 1,
        enchFeatherFalling       = 2,
        enchBlastProtection      = 3,
        enchProjectileProtection = 4,
        enchRespiration          = 5,
        enchAquaAffinity         = 6,
        enchThorns               = 7,
        enchDepthStrider         = 8,
        enchSharpness            = 16,
        enchSmite                = 17,
        enchBaneOfArthropods     = 18,
        enchKnockback            = 19,
        enchFireAspect           = 20,
        enchLooting              = 21,
        enchEfficiency           = 32,
        enchSilkTouch            = 33,
        enchUnbreaking           = 34,
        enchFortune              = 35,
        enchPower                = 48,
        enchPunch                = 49,
        enchFlame                = 50,
        enchInfinity             = 51,
        enchLuckOfTheSea         = 61,
        enchLure                 = 62,
    } ;
 
    cEnchantments(void);
 
    cEnchantments(const AString & a_StringSpec);
 
    void Add(const cEnchantments & a_Other);
 
    void AddFromString(const AString & a_StringSpec);
 
    size_t Count(void) const;
 
    AString ToString(void) const;
 
    unsigned int GetLevel(int a_EnchantmentID) const;
 
    void SetLevel(int a_EnchantmentID, unsigned int a_Level);
 
    void Clear(void);
 
    bool IsEmpty(void) const;
 
    bool CanAddEnchantment(int a_EnchantmentID) const;
 
    static int StringToEnchantmentID(const AString & a_EnchantmentName);
 
    bool operator ==(const cEnchantments & a_Other) const;
 
    // tolua_end
 
    static int GetXPCostMultiplier(int a_EnchantmentID, bool FromBook);
 
    static unsigned int GetLevelCap(int a_EnchantmentID);
 
    static void AddItemEnchantmentWeights(cWeightedEnchantments & a_Enchantments, short a_ItemType, unsigned a_EnchantmentLevel);
 
    static void AddEnchantmentWeightToVector(cWeightedEnchantments & a_Enchantments, int a_Weight, int a_EnchantmentID, unsigned int a_EnchantmentLevel);
 
    static void RemoveEnchantmentWeightFromVector(cWeightedEnchantments & a_Enchantments, int a_EnchantmentID);
 
    static void RemoveEnchantmentWeightFromVector(cWeightedEnchantments & a_Enchantments, const cEnchantments & a_Enchantment);
 
    static void CheckEnchantmentConflictsFromVector(cWeightedEnchantments & a_Enchantments, const cEnchantments & a_FirstEnchantment);
 
    static cEnchantments GetRandomEnchantmentFromVector(const cWeightedEnchantments & a_Enchantments, MTRand & a_Random);
 
    static cEnchantments SelectEnchantmentFromVector(const cWeightedEnchantments & a_Enchantments, int a_Seed);
 
    bool operator !=(const cEnchantments & a_Other) const;
 
    friend void EnchantmentSerializer::WriteToNBTCompound(const cEnchantments & a_Enchantments, cFastNBTWriter & a_Writer, const AString & a_ListTagName);
 
    friend void EnchantmentSerializer::ParseFromNBT(cEnchantments & a_Enchantments, const cParsedNBT & a_NBT, int a_EnchListTagIdx);
 
protected:
    typedef std::map<int, unsigned int> cMap;
 
    cMap m_Enchantments;
 
public:
    cMap::const_iterator begin() const { return m_Enchantments.begin(); }
    cMap::const_iterator end()   const { return m_Enchantments.end(); }
};  // tolua_export
 
 
 
 
// Define the cWeightedEnchantment struct for the Enchanting System to store the EnchantmentWeights:
struct cWeightedEnchantment
{
    int m_Weight;
    cEnchantments m_Enchantments;
};