---Version: 5.18 ---@meta ---An `ItemStack` is a stack of items. --- ---`ItemStack([x])`: returns an `ItemStack`. --- ---`x`: (optional) Is one of the following: --- * `nil` value: Empty stack --- * `string` value: an `"itemstring"`. --- * `table` value: `ItemStack` Table format. --- * The `name` field is mandatory. ---@class ItemStack ---@overload fun(x:ItemStack|ItemStackString|ItemStackTable|nil):ItemStack ItemStack = {} ---@class ItemStackTable: table ---@field name string ---@field count number ---@field wear number ---@field metadata string ---@alias ItemStackString string ---Returns true if stack is empty. ---@return boolean function ItemStack:is_empty() end ---Returns item name (e.g. `"default:stone"`). ---@return string function ItemStack:get_name() end ---Sets the item name. --- ---Returns `false` if the stack was cleared, `true` otherwise. ---@param item_name string ---@return boolean function ItemStack:set_name(item_name) end ---Returns amount of items on the stack. ---@return integer function ItemStack:get_count() end ---Sets amount of items in the stack. --- ---Returns `false` if the stack was cleared, `true` otherwise. ---@param count integer ---@return boolean function ItemStack:set_count(count) end ---Returns tool wear (integer in range [0, 65535]), `0` for non-tools. ---@return integer function ItemStack:get_wear() end ---Set tool wear. --- ---Returns `false` if the stack was cleared, `true` otherwise ---@param wear integer ---@return boolean function ItemStack:set_wear(wear) end ---@return ItemStackMetaRef function ItemStack:get_meta() end ---@deprecated function ItemStack:get_metadata() end ---@deprecated function ItemStack:set_metadata() end ---Returns the description shown in inventory list tooltips. ---@return string function ItemStack:get_description() end ---Returns the short description. ---@return string function ItemStack:get_short_description() end ---Removes all items from the stack, making it empty. function ItemStack:clear() end ---Replace the contents of this stack. ---@param item ItemStack|ItemStackString|ItemStackTable function ItemStack:replace(item) end ---Returns the stack in `itemstring` form. ---@return string function ItemStack:to_string() end ---Returns the stack in Lua table form. --- ---Returns `nil` if the stack is empty ---@return ItemStackTable? function ItemStack:to_table() end ---Returns the maximum size of the stack (depends on the item). ---@return integer function ItemStack:get_stack_max() end ---Returns `get_stack_max() - get_count()`. ---@return integer function ItemStack:get_free_space() end ---Returns `true` if the item name refers to a defined item type. ---@return boolean function ItemStack:is_known() end ---Returns the item definition table. --- ---Returns the definition of the `unknown` item if the item is not registered. ---@return ItemDefinition|NodeDefinition function ItemStack:get_definition() end ---Returns the digging properties of the item, ---or those of the hand if none are defined for this item type. ---@return ItemDefinition.tool_capabilities_table function ItemStack:get_tool_capabilities() end ---Increases wear by `amount` if the item is a tool, otherwise does nothing. ---@param amount integer function ItemStack:add_wear(amount) end ---Increases wear in such a way that, ---if only this function is called, the item breaks after `max_uses` times. --- ---Does nothing if item is not a tool or if `max_uses` is `0`. ---@param max_uses integer function ItemStack:add_wear_by_uses(max_uses) end ---Returns the wear bar parameters of the item, ---or nil if none are defined for this item type or in the stack's meta. ---@return ItemDefinition.wearbar_color_table function ItemStack:get_wear_bar_params() end ---Put some item or stack onto this stack. --- ---Returns leftover ItemStack. ---@param item ItemStack|ItemStackString|ItemStackTable ---@return self function ItemStack:add_item(item) end ---Returns `true` if item or stack can be fully added to this one ---@param item ItemStack|ItemStackString|ItemStackTable ---@return boolean function ItemStack:item_fits(item) end ---Take (and remove) up to `n` items from this stack. ---@param count number? default: `1` ---@return ItemStack function ItemStack:take_item(count) end ---Copy (don't remove) up to `n` items from this stack. ---@param count number? default: `1` ---@return ItemStack function ItemStack:peek_item(count) end ---Returns `true` if this stack is identical to other. --- ---**Note**: stack1:to_string() == stack2:to_string() is not reliable, ---as stack metadata can be serialized in arbitrary order. --- ---**Note**: if other is an itemstring or table representation of an ItemStack, ---this will always return false, even if it is "equivalent". ---@param other ItemStack|ItemStackString|ItemStackTable ---@return boolean function ItemStack:equals(other) end