ItemStack Struct Reference

#include <inventory.h>

Inheritance diagram for ItemStack:

Collaboration diagram for ItemStack:

Public Member Functions
	ItemStack ()=default
	ItemStack (const std::string &name_, u16 count_, u16 wear, IItemDefManager *itemdef)
	~ItemStack ()=default
void	serialize (std::ostream &os, bool serialize_meta=true) const
void	deSerialize (std::istream &is, IItemDefManager *itemdef=NULL)
void	deSerialize (const std::string &s, IItemDefManager *itemdef=NULL)
std::string	getItemString (bool include_meta=true) const
std::string	getDescription (const IItemDefManager *itemdef) const
std::string	getShortDescription (const IItemDefManager *itemdef) const
ItemImageDef	getInventoryImage (const IItemDefManager *itemdef) const
ItemImageDef	getInventoryOverlay (const IItemDefManager *itemdef) const
ItemImageDef	getWieldImage (const IItemDefManager *itemdef) const
ItemImageDef	getWieldOverlay (const IItemDefManager *itemdef) const
v3f	getWieldScale (const IItemDefManager *itemdef) const
bool	empty () const
void	clear ()
void	add (u16 n)
void	remove (u16 n)
u16	getStackMax (const IItemDefManager *itemdef) const
u16	freeSpace (const IItemDefManager *itemdef) const
bool	isKnown (const IItemDefManager *itemdef) const
const ItemDefinition &	getDefinition (const IItemDefManager *itemdef) const
const ToolCapabilities &	getToolCapabilities (const IItemDefManager *itemdef, const ItemStack *hand=nullptr) const
const std::optional< WearBarParams > &	getWearBarParams (const IItemDefManager *itemdef) const
bool	addWear (s32 amount, const IItemDefManager *itemdef)
ItemStack	addItem (ItemStack newitem, IItemDefManager *itemdef)
bool	itemFits (ItemStack newitem, ItemStack *restitem, IItemDefManager *itemdef) const
bool	stacksWith (const ItemStack &other) const
ItemStack	takeItem (u32 takecount)
ItemStack	peekItem (u32 peekcount) const
bool	operator== (const ItemStack &s) const
bool	operator!= (const ItemStack &s) const

Public Attributes
std::string	name = ""
u16	count = 0
u16	wear = 0
ItemStackMetadata	metadata

Constructor & Destructor Documentation

ItemStack() [1/2]

ItemStack::ItemStack ( )

default

References wear.

Referenced by addItem(), getToolCapabilities(), itemFits(), operator!=(), ItemStackRow::operator=(), operator==(), peekItem(), stacksWith(), and takeItem().

Here is the caller graph for this function:

ItemStack() [2/2]

ItemStack::ItemStack	(	const std::string &	name_,
		u16	count_,
		u16	wear,
		IItemDefManager *	itemdef )

References clear(), count, IItemDefManager::get(), ITEM_TOOL, name, ItemDefinition::type, and wear.

Here is the call graph for this function:

~ItemStack()

ItemStack::~ItemStack ( )

default

Member Function Documentation

add()

void ItemStack::add ( u16 n )

inline

References count.

Referenced by addItem(), InventoryList::moveItem(), and InventoryList::moveItemSomewhere().

Here is the caller graph for this function:

addItem()

ItemStack ItemStack::addItem	(	ItemStack	newitem,
		IItemDefManager *	itemdef )

References ItemStack(), add(), clear(), count, empty(), freeSpace(), metadata, name, and remove().

Referenced by LuaItemStack::l_add_item(), GUIFormSpecMenu::OnEvent(), and InventoryList::removeItem().

Here is the call graph for this function:

Here is the caller graph for this function:

addWear()

bool ItemStack::addWear	(	s32	amount,
		const IItemDefManager *	itemdef )

References clear(), getDefinition(), ITEM_TOOL, and wear.

Referenced by Server::handleCommand_Interact(), LuaItemStack::l_add_wear(), and LuaItemStack::l_add_wear_by_uses().

Here is the call graph for this function:

Here is the caller graph for this function:

clear()

void ItemStack::clear ( )

inline

References count, metadata, name, and wear.

Referenced by ItemStack(), addItem(), addWear(), deSerialize(), getCraftingResult(), itemFits(), LuaItemStack::l_clear(), LuaItemStack::l_set_count(), LuaItemStack::l_set_name(), LuaItemStack::l_set_wear(), InventoryList::moveItem(), remove(), and takeItem().

Here is the caller graph for this function:

deSerialize() [1/2]

