#include <SlotArea.h>

Inheritance diagram for cSlotAreaBeacon:

Collaboration diagram for cSlotAreaBeacon:

[legend]

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...

	cSlotAreaBeacon (cBeaconEntity *a_Beacon, cWindow &a_ParentWindow)

virtual void	DistributeStack (cItem &a_ItemStack, cPlayer &a_Player, bool a_ShouldApply, bool a_KeepEmptySlots, bool a_BackFill) override
	Called to store as much of a_ItemStack in the area as possible. More...

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	~cSlotAreaBeacon () override

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	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 ()

Static Public Member Functions
static bool	IsPlaceableItem (short a_ItemType)

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

Protected Attributes
cBeaconEntity *	m_Beacon

Protected Attributes inherited from cSlotArea
int	m_NumSlots

cWindow &	m_ParentWindow

Private Types
using	Super = cSlotArea

Detailed Description

Definition at line 353 of file SlotArea.h.

Member Typedef Documentation

◆ Super

using cSlotAreaBeacon::Super = cSlotArea

private

Definition at line 357 of file SlotArea.h.

Constructor & Destructor Documentation

◆ cSlotAreaBeacon()

cSlotAreaBeacon::cSlotAreaBeacon	(	cBeaconEntity *	a_Beacon,
		cWindow &	a_ParentWindow
	)

Definition at line 1291 of file SlotArea.cpp.

◆ ~cSlotAreaBeacon()

cSlotAreaBeacon::~cSlotAreaBeacon ( )

overridevirtual

Definition at line 1302 of file SlotArea.cpp.

Member Function Documentation

◆ Clicked()

void cSlotAreaBeacon::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.

Definition at line 1333 of file SlotArea.cpp.

◆ DistributeStack()

void cSlotAreaBeacon::DistributeStack	(	cItem &	a_ItemStack,
		cPlayer &	a_Player,
		bool	a_ShouldApply,
		bool	a_KeepEmptySlots,
		bool	a_BackFill
	)

overridevirtual

Called to store as much of a_ItemStack in the area as possible.

a_ItemStack is modified to reflect the change. The default implementation searches each slot for available space and distributes the stack there. if a_ShouldApply is true, the changes are written into the slots; if a_ShouldApply is false, only a_ItemStack is modified to reflect the number of fits (for fit-testing purposes) If a_KeepEmptySlots is true, empty slots will be skipped and won't be filled

Reimplemented from cSlotArea.

Definition at line 1435 of file SlotArea.cpp.

◆ GetSlot()

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

◆ IsPlaceableItem()

bool cSlotAreaBeacon::IsPlaceableItem ( short a_ItemType )

static

Definition at line 1311 of file SlotArea.cpp.

◆ OnSlotChanged()

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

overrideprotectedvirtual

Called whenever a slot changes.

Implements cItemGrid::cListener.

Definition at line 1474 of file SlotArea.cpp.

◆ SetSlot()

void cSlotAreaBeacon::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 1464 of file SlotArea.cpp.

Member Data Documentation

◆ m_Beacon

cBeaconEntity* cSlotAreaBeacon::m_Beacon

protected

Definition at line 372 of file SlotArea.h.

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

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Types

Detailed Description

Member Typedef Documentation

◆ Super

Constructor & Destructor Documentation

◆ cSlotAreaBeacon()

◆ ~cSlotAreaBeacon()

Member Function Documentation

◆ Clicked()

◆ DistributeStack()

◆ GetSlot()

◆ IsPlaceableItem()

◆ OnSlotChanged()

◆ SetSlot()

Member Data Documentation

◆ m_Beacon