cItemShovelHandler Class Reference

#include <ItemShovel.h>

Inheritance diagram for cItemShovelHandler:

Collaboration diagram for cItemShovelHandler:

Public Member Functions
virtual bool	CanHarvestBlock (BLOCKTYPE a_BlockType) const override
	Returns whether this tool / item can harvest a specific block (e.g. More...
virtual bool	CanRepairWithRawMaterial (short a_ItemType) const override
	Can the anvil repair this item, when a_Item is the second input? More...
virtual float	GetBlockBreakingStrength (BLOCKTYPE a_Block) const override
	Returns the strength to break a specific block. More...
virtual short	GetDurabilityLossByAction (eDurabilityLostAction a_Action) const override
	Get the durability lost which the item will get, when a specified action was performed. More...
Public Member Functions inherited from cItemHandler
constexpr	cItemHandler (int a_ItemType)
virtual bool	EatItem (cPlayer *a_Player, cItem *a_Item) const
	Lets the player eat a selected item. More...
virtual FoodInfo	GetFoodInfo (const cItem *a_Item) const
	Returns the FoodInfo for this item. More...
virtual char	GetMaxStackSize (void) const
	Returns the maximum stack size for a given item. More...
virtual bool	IsDrinkable (short a_ItemDamage) const
	Indicates if this item is drinkable. More...
virtual bool	IsFood (void) const
	Indicates if this item is food. More...
virtual bool	IsPlaceable (void) const
	Blocks simply get placed. More...
virtual bool	OnDiggingBlock (cWorld *a_World, cPlayer *a_Player, const cItem &a_HeldItem, const Vector3i a_ClickedBlockPos, eBlockFace a_ClickedBlockFace) const
	Called while the player digs a block using this item. More...
virtual void	OnEntityAttack (cPlayer *a_Attacker, cEntity *a_AttackedEntity) const
	Called when a player attacks an entity with this item in hand. More...
virtual void	OnFoodEaten (cWorld *a_World, cPlayer *a_Player, cItem *a_Item) const
	Called after the player has eaten this item. More...
virtual void	OnItemShoot (cPlayer *, const Vector3i a_BlockPos, eBlockFace a_BlockFace) const
	Called when the client sends the SHOOT status in the lclk packet (releasing the bow). More...
virtual bool	OnItemUse (cWorld *a_World, cPlayer *a_Player, cBlockPluginInterface &a_PluginInterface, const cItem &a_HeldItem, const Vector3i a_ClickedBlockPos, eBlockFace a_ClickedBlockFace) const
	Called when the player tries to use the item (right mouse button). More...
void	OnPlayerPlace (cPlayer &a_Player, const cItem &a_HeldItem, Vector3i a_ClickedPosition, BLOCKTYPE a_ClickedBlockType, NIBBLETYPE a_ClickedBlockMeta, eBlockFace a_ClickedBlockFace, Vector3i a_CursorPosition) const
	Called when the player tries to place the item (right mouse button, IsPlaceable() == true). More...
virtual void	OnUpdate (cWorld *a_World, cPlayer *a_Player, const cItem &a_Item) const
	Called every tick while the item is on the player's inventory (used by maps, for example) - For now, called only for equipped items. More...

Private Types
using	Super = cItemHandler

Additional Inherited Members
Public Types inherited from cItemHandler
enum	eDurabilityLostAction { dlaAttackEntity , dlaBreakBlock , dlaBreakBlockInstant }
	Actions that may cause durability of an item may be lost, where the magnitude of the loss depends on the specific item used to perform the action. More...
Protected Member Functions inherited from cItemHandler
virtual bool	CommitPlacement (cPlayer &a_Player, const cItem &a_HeldItem, Vector3i a_PlacePosition, eBlockFace a_ClickedBlockFace, Vector3i a_CursorPosition) const
	Performs the actual placement of this placeable item. More...
	~cItemHandler ()=default
Static Protected Member Functions inherited from cItemHandler
static const cItemHandler &	For (int a_ItemType)
Protected Attributes inherited from cItemHandler
const int	m_ItemType

Detailed Description

Definition at line 15 of file ItemShovel.h.

Member Typedef Documentation

Super

using cItemShovelHandler::Super = cItemHandler

private

Definition at line 18 of file ItemShovel.h.

Member Function Documentation

CanHarvestBlock()

virtual bool cItemShovelHandler::CanHarvestBlock ( BLOCKTYPE  a_BlockType ) const

inlineoverridevirtual

Returns whether this tool / item can harvest a specific block (e.g.

iron pickaxe can harvest diamond ore, but wooden one can't). Defaults to false unless overridden.

Reimplemented from cItemHandler.

Definition at line 41 of file ItemShovel.h.

CanRepairWithRawMaterial()

virtual bool cItemShovelHandler::CanRepairWithRawMaterial ( short  a_ItemType ) const

inlineoverridevirtual

Can the anvil repair this item, when a_Item is the second input?

Reimplemented from cItemHandler.

Definition at line 54 of file ItemShovel.h.

GetBlockBreakingStrength()

virtual float cItemShovelHandler::GetBlockBreakingStrength ( BLOCKTYPE  a_Block ) const

inlineoverridevirtual

Returns the strength to break a specific block.

Defaults to 1 unless overriden.

Reimplemented from cItemHandler.

Definition at line 71 of file ItemShovel.h.

GetDurabilityLossByAction()

virtual short cItemShovelHandler::GetDurabilityLossByAction ( eDurabilityLostAction  a_Action ) const

inlineoverridevirtual

Get the durability lost which the item will get, when a specified action was performed.

This is only relevant for uses where the damage taken may depend on the item used.

Reimplemented from cItemHandler.

Definition at line 26 of file ItemShovel.h.

---

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

• src/Items/ItemShovel.h