void ItemStack::deSerialize	(	const std::string &	s,
		IItemDefManager *	itemdef = NULL )

References deSerialize().

Here is the call graph for this function:

deSerialize() [2/2]

void ItemStack::deSerialize	(	std::istream &	is,
		IItemDefManager *	itemdef = NULL )

References BasicStrfnd< T >::at_end(), clear(), content_mapnode_get_name_id_mapping(), content_translate_from_19_to_internal(), count, deSerializeJsonStringIfNeeded(), IItemDefManager::get(), IItemDefManager::getAlias(), NameIdMapping::getName(), ITEM_TOOL, metadata, name, BasicStrfnd< T >::next(), BasicStrfnd< T >::skip_over(), BasicStrfnd< T >::start(), stoi, trim(), ItemDefinition::type, and wear.

Referenced by GenericCAO::addToScene(), craftDecrementOrReplaceInput(), craftGetItemName(), InventoryList::deSerialize(), deSerialize(), GUIItemImage::draw(), TextDrawer::draw(), getCraftingResult(), CCraftDefManager::getCraftResult(), ModApiCraft::l_get_craft_result(), PlayerDatabaseSQLite3::loadPlayer(), parse_itemstack(), GUIFormSpecMenu::parseItemImageButton(), read_item(), and TestCraft::testShapeless().

Here is the call graph for this function:

Here is the caller graph for this function:

empty()

bool ItemStack::empty ( ) const

inline

References count.

Referenced by InventoryList::addItem(), addItem(), ICraftAction::apply(), IDropAction::apply(), IMoveAction::apply(), CraftDefinitionToolRepair::check(), GUIInventoryList::draw(), drawItemStack(), CraftDefinitionToolRepair::getOutput(), itemFits(), ModApiEnv::l_add_item(), LuaItemStack::l_is_empty(), InvRef::l_remove_item(), LuaItemStack::l_set_name(), LuaItemStack::l_to_table(), InventoryList::moveItem(), InventoryList::moveItemSomewhere(), GUIFormSpecMenu::OnEvent(), InventoryList::removeItem(), serialize(), InventoryList::takeItem(), TestMoveAction::testMoveUnallowed(), GUIFormSpecMenu::updateSelectedItem(), and GUIFormSpecMenu::verifySelectedItem().

Here is the caller graph for this function:

freeSpace()

u16 ItemStack::freeSpace ( const IItemDefManager * itemdef ) const

inline

References count, and getStackMax().

Referenced by addItem(), itemFits(), and LuaItemStack::l_get_free_space().

Here is the call graph for this function:

Here is the caller graph for this function:

getDefinition()

const ItemDefinition & ItemStack::getDefinition

(

const IItemDefManager *

itemdef

)

const

References IItemDefManager::get(), and name.

Referenced by addWear(), ItemVisualsManager::createItemVisuals(), drawItemStack(), getDescription(), getInventoryImage(), getInventoryOverlay(), getShortDescription(), getToolRange(), getWieldImage(), getWieldOverlay(), getWieldScale(), Game::handlePointingAtNode(), GUIFormSpecMenu::parseItemImageButton(), Game::processPlayerInteraction(), and WieldMeshSceneNode::setItem().

Here is the call graph for this function:

Here is the caller graph for this function:

getDescription()

std::string ItemStack::getDescription

(

const IItemDefManager *

itemdef

)

const

References ItemDefinition::description, getDefinition(), metadata, and name.

Referenced by GUIInventoryList::draw(), getShortDescription(), and LuaItemStack::l_get_description().

Here is the call graph for this function:

Here is the caller graph for this function:

getInventoryImage()

ItemImageDef ItemStack::getInventoryImage

(

const IItemDefManager *

itemdef

)

const

References getDefinition(), ItemDefinition::inventory_image, and metadata.

Referenced by ItemVisualsManager::createItemVisuals().

Here is the call graph for this function:

Here is the caller graph for this function:

getInventoryOverlay()

ItemImageDef ItemStack::getInventoryOverlay

(

const IItemDefManager *

itemdef

)

const

References getDefinition(), ItemDefinition::inventory_overlay, and metadata.

Referenced by ItemVisualsManager::createItemVisuals().

Here is the call graph for this function:

Here is the caller graph for this function:

getItemString()

std::string ItemStack::getItemString

(

bool

include_meta = true

)

const

References serialize().

