cSlotAreaInventoryBase Class Reference

Handles any part of the inventory, using parameters in constructor to distinguish between the parts. More...

#include <SlotArea.h>

Inheritance diagram for cSlotAreaInventoryBase:

Collaboration diagram for cSlotAreaInventoryBase:

Public Member Functions
virtual void	Clicked (cPlayer &a_Player, int a_SlotNum, eClickAction a_ClickAction, const cItem &a_ClickedItem) override
	Called when a player clicks in the window. More...
	cSlotAreaInventoryBase (int a_NumSlots, int a_SlotOffset, cWindow &a_ParentWindow)
virtual const cItem *	GetSlot (int a_SlotNum, cPlayer &a_Player) const override
	Called to retrieve an item in the specified slot for the specified player. More...
virtual void	SetSlot (int a_SlotNum, cPlayer &a_Player, const cItem &a_Item) override
	Called to set an item in the specified slot for the specified player. More...
Public Member Functions inherited from cSlotArea
virtual bool	CollectItemsToHand (cItem &a_Dragging, cPlayer &a_Player, bool a_CollectFullStacks)
	Called on DblClicking to collect all stackable items into hand. More...
	cSlotArea (int a_NumSlots, cWindow &a_ParentWindow)
virtual void	DblClicked (cPlayer &a_Player, int a_SlotNum)
	Called from Clicked when the action is a caDblClick. More...
virtual void	DistributeStack (cItem &a_ItemStack, cPlayer &a_Player, bool a_ShouldApply, bool a_KeepEmptySlots, bool a_BackFill)
	Called to store as much of a_ItemStack in the area as possible. More...
virtual void	DropClicked (cPlayer &a_Player, int a_SlotNum, bool a_DropStack)
	Called from Clicked when the action is a drop click. More...
int	GetNumSlots (void) const
virtual void	MiddleClicked (cPlayer &a_Player, int a_SlotNum)
	Called from Clicked when the action is a middleclick. More...
virtual void	NumberClicked (cPlayer &a_Player, int a_SlotNum, eClickAction a_ClickAction)
	Called from Clicked when the action is a number click. More...
virtual void	OnPlayerAdded (cPlayer &a_Player)
	Called when a new player opens the same parent window. More...
virtual void	OnPlayerRemoved (cPlayer &a_Player)
	Called when one of the players closes the parent window. More...
virtual void	ShiftClicked (cPlayer &a_Player, int a_SlotNum, const cItem &a_ClickedItem)
	Called from Clicked when the action is a shiftclick (left or right) More...
virtual	~cSlotArea ()

Protected Attributes
int	m_SlotOffset
Protected Attributes inherited from cSlotArea
int	m_NumSlots
cWindow &	m_ParentWindow

Private Types
using	Super = cSlotArea

Detailed Description

Handles any part of the inventory, using parameters in constructor to distinguish between the parts.

Definition at line 94 of file SlotArea.h.

Member Typedef Documentation

Super

using cSlotAreaInventoryBase::Super = cSlotArea

private

Definition at line 97 of file SlotArea.h.

Constructor & Destructor Documentation

cSlotAreaInventoryBase()

cSlotAreaInventoryBase::cSlotAreaInventoryBase	(	int	a_NumSlots,
		int	a_SlotOffset,
		cWindow &	a_ParentWindow
	)

Definition at line 2407 of file SlotArea.cpp.

Member Function Documentation

Clicked()

void cSlotAreaInventoryBase::Clicked ( cPlayer &  a_Player, int  a_SlotNum, eClickAction  a_ClickAction, const cItem &  a_ClickedItem  )

overridevirtual

Called when a player clicks in the window.

Parameters taken from the click packet.

Reimplemented from cSlotArea.

Reimplemented in cSlotAreaArmor.

Definition at line 2417 of file SlotArea.cpp.

GetSlot()

const cItem * cSlotAreaInventoryBase::GetSlot ( int  a_SlotNum, cPlayer &  a_Player  ) const

overridevirtual

Called to retrieve an item in the specified slot for the specified player.

Must return a valid cItem.

Implements cSlotArea.

Definition at line 2440 of file SlotArea.cpp.

SetSlot()

void cSlotAreaInventoryBase::SetSlot ( int  a_SlotNum, cPlayer &  a_Player, const cItem &  a_Item  )

overridevirtual

Called to set an item in the specified slot for the specified player.

Implements cSlotArea.

Definition at line 2450 of file SlotArea.cpp.

Member Data Documentation

m_SlotOffset

int cSlotAreaInventoryBase::m_SlotOffset

protected

Definition at line 110 of file SlotArea.h.

---

The documentation for this class was generated from the following files:

• src/UI/SlotArea.h
• src/UI/SlotArea.cpp