cSlotAreaItemGrid Class Reference

Handles any slot area that is representing a cItemGrid; same items for all the players. More...

#include <SlotArea.h>

Inheritance diagram for cSlotAreaItemGrid:

Collaboration diagram for cSlotAreaItemGrid:

Public Member Functions
	cSlotAreaItemGrid (cItemGrid &a_ItemGrid, 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...
virtual	~cSlotAreaItemGrid () override
Public Member Functions inherited from cSlotArea
virtual void	Clicked (cPlayer &a_Player, int a_SlotNum, eClickAction a_ClickAction, const cItem &a_ClickedItem)
	Called when a player clicks in the window. More...
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 ()
Public Member Functions inherited from cItemGrid::cListener
virtual	~cListener ()

Protected Member Functions
virtual void	OnSlotChanged (cItemGrid *a_ItemGrid, int a_SlotNum) override
	Called whenever a slot changes. More...

Protected Attributes
cItemGrid &	m_ItemGrid
Protected Attributes inherited from cSlotArea
int	m_NumSlots
cWindow &	m_ParentWindow

Private Types
using	Super = cSlotArea

Detailed Description

Handles any slot area that is representing a cItemGrid; same items for all the players.

Definition at line 197 of file SlotArea.h.

Member Typedef Documentation

Super

using cSlotAreaItemGrid::Super = cSlotArea

private

Definition at line 201 of file SlotArea.h.

Constructor & Destructor Documentation

cSlotAreaItemGrid()

cSlotAreaItemGrid::cSlotAreaItemGrid	(	cItemGrid &	a_ItemGrid,
		cWindow &	a_ParentWindow
	)

Definition at line 2604 of file SlotArea.cpp.

~cSlotAreaItemGrid()

cSlotAreaItemGrid::~cSlotAreaItemGrid ( )

overridevirtual

Definition at line 2615 of file SlotArea.cpp.

Member Function Documentation

GetSlot()

const cItem * cSlotAreaItemGrid::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 2624 of file SlotArea.cpp.

OnSlotChanged()

void cSlotAreaItemGrid::OnSlotChanged ( cItemGrid *  a_ItemGrid, int  a_SlotNum  )

overrideprotectedvirtual

Called whenever a slot changes.

Implements cItemGrid::cListener.

Definition at line 2642 of file SlotArea.cpp.

SetSlot()

void cSlotAreaItemGrid::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 2633 of file SlotArea.cpp.

Member Data Documentation

m_ItemGrid

cItemGrid& cSlotAreaItemGrid::m_ItemGrid

protected

Definition at line 213 of file SlotArea.h.

---

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

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