Referenced by ICraftAction::apply(), CraftDefinitionToolRepair::getOutput(), ModApiEnv::l_add_item(), LuaItemStack::l_to_string(), LuaItemStack::mt_tostring(), read_object_properties(), TestMoveAction::testMove(), TestMoveAction::testMovePartial(), TestMoveAction::testMoveSomewhere(), TestMoveAction::testMoveSomewherePartial(), TestMoveAction::testMoveUnallowed(), TestMoveAction::testSwap(), TestMoveAction::testSwapFromUnallowed(), and TestMoveAction::testSwapToUnallowed().

Here is the call graph for this function:

Here is the caller graph for this function:

getShortDescription()

std::string ItemStack::getShortDescription

(

const IItemDefManager *

itemdef

)

const

References getDefinition(), getDescription(), metadata, and ItemDefinition::short_description.

Referenced by LuaItemStack::l_get_short_description().

Here is the call graph for this function:

Here is the caller graph for this function:

getStackMax()

u16 ItemStack::getStackMax

(

const IItemDefManager *

itemdef

)

const

References IItemDefManager::get(), name, and ItemDefinition::stack_max.

Referenced by freeSpace(), LuaItemStack::l_get_stack_max(), and GUIFormSpecMenu::OnEvent().

Here is the call graph for this function:

Here is the caller graph for this function:

getToolCapabilities()

const ToolCapabilities & ItemStack::getToolCapabilities	(	const IItemDefManager *	itemdef,
		const ItemStack *	hand = nullptr ) const

References ItemStack(), IItemDefManager::get(), ItemStackMetadata::getToolCapabilitiesOverride(), metadata, name, and ItemDefinition::tool_capabilities.

Referenced by GenericCAO::directReportPunch(), Server::handleCommand_Interact(), Game::handleDigging(), LuaItemStack::l_get_tool_capabilities(), and Game::updateCamera().

Here is the call graph for this function:

Here is the caller graph for this function:

getWearBarParams()

const std::optional< WearBarParams > & ItemStack::getWearBarParams

(

const IItemDefManager *

itemdef

)

const

References IItemDefManager::get(), metadata, name, and ItemDefinition::wear_bar_params.

Referenced by drawItemStack(), and LuaItemStack::l_get_wear_bar_params().

Here is the call graph for this function:

Here is the caller graph for this function:

getWieldImage()

ItemImageDef ItemStack::getWieldImage

(

const IItemDefManager *

itemdef

)

const

References getDefinition(), metadata, and ItemDefinition::wield_image.

Referenced by WieldMeshSceneNode::setItem().

Here is the call graph for this function:

Here is the caller graph for this function:

getWieldOverlay()

ItemImageDef ItemStack::getWieldOverlay

(

const IItemDefManager *

itemdef

)

const

References getDefinition(), metadata, and ItemDefinition::wield_overlay.

Referenced by WieldMeshSceneNode::setItem().

Here is the call graph for this function:

Here is the caller graph for this function:

getWieldScale()

v3f ItemStack::getWieldScale

(

const IItemDefManager *

itemdef

)

const

References getDefinition(), metadata, and str_to_v3f().

Referenced by WieldMeshSceneNode::setItem().

Here is the call graph for this function:

Here is the caller graph for this function:

isKnown()

bool ItemStack::isKnown

(

const IItemDefManager *

itemdef

)

const

References IItemDefManager::isKnown(), and name.

Referenced by CCraftDefManager::getCraftResult(), ModApiEnv::l_add_item(), and LuaItemStack::l_is_known().

Here is the call graph for this function:

Here is the caller graph for this function:

itemFits()

bool ItemStack::itemFits	(	ItemStack	newitem,
		ItemStack *	restitem,
		IItemDefManager *	itemdef ) const

References ItemStack(), clear(), count, empty(), freeSpace(), metadata, name, and remove().

Referenced by IMoveAction::apply(), and LuaItemStack::l_item_fits().

Here is the call graph for this function:

Here is the caller graph for this function:

operator!=()

bool ItemStack::operator!= ( const ItemStack & s ) const

inline

References ItemStack().

Here is the call graph for this function:

operator==()

bool ItemStack::operator== ( const ItemStack & s ) const

inline

References ItemStack(), count, metadata, name, and wear.

Here is the call graph for this function:

peekItem()

ItemStack ItemStack::peekItem

(

u32

peekcount

)

const

References ItemStack(), and count.

Referenced by LuaItemStack::l_peek_item().

Here is the call graph for this function:

Here is the caller graph for this function:

remove()

void ItemStack::remove ( u16 n )

inline

References clear(), and count.

Referenced by addItem(), itemFits(), InventoryList::moveItem(), and takeItem().

Here is the call graph for this function:

Here is the caller graph for this function:

serialize()

void ItemStack::serialize	(	std::ostream &	os,
		bool	serialize_meta = true ) const

