src/script/common/c_content.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
  21 /******************************************************************************/
  22 /******************************************************************************/
  23 /* WARNING!!!! do NOT add this header in any include file or any code file    */
  24 /*             not being a script/modapi file!!!!!!!!                         */
  25 /******************************************************************************/
  26 /******************************************************************************/
  27
  28 #pragma once
  29
  30 extern "C" {
  31 #include <lua.h>
  32 }
  33
  34 #include <iostream>
  35 #include <vector>
  36
  37 #include "irrlichttypes_bloated.h"
  38 #include "util/string.h"
  39 #include "itemgroup.h"
  40 #include "itemdef.h"
  41 #include "c_types.h"
  42 #include "hud.h"
  43
  44 namespace Json { class Value; }
  45
  46 struct MapNode;
  47 class NodeDefManager;
  48 struct PointedThing;
  49 struct ItemStack;
  50 struct ItemDefinition;
  51 struct ToolCapabilities;
  52 struct ObjectProperties;
  53 struct SimpleSoundSpec;
  54 struct ServerSoundParams;
  55 class Inventory;
  56 struct NodeBox;
  57 struct ContentFeatures;
  58 struct TileDef;
  59 class Server;
  60 struct DigParams;
  61 struct HitParams;
  62 struct EnumString;
  63 struct NoiseParams;
  64 class Schematic;
  65 class ServerActiveObject;
  66
  67
  68 ContentFeatures    read_content_features     (lua_State *L, int index);
  69 void               push_content_features     (lua_State *L,
  70                                               const ContentFeatures &c);
  71
  72 void               push_nodebox              (lua_State *L,
  73                                               const NodeBox &box);
  74 void               push_box                  (lua_State *L,
  75                                               const std::vector<aabb3f> &box);
  76
  77 void               push_palette              (lua_State *L,
  78                                               const std::vector<video::SColor> *palette);
  79
  80 TileDef            read_tiledef              (lua_State *L, int index,
  81                                               u8 drawtype);
  82
  83 void               read_soundspec            (lua_State *L, int index,
  84                                               SimpleSoundSpec &spec);
  85 NodeBox            read_nodebox              (lua_State *L, int index);
  86
  87 void               read_server_sound_params  (lua_State *L, int index,
  88                                               ServerSoundParams &params);
  89
  90 void               push_dig_params           (lua_State *L,
  91                                               const DigParams &params);
  92 void               push_hit_params           (lua_State *L,
  93                                               const HitParams &params);
  94
  95 ItemStack          read_item                 (lua_State *L, int index, IItemDefManager *idef);
  96
  97 struct TileAnimationParams read_animation_definition(lua_State *L, int index);
  98
  99 ToolCapabilities   read_tool_capabilities    (lua_State *L, int table);
 100 void               push_tool_capabilities    (lua_State *L,
 101                                               const ToolCapabilities &prop);
 102
 103 void read_item_definition (lua_State *L, int index, const ItemDefinition &default_def,
 104                 ItemDefinition &def);
 105 void               push_item_definition      (lua_State *L,
 106                                               const ItemDefinition &i);
 107 void               push_item_definition_full (lua_State *L,
 108                                               const ItemDefinition &i);
 109
 110 void               read_object_properties    (lua_State *L, int index,
 111                                               ServerActiveObject *sao,
 112                                               ObjectProperties *prop,
 113                                               IItemDefManager *idef);
 114 void               push_object_properties    (lua_State *L,
 115                                               ObjectProperties *prop);
 116
 117 void               push_inventory_list       (lua_State *L,
 118                                               Inventory *inv,
 119                                               const char *name);
 120 void               read_inventory_list       (lua_State *L, int tableindex,
 121                                               Inventory *inv, const char *name,
 122                                               Server *srv, int forcesize=-1);
 123
 124 MapNode            readnode                  (lua_State *L, int index,
 125                                               const NodeDefManager *ndef);
 126 void               pushnode                  (lua_State *L, const MapNode &n,
 127                                               const NodeDefManager *ndef);
 128
 129
 130 void               read_groups               (lua_State *L, int index,
 131                                               ItemGroupList &result);
 132
 133 void               push_groups               (lua_State *L,
 134                                               const ItemGroupList &groups);
 135
 136 //TODO rename to "read_enum_field"
 137 int                getenumfield              (lua_State *L, int table,
 138                                               const char *fieldname,
 139                                               const EnumString *spec,
 140                                               int default_);
 141
 142 bool               getflagsfield             (lua_State *L, int table,
 143                                               const char *fieldname,
 144                                               FlagDesc *flagdesc,
 145                                               u32 *flags, u32 *flagmask);
 146
 147 bool               read_flags                (lua_State *L, int index,
 148                                               FlagDesc *flagdesc,
 149                                               u32 *flags, u32 *flagmask);
 150
 151 void               push_flags_string         (lua_State *L, FlagDesc *flagdesc,
 152                                               u32 flags, u32 flagmask);
 153
 154 u32                read_flags_table          (lua_State *L, int table,
 155                                               FlagDesc *flagdesc, u32 *flagmask);
 156
 157 void               push_items                (lua_State *L,
 158                                               const std::vector<ItemStack> &items);
 159
 160 std::vector<ItemStack> read_items            (lua_State *L,
 161                                               int index,
 162                                               Server* srv);
 163
 164 void               push_soundspec            (lua_State *L,
 165                                               const SimpleSoundSpec &spec);
 166
 167 bool               string_to_enum            (const EnumString *spec,
 168                                               int &result,
 169                                               const std::string &str);
 170
 171 bool               read_noiseparams          (lua_State *L, int index,
 172                                               NoiseParams *np);
 173 void               push_noiseparams          (lua_State *L, NoiseParams *np);
 174
 175 void               luaentity_get             (lua_State *L,u16 id);
 176
 177 bool               push_json_value           (lua_State *L,
 178                                               const Json::Value &value,
 179                                               int nullindex);
 180 void               read_json_value           (lua_State *L, Json::Value &root,
 181                                               int index, u8 recursion = 0);
 182
 183 /*!
 184  * Pushes a Lua `pointed_thing` to the given Lua stack.
 185  * \param csm If true, a client side pointed thing is pushed
 186  * \param hitpoint If true, the exact pointing location is also pushed
 187  */
 188 void push_pointed_thing(lua_State *L, const PointedThing &pointed, bool csm =
 189         false, bool hitpoint = false);
 190
 191 void               push_objectRef            (lua_State *L, const u16 id);
 192
 193 void               read_hud_element          (lua_State *L, HudElement *elem);
 194
 195 void               push_hud_element          (lua_State *L, HudElement *elem);
 196
 197 HudElementStat     read_hud_change           (lua_State *L, HudElement *elem, void **value);
 198
 199 extern struct EnumString es_TileAnimationType[];