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
  25 struct PointedThing;
  26 struct ItemStack;
  27 class ServerActiveObject;
  28 struct ItemDefinition;
  29 class LuaItemStack;
  30 class ModApiItemMod;
  31 class InventoryList;
  32 struct InventoryLocation;
  33
  34 class ScriptApiItem
  35 : virtual public ScriptApiBase
  36 {
  37 public:
  38         bool item_OnDrop(ItemStack &item,
  39                         ServerActiveObject *dropper, v3f pos);
  40         bool item_OnPlace(ItemStack &item,
  41                         ServerActiveObject *placer, const PointedThing &pointed);
  42         bool item_OnUse(ItemStack &item,
  43                         ServerActiveObject *user, const PointedThing &pointed);
  44         bool item_OnSecondaryUse(ItemStack &item,
  45                         ServerActiveObject *user, const PointedThing &pointed);
  46         bool item_OnCraft(ItemStack &item, ServerActiveObject *user,
  47                         const InventoryList *old_craft_grid, const InventoryLocation &craft_inv);
  48         bool item_CraftPredict(ItemStack &item, ServerActiveObject *user,
  49                         const InventoryList *old_craft_grid, const InventoryLocation &craft_inv);
  50
  51 protected:
  52         friend class LuaItemStack;
  53         friend class ModApiItemMod;
  54
  55         bool getItemCallback(const char *name, const char *callbackname, const v3s16 *p = nullptr);
  56         /*!
  57          * Pushes a `pointed_thing` tabe to the stack.
  58          * \param hitpoint If true, the exact pointing location is also pushed
  59          */
  60         void pushPointedThing(const PointedThing &pointed, bool hitpoint = false);
  61
  62 };