References count, empty(), metadata, name, serializeJsonStringIfNeeded(), and wear.

Referenced by getItemString(), and PlayerDatabaseSQLite3::savePlayer().

Here is the call graph for this function:

Here is the caller graph for this function:

stacksWith()

bool ItemStack::stacksWith

(

const ItemStack &

other

)

const

References ItemStack(), metadata, name, and wear.

Referenced by GUIFormSpecMenu::OnEvent().

Here is the call graph for this function:

Here is the caller graph for this function:

takeItem()

ItemStack ItemStack::takeItem

(

u32

takecount

)

References ItemStack(), clear(), count, and remove().

Referenced by GUIInventoryList::draw(), and LuaItemStack::l_take_item().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

count

u16 ItemStack::count = 0

Referenced by ItemStack(), RollbackManager::actionRowsFromSelect(), add(), addItem(), IDropAction::apply(), IMoveAction::apply(), clear(), InventoryList::containsItem(), craftToolRepair(), deSerialize(), ScriptApiDetached::detached_inventory_AllowPut(), ScriptApiDetached::detached_inventory_AllowTake(), drawItemStack(), GUIFormSpecMenu::drawSelectedItem(), empty(), freeSpace(), itemFits(), InvRef::l_add_item(), LuaItemStack::l_get_count(), LuaItemStack::l_set_count(), LuaItemStack::l_to_table(), InventoryList::moveItem(), ScriptApiNodemeta::nodemeta_inventory_AllowPut(), ScriptApiNodemeta::nodemeta_inventory_AllowTake(), GUIFormSpecMenu::OnEvent(), operator==(), peekItem(), ScriptApiPlayer::player_inventory_AllowPut(), ScriptApiPlayer::player_inventory_AllowTake(), RollbackManager::registerRow(), remove(), InventoryList::removeItem(), serialize(), takeItem(), TestInventory::testSerializeDeserialize(), GUIFormSpecMenu::updateSelectedItem(), and GUIFormSpecMenu::verifySelectedItem().

metadata

ItemStackMetadata ItemStack::metadata

Referenced by addItem(), clear(), InventoryList::containsItem(), deSerialize(), drawItemStack(), getDescription(), getInventoryImage(), getInventoryOverlay(), ItemVisualsManager::getItemstackColor(), getShortDescription(), getToolCapabilities(), getToolRange(), getWearBarParams(), getWieldImage(), getWieldOverlay(), getWieldScale(), itemFits(), LuaItemStack::l_get_metadata(), LuaItemStack::l_set_metadata(), LuaItemStack::l_to_table(), Game::nodePlacement(), operator==(), read_item(), InventoryList::removeItem(), serialize(), stacksWith(), and Camera::wield().

name

std::string ItemStack::name = ""

Referenced by ItemStack(), RollbackManager::actionRowFromRollbackAction(), addItem(), IMoveAction::apply(), RollbackAction::applyRevert(), clear(), InventoryList::containsItem(), craftGetItemName(), craftToolRepair(), deSerialize(), GUIInventoryList::draw(), getDefinition(), getDescription(), ItemVisualsManager::getItemstackColor(), getPunchDamage(), getStackMax(), getToolCapabilities(), getWearBarParams(), Player::getWieldedItem(), Game::handleDigging(), isKnown(), ScriptApiItem::item_CraftPredict(), ScriptApiItem::item_OnCraft(), ScriptApiItem::item_OnDrop(), ScriptApiItem::item_OnPlace(), ScriptApiItem::item_OnSecondaryUse(), ScriptApiItem::item_OnUse(), itemFits(), LuaItemStack::l_get_definition(), LuaItemStack::l_get_name(), LuaItemStack::l_set_name(), LuaItemStack::l_to_table(), GUIFormSpecMenu::OnEvent(), operator==(), InventoryList::removeItem(), RollbackManager::rollbackActionsFromActionRows(), serialize(), stacksWith(), GUIFormSpecMenu::verifySelectedItem(), and Camera::wield().

wear

u16 ItemStack::wear = 0

Referenced by ItemStack(), ItemStack(), addWear(), clear(), craftToolRepair(), deSerialize(), GenericCAO::directReportPunch(), drawItemStack(), getPunchDamage(), Server::handleCommand_Interact(), Game::handleDigging(), LuaItemStack::l_add_wear_by_uses(), LuaItemStack::l_get_wear(), LuaItemStack::l_set_wear(), LuaItemStack::l_to_table(), operator==(), serialize(), and stacksWith().

---

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

• inventory.h
• inventory.cpp