Add '@n' escape sequences and some documentation on translated strings.

[minetest.git] / src / inventory.h

diff --git a/src/inventory.h b/src/inventory.h
index 7d7e58d610d9f5ae48ce7d65dd208748f07022d1..d04dc1e69f36f35d6b11285afee6235241e868bb 100644 (file)
--- a/src/inventory.h
+++ b/src/inventory.h
@@ -17,26 +17,27 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 
-#ifndef INVENTORY_HEADER
-#define INVENTORY_HEADER
+#pragma once
 
-#include "debug.h"
 #include "itemdef.h"
 #include "irrlichttypes.h"
+#include "itemstackmetadata.h"
 #include <istream>
 #include <ostream>
 #include <string>
 #include <vector>
+#include <cassert>
 
 struct ToolCapabilities;
 
 struct ItemStack
 {
-       ItemStack(): name(""), count(0), wear(0), metadata("") {}
-       ItemStack(std::string name_, u16 count_,
-                       u16 wear, std::string metadata_,
-                       IItemDefManager *itemdef);
-       ~ItemStack() {}
+       ItemStack() = default;
+
+       ItemStack(const std::string &name_, u16 count_,
+                       u16 wear, IItemDefManager *itemdef);
+
+       ~ItemStack() = default;
 
        // Serialization
        void serialize(std::ostream &os) const;
@@ -61,7 +62,7 @@ struct ItemStack
                name = "";
                count = 0;
                wear = 0;
-               metadata = "";
+               metadata.clear();
        }
 
        void add(u16 n)
@@ -132,23 +133,20 @@ struct ItemStack
                                wear += amount;
                        return true;
                }
-               else
-               {
-                       return false;
-               }
+
+               return false;
        }
 
        // If possible, adds newitem to this item.
        // If cannot be added at all, returns the item back.
        // If can be added partly, decremented item is returned back.
        // If can be added fully, empty item is returned.
-       ItemStack addItem(const ItemStack &newitem,
-                       IItemDefManager *itemdef);
+       ItemStack addItem(ItemStack newitem, IItemDefManager *itemdef);
 
        // Checks whether newitem could be added.
        // If restitem is non-NULL, it receives the part of newitem that
        // would be left over after adding.
-       bool itemFits(const ItemStack &newitem,
+       bool itemFits(ItemStack newitem,
                        ItemStack *restitem,  // may be NULL
                        IItemDefManager *itemdef) const;
 
@@ -163,17 +161,17 @@ struct ItemStack
        /*
                Properties
        */
-       std::string name;
-       u16 count;
-       u16 wear;
-       std::string metadata;
+       std::string name = "";
+       u16 count = 0;
+       u16 wear = 0;
+       ItemStackMetadata metadata;
 };
 
 class InventoryList
 {
 public:
-       InventoryList(std::string name, u32 size, IItemDefManager *itemdef);
-       ~InventoryList();
+       InventoryList(const std::string &name, u32 size, IItemDefManager *itemdef);
+       ~InventoryList() = default;
        void clearItems();
        void setSize(u32 newsize);
        void setWidth(u32 newWidth);
@@ -222,9 +220,10 @@ class InventoryList
        // Checks whether there is room for a given item
        bool roomForItem(const ItemStack &item) const;
 
-       // Checks whether the given count of the given item name
+       // Checks whether the given count of the given item
        // exists in this inventory list.
-       bool containsItem(const ItemStack &item) const;
+       // If match_meta is false, only the items' names are compared.
+       bool containsItem(const ItemStack &item, bool match_meta) const;
 
        // Removes the given count of the given item name from
        // this inventory list. Walks the list in reverse order.
@@ -238,9 +237,6 @@ class InventoryList
        // Returns empty item if couldn't take any.
        ItemStack takeItem(u32 i, u32 takecount);
 
-       // Similar to takeItem, but keeps the slot intact.
-       ItemStack peekItem(u32 i, u32 peekcount) const;
-
        // Move an item to a different list (or a different stack in the same list)
        // count is the maximum number of items to move (0 for everything)
        // returns number of moved items
@@ -253,8 +249,9 @@ class InventoryList
 
 private:
        std::vector<ItemStack> m_items;
-       u32 m_size, m_width;
        std::string m_name;
+       u32 m_size;
+       u32 m_width = 0;
        IItemDefManager *m_itemdef;
 };
 
@@ -309,8 +306,5 @@ class Inventory
 
        std::vector<InventoryList*> m_lists;
        IItemDefManager *m_itemdef;
-       bool m_dirty;
+       bool m_dirty = false;
 };
-
-#endif
-