src/script/cpp_api/s_item.h

   1 /*
   2 Minetest
   3 Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
   4
   5 This program is free software; you can redistribute it and/or modify
   6 it under the terms of the GNU Lesser General Public License as published by
   7 the Free Software Foundation; either version 2.1 of the License, or
   8 (at your option) any later version.
   9
  10 This program is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 GNU Lesser General Public License for more details.
  14
  15 You should have received a copy of the GNU Lesser General Public License along
  16 with this program; if not, write to the Free Software Foundation, Inc.,
  17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 */
  19
  20 #pragma once
  21
  22 #include "cpp_api/s_base.h"
  23 #include "irr_v3d.h"
  24 #include "util/Optional.h"
  25
  26 struct PointedThing;
  27 struct ItemStack;
  28 class ServerActiveObject;
  29 struct ItemDefinition;
  30 class LuaItemStack;
  31 class ModApiItemMod;
  32 class InventoryList;
  33 struct InventoryLocation;
  34
  35 class ScriptApiItem
  36 : virtual public ScriptApiBase
  37 {
  38 public:
  39         /*
  40          * Functions with Optional<ItemStack> are for callbacks where Lua may
  41          * want to prevent the engine from modifying the inventory after it's done.
  42          * This has a longer backstory where on_use may need to empty the player's
  43          * inventory without the engine interfering (see issue #6546).
  44          */
  45
  46         bool item_OnDrop(ItemStack &item,
  47                         ServerActiveObject *dropper, v3f pos);
  48         bool item_OnPlace(Optional<ItemStack> &item,
  49                         ServerActiveObject *placer, const PointedThing &pointed);
  50         bool item_OnUse(Optional<ItemStack> &item,
  51                         ServerActiveObject *user, const PointedThing &pointed);
  52         bool item_OnSecondaryUse(Optional<ItemStack> &item,
  53                         ServerActiveObject *user, const PointedThing &pointed);
  54         bool item_OnCraft(ItemStack &item, ServerActiveObject *user,
  55                         const InventoryList *old_craft_grid, const InventoryLocation &craft_inv);
  56         bool item_CraftPredict(ItemStack &item, ServerActiveObject *user,
  57                         const InventoryList *old_craft_grid, const InventoryLocation &craft_inv);
  58
  59 protected:
  60         friend class LuaItemStack;
  61         friend class ModApiItemMod;
  62
  63         bool getItemCallback(const char *name, const char *callbackname, const v3s16 *p = nullptr);
  64         /*!
  65          * Pushes a `pointed_thing` tabe to the stack.
  66          * \param hitpoint If true, the exact pointing location is also pushed
  67          */
  68         void pushPointedThing(const PointedThing &pointed, bool hitpoint = false);
  69
  70 };