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 struct collisionMoveResult;
  67
  68 extern struct EnumString es_TileAnimationType[];
  69
  70 ContentFeatures    read_content_features     (lua_State *L, int index);
  71 void               push_content_features     (lua_State *L,
  72                                               const ContentFeatures &c);
  73
  74 void               push_nodebox              (lua_State *L,
  75                                               const NodeBox &box);
  76 void               push_box                  (lua_State *L,
  77                                               const std::vector<aabb3f> &box);
  78
  79 void               push_palette              (lua_State *L,
  80                                               const std::vector<video::SColor> *palette);
  81
  82 TileDef            read_tiledef              (lua_State *L, int index,
  83                                               u8 drawtype);
  84
  85 void               read_soundspec            (lua_State *L, int index,
  86                                               SimpleSoundSpec &spec);
  87 NodeBox            read_nodebox              (lua_State *L, int index);
  88
  89 void               read_server_sound_params  (lua_State *L, int index,
  90                                               ServerSoundParams &params);
  91
  92 void               push_dig_params           (lua_State *L,
  93                                               const DigParams &params);
  94 void               push_hit_params           (lua_State *L,
  95                                               const HitParams &params);
  96
  97 ItemStack          read_item                 (lua_State *L, int index, IItemDefManager *idef);
  98
  99 struct TileAnimationParams read_animation_definition(lua_State *L, int index);
 100
 101 ToolCapabilities   read_tool_capabilities    (lua_State *L, int table);
 102 void               push_tool_capabilities    (lua_State *L,
 103                                               const ToolCapabilities &prop);
 104
 105 void read_item_definition (lua_State *L, int index, const ItemDefinition &default_def,
 106                 ItemDefinition &def);
 107 void               push_item_definition      (lua_State *L,
 108                                               const ItemDefinition &i);
 109 void               push_item_definition_full (lua_State *L,
 110                                               const ItemDefinition &i);
 111
 112 void               read_object_properties    (lua_State *L, int index,
 113                                               ServerActiveObject *sao,
 114                                               ObjectProperties *prop,
 115                                               IItemDefManager *idef);
 116 void               push_object_properties    (lua_State *L,
 117                                               ObjectProperties *prop);
 118
 119 void               push_inventory                (lua_State *L,
 120                                               Inventory *inventory);
 121
 122 void               push_inventory_list       (lua_State *L,
 123                                               Inventory *inv,
 124                                               const char *name);
 125 void               read_inventory_list       (lua_State *L, int tableindex,
 126                                               Inventory *inv, const char *name,
 127                                               Server *srv, int forcesize=-1);
 128
 129 MapNode            readnode                  (lua_State *L, int index,
 130                                               const NodeDefManager *ndef);
 131 void               pushnode                  (lua_State *L, const MapNode &n,
 132                                               const NodeDefManager *ndef);
 133
 134
 135 void               read_groups               (lua_State *L, int index,
 136                                               ItemGroupList &result);
 137
 138 void               push_groups               (lua_State *L,
 139                                               const ItemGroupList &groups);
 140
 141 //TODO rename to "read_enum_field"
 142 int                getenumfield              (lua_State *L, int table,
 143                                               const char *fieldname,
 144                                               const EnumString *spec,
 145                                               int default_);
 146
 147 bool               getflagsfield             (lua_State *L, int table,
 148                                               const char *fieldname,
 149                                               FlagDesc *flagdesc,
 150                                               u32 *flags, u32 *flagmask);
 151
 152 bool               read_flags                (lua_State *L, int index,
 153                                               FlagDesc *flagdesc,
 154                                               u32 *flags, u32 *flagmask);
 155
 156 void               push_flags_string         (lua_State *L, FlagDesc *flagdesc,
 157                                               u32 flags, u32 flagmask);
 158
 159 u32                read_flags_table          (lua_State *L, int table,
 160                                               FlagDesc *flagdesc, u32 *flagmask);
 161
 162 void               push_items                (lua_State *L,
 163                                               const std::vector<ItemStack> &items);
 164
 165 std::vector<ItemStack> read_items            (lua_State *L,
 166                                               int index,
 167                                               Server* srv);
 168
 169 void               push_soundspec            (lua_State *L,
 170                                               const SimpleSoundSpec &spec);
 171
 172 bool               string_to_enum            (const EnumString *spec,
 173                                               int &result,
 174                                               const std::string &str);
 175
 176 bool               read_noiseparams          (lua_State *L, int index,
 177                                               NoiseParams *np);
 178 void               push_noiseparams          (lua_State *L, NoiseParams *np);
 179
 180 void               luaentity_get             (lua_State *L,u16 id);
 181
 182 bool               push_json_value           (lua_State *L,
 183                                               const Json::Value &value,
 184                                               int nullindex);
 185 void               read_json_value           (lua_State *L, Json::Value &root,
 186                                               int index, u8 recursion = 0);
 187
 188 /*!
 189  * Pushes a Lua `pointed_thing` to the given Lua stack.
 190  * \param csm If true, a client side pointed thing is pushed
 191  * \param hitpoint If true, the exact pointing location is also pushed
 192  */
 193 void push_pointed_thing(lua_State *L, const PointedThing &pointed, bool csm =
 194         false, bool hitpoint = false);
 195
 196 void               push_objectRef            (lua_State *L, const u16 id);
 197
 198 void               read_hud_element          (lua_State *L, HudElement *elem);
 199
 200 void               push_hud_element          (lua_State *L, HudElement *elem);
 201
 202 HudElementStat     read_hud_change           (lua_State *L, HudElement *elem, void **value);
 203
 204 void               push_collision_move_result(lua_State *L, const collisionMoveResult &res);