Window.h

Go to the documentation of this file.

 
// Window.h
 
// Interfaces to the cWindow class representing a UI window for a specific block
 
 
 
 
 
#pragma once
 
#include "../FunctionRef.h"
#include "../ItemGrid.h"
 
 
 
 
 
class cPlayer;
class cWindowOwner;
class cClientHandle;
class cBrewingstandEntity;
class cChestEntity;
class cEnderChestEntity;
class cFurnaceEntity;
class cHopperEntity;
class cMinecartWithChest;
class cBeaconEntity;
class cSlotArea;
class cSlotAreaAnvil;
class cWorld;
 
typedef std::list<cPlayer *> cPlayerList;
typedef std::vector<cSlotArea *> cSlotAreas;
using cPlayerListCallback   = cFunctionRef<bool(cPlayer       &)>;
using cClientHandleCallback = cFunctionRef<bool(cClientHandle &)>;
 
 
 
 
// tolua_begin
 
class cWindow
{
public:
    enum WindowType
    {
        wtInventory   = -1,  // This value is never actually sent to a client
        wtChest       = 0,
        wtWorkbench   = 1,
        wtFurnace     = 2,
        wtDropSpenser = 3,  // Dropper or Dispenser
        wtEnchantment = 4,
        wtBrewery     = 5,
        wtNPCTrade    = 6,
        wtBeacon      = 7,
        wtAnvil       = 8,
        wtHopper      = 9,
        wtDropper     = 10,
        wtAnimalChest = 11,
    };
 
    // tolua_end
 
    static const int c_NumInventorySlots = 36;
 
    cWindow(WindowType a_WindowType, const AString & a_WindowTitle);
    virtual ~cWindow();
 
    char GetWindowID(void) const { return m_WindowID; }  // tolua_export
    int GetWindowType(void) const { return m_WindowType; }  // tolua_export
 
    const AString GetWindowTypeName(void) const;  // tolua_export
 
    cWindowOwner * GetOwner(void) { return m_Owner; }
    void SetOwner( cWindowOwner * a_Owner) { m_Owner = a_Owner; }
 
    int GetNumSlots(void) const;
 
    int GetNumNonInventorySlots(void) const { return GetNumSlots() - c_NumInventorySlots; }
 
    // tolua_begin
 
    const cItem * GetSlot(cPlayer & a_Player, int a_SlotNum) const;
 
    void SetSlot(cPlayer & a_Player, int a_SlotNum, const cItem & a_Item);
 
    bool IsSlotInPlayerMainInventory(int a_SlotNum) const;
 
    bool IsSlotInPlayerHotbar(int a_SlotNum) const;
 
    bool IsSlotInPlayerInventory(int a_SlotNum) const;
 
    // tolua_end
 
    void GetSlots(cPlayer & a_Player, cItems & a_Slots) const;
 
    virtual void Clicked(
        cPlayer & a_Player, int a_WindowID,
        short a_SlotNum, eClickAction a_ClickAction,
        const cItem & a_ClickedItem
    );
 
    virtual void OpenedByPlayer(cPlayer & a_Player);
 
    virtual bool ClosedByPlayer(cPlayer & a_Player, bool a_CanRefuse);
 
    void BroadcastSlot(cSlotArea * a_Area, int a_LocalSlotNum);
 
    void SendWholeWindow(cClientHandle & a_Client);
 
    void BroadcastWholeWindow(void);
 
    // tolua_begin
 
    const AString & GetWindowTitle() const { return m_WindowTitle; }
    void SetWindowTitle(const AString & a_WindowTitle) { m_WindowTitle = a_WindowTitle; }
 
    virtual void SetProperty(size_t a_Property, short a_Value);
 
    // tolua_end
 
    void OwnerDestroyed(void);
 
    bool ForEachPlayer(cPlayerListCallback a_Callback);
 
    bool ForEachClient(cClientHandleCallback a_Callback);
 
    virtual void DistributeStack(cItem & a_ItemStack, int a_Slot, cPlayer & a_Player, cSlotArea * a_ClickedArea, bool a_ShouldApply) = 0;
 
    void DistributeStackToAreas(cItem & a_ItemStack, cPlayer & a_Player, cSlotAreas & a_AreasInOrder, bool a_ShouldApply, bool a_BackFill);
 
    bool CollectItemsToHand(cItem & a_Dragging, cSlotArea & a_Area, cPlayer & a_Player, bool a_CollectFullStacks);
 
    void SendSlot(cPlayer & a_Player, cSlotArea * a_SlotArea, int a_RelativeSlotNum);
 
protected:
 
    cSlotAreas m_SlotAreas;
 
    char    m_WindowID;
    int     m_WindowType;
    AString m_WindowTitle;
 
    cCriticalSection m_CS;
    cPlayerList      m_OpenedBy;
 
    bool m_IsDestroyed;
 
    cWindowOwner * m_Owner;
 
    static Byte m_WindowIDCounter;
 
    virtual void Destroy(void);
 
    cSlotArea * GetSlotArea(int a_GlobalSlotNum, int & a_LocalSlotNum);
 
    const cSlotArea * GetSlotArea(int a_GlobalSlotNum, int & a_LocalSlotNum) const;
 
    void OnPaintBegin(cPlayer & a_Player);
 
    void OnPaintProgress(cPlayer & a_Player, int a_SlotNum);
 
    void OnLeftPaintEnd(cPlayer & a_Player);
 
    void OnRightPaintEnd(cPlayer & a_Player);
 
    void OnMiddlePaintEnd(cPlayer & a_Player);
 
    char DistributeItemToSlots(cPlayer & a_Player, const cItem & a_Item, char a_NumToEachSlot, const cSlotNums & a_SlotNums, bool a_LimitItems = true);
} ;  // tolua_export