ItemGrid.h

Go to the documentation of this file.

// ItemGrid.h

// Declares the cItemGrid class representing a storage for items in a XY grid (chests, dispensers, inventory etc.)




#pragma once

#include "Item.h"
#include "LazyArray.h"





// tolua_begin
class cItemGrid
{
public:
    // tolua_end

    class cListener
    {
    public:
        virtual ~cListener() {}

        virtual void OnSlotChanged(cItemGrid * a_ItemGrid, int a_SlotNum) = 0;
    } ;
    typedef std::vector<cListener *> cListeners;

    cItemGrid(int a_Width, int a_Height);

    // tolua_begin
    int GetWidth   (void) const { return m_Width; }
    int GetHeight  (void) const { return m_Height; }
    int GetNumSlots(void) const { return m_Slots.size(); }

    int GetSlotNum(int a_X, int a_Y) const;

    // tolua_end

    void GetSlotCoords(int a_SlotNum, int & a_X, int & a_Y) const;

    void CopyFrom(const cItemGrid & a_Src);

    // tolua_begin

    // Retrieve slots by coords or slot number; Logs warning and returns the first slot on invalid coords / slotnum
    const cItem & GetSlot(int a_X, int a_Y) const;
    const cItem & GetSlot(int a_SlotNum) const;

    // Set slot by coords or slot number; Logs warning and doesn't set on invalid coords / slotnum
    void SetSlot(int a_X, int a_Y, const cItem & a_Item);
    void SetSlot(int a_X, int a_Y, short a_ItemType, char a_ItemCount, short a_ItemDamage);
    void SetSlot(int a_SlotNum, const cItem & a_Item);
    void SetSlot(int a_SlotNum, short a_ItemType, char a_ItemCount, short a_ItemDamage);

    // Empty the specified slot; Logs warning and doesn't set on invalid coords / slotnum
    void EmptySlot(int a_X, int a_Y);
    void EmptySlot(int a_SlotNum);

    bool IsSlotEmpty(int a_SlotNum) const;

    bool IsSlotEmpty(int a_X, int a_Y) const;

    void Clear(void);

    int HowManyCanFit(const cItem & a_ItemStack, bool a_AllowNewStacks = true);

    int AddItem(cItem & a_ItemStack, bool a_AllowNewStacks = true, int a_PrioritySlot = -1);

    int AddItems(cItems & a_ItemStackList, bool a_AllowNewStacks = true, int a_PrioritySlot = -1);

    int RemoveItem(const cItem & a_ItemStack);

    int ChangeSlotCount(int a_SlotNum, int a_AddToCount);

    int ChangeSlotCount(int a_X, int a_Y, int a_AddToCount);

    cItem RemoveOneItem(int a_SlotNum);

    cItem RemoveOneItem(int a_X, int a_Y);

    int HowManyItems(const cItem & a_Item);

    bool HasItems(const cItem & a_ItemStack);

    int GetFirstEmptySlot(void) const;

    int GetFirstUsedSlot(void) const;

    int GetLastEmptySlot(void) const;

    int GetLastUsedSlot(void) const;

    int GetNextEmptySlot(int a_StartFrom) const;

    int GetNextUsedSlot(int a_StartFrom) const;

    void CopyToItems(cItems & a_Items) const;

    bool DamageItem(int a_SlotNum, short a_Amount);

    bool DamageItem(int a_X, int a_Y, short a_Amount);

    // tolua_end


    bool IsValidSlotCoords(int a_X, int a_Y) const;

    bool IsValidSlotNum(int a_SlotNum) const;

    void GenerateRandomLootWithBooks(const cLootProbab * a_LootProbabs, size_t a_CountLootProbabs, int a_NumSlots, int a_Seed);

    void AddListener(cListener & a_Listener);

    void RemoveListener(cListener & a_Listener);

    // tolua_begin

protected:
    int     m_Width;
    int     m_Height;
    cLazyArray<cItem> m_Slots;

    cListeners       m_Listeners;    
    cCriticalSection m_CSListeners;  
    bool             m_IsInTriggerListeners;  

    void TriggerListeners(int a_SlotNum);

    int AddItemToSlot(const cItem & a_ItemStack, int a_Slot, int a_Num, int a_MaxStack);
} ;
// tolua_end