src/script/lua_api/l_env.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 "lua_api/l_base.h"
  23 #include "serverenvironment.h"
  24 #include "raycast.h"
  25
  26 class ModApiEnvMod : public ModApiBase {
  27 private:
  28         // set_node(pos, node)
  29         // pos = {x=num, y=num, z=num}
  30         static int l_set_node(lua_State *L);
  31
  32         // bulk_set_node([pos1, pos2, ...], node)
  33         // pos = {x=num, y=num, z=num}
  34         static int l_bulk_set_node(lua_State *L);
  35
  36         static int l_add_node(lua_State *L);
  37
  38         // remove_node(pos)
  39         // pos = {x=num, y=num, z=num}
  40         static int l_remove_node(lua_State *L);
  41
  42         // swap_node(pos, node)
  43         // pos = {x=num, y=num, z=num}
  44         static int l_swap_node(lua_State *L);
  45
  46         // get_node(pos)
  47         // pos = {x=num, y=num, z=num}
  48         static int l_get_node(lua_State *L);
  49
  50         // get_node_or_nil(pos)
  51         // pos = {x=num, y=num, z=num}
  52         static int l_get_node_or_nil(lua_State *L);
  53
  54         // get_node_light(pos, timeofday)
  55         // pos = {x=num, y=num, z=num}
  56         // timeofday: nil = current time, 0 = night, 0.5 = day
  57         static int l_get_node_light(lua_State *L);
  58
  59         // get_natural_light(pos, timeofday)
  60         // pos = {x=num, y=num, z=num}
  61         // timeofday: nil = current time, 0 = night, 0.5 = day
  62         static int l_get_natural_light(lua_State *L);
  63
  64         // place_node(pos, node)
  65         // pos = {x=num, y=num, z=num}
  66         static int l_place_node(lua_State *L);
  67
  68         // dig_node(pos)
  69         // pos = {x=num, y=num, z=num}
  70         static int l_dig_node(lua_State *L);
  71
  72         // punch_node(pos)
  73         // pos = {x=num, y=num, z=num}
  74         static int l_punch_node(lua_State *L);
  75
  76         // get_node_max_level(pos)
  77         // pos = {x=num, y=num, z=num}
  78         static int l_get_node_max_level(lua_State *L);
  79
  80         // get_node_level(pos)
  81         // pos = {x=num, y=num, z=num}
  82         static int l_get_node_level(lua_State *L);
  83
  84         // set_node_level(pos)
  85         // pos = {x=num, y=num, z=num}
  86         static int l_set_node_level(lua_State *L);
  87
  88         // add_node_level(pos)
  89         // pos = {x=num, y=num, z=num}
  90         static int l_add_node_level(lua_State *L);
  91
  92         // find_nodes_with_meta(pos1, pos2)
  93         static int l_find_nodes_with_meta(lua_State *L);
  94
  95         // get_meta(pos)
  96         static int l_get_meta(lua_State *L);
  97
  98         // get_node_timer(pos)
  99         static int l_get_node_timer(lua_State *L);
 100
 101         // add_entity(pos, entityname) -> ObjectRef or nil
 102         // pos = {x=num, y=num, z=num}
 103         static int l_add_entity(lua_State *L);
 104
 105         // add_item(pos, itemstack or itemstring or table) -> ObjectRef or nil
 106         // pos = {x=num, y=num, z=num}
 107         static int l_add_item(lua_State *L);
 108
 109         // get_connected_players()
 110         static int l_get_connected_players(lua_State *L);
 111
 112         // get_player_by_name(name)
 113         static int l_get_player_by_name(lua_State *L);
 114
 115         // get_objects_inside_radius(pos, radius)
 116         static int l_get_objects_inside_radius(lua_State *L);
 117
 118         // set_timeofday(val)
 119         // val = 0...1
 120         static int l_set_timeofday(lua_State *L);
 121
 122         // get_timeofday() -> 0...1
 123         static int l_get_timeofday(lua_State *L);
 124
 125         // get_gametime()
 126         static int l_get_gametime(lua_State *L);
 127
 128         // get_day_count() -> int
 129         static int l_get_day_count(lua_State *L);
 130
 131         // find_node_near(pos, radius, nodenames, search_center) -> pos or nil
 132         // nodenames: eg. {"ignore", "group:tree"} or "default:dirt"
 133         static int l_find_node_near(lua_State *L);
 134
 135         // find_nodes_near(pos, radius, nodenames, search_center) -> list of positions
 136         // nodenames: eg. {"ignore", "group:tree"} or "default:dirt"
 137         static int l_find_nodes_near(lua_State *L);
 138
 139         // find_nodes_near_under_air(pos, radius, nodenames, search_center) -> list of positions
 140         // nodenames: eg. {"ignore", "group:tree"} or "default:dirt"
 141         static int l_find_nodes_near_under_air(lua_State *L);
 142
 143         // find_nodes_near_under_air(pos, radius, nodenames, search_center) -> list of positions
 144         // nodenames: eg. {"ignore", "group:tree"} or "default:dirt"
 145         static int l_find_nodes_near_under_air_except(lua_State *L);
 146
 147         // find_nodes_in_area(minp, maxp, nodenames) -> list of positions
 148         // nodenames: eg. {"ignore", "group:tree"} or "default:dirt"
 149         static int l_find_nodes_in_area(lua_State *L);
 150
 151         // find_surface_nodes_in_area(minp, maxp, nodenames) -> list of positions
 152         // nodenames: eg. {"ignore", "group:tree"} or "default:dirt"
 153         static int l_find_nodes_in_area_under_air(lua_State *L);
 154
 155         // fix_light(p1, p2) -> true/false
 156         static int l_fix_light(lua_State *L);
 157
 158         // load_area(p1)
 159         static int l_load_area(lua_State *L);
 160
 161         // emerge_area(p1, p2)
 162         static int l_emerge_area(lua_State *L);
 163
 164         // delete_area(p1, p2) -> true/false
 165         static int l_delete_area(lua_State *L);
 166
 167         // get_perlin(seeddiff, octaves, persistence, scale)
 168         // returns world-specific PerlinNoise
 169         static int l_get_perlin(lua_State *L);
 170
 171         // get_perlin_map(noiseparams, size)
 172         // returns world-specific PerlinNoiseMap
 173         static int l_get_perlin_map(lua_State *L);
 174
 175         // get_voxel_manip()
 176         // returns world-specific voxel manipulator
 177         static int l_get_voxel_manip(lua_State *L);
 178
 179         // clear_objects()
 180         // clear all objects in the environment
 181         static int l_clear_objects(lua_State *L);
 182
 183         // spawn_tree(pos, treedef)
 184         static int l_spawn_tree(lua_State *L);
 185
 186         // line_of_sight(pos1, pos2) -> true/false
 187         static int l_line_of_sight(lua_State *L);
 188
 189         // raycast(pos1, pos2, objects, liquids) -> Raycast
 190         static int l_raycast(lua_State *L);
 191
 192         // find_path(pos1, pos2, searchdistance,
 193         //     max_jump, max_drop, algorithm) -> table containing path
 194         static int l_find_path(lua_State *L);
 195
 196         // transforming_liquid_add(pos)
 197         static int l_transforming_liquid_add(lua_State *L);
 198
 199         // forceload_block(blockpos)
 200         // forceloads a block
 201         static int l_forceload_block(lua_State *L);
 202
 203         // forceload_free_block(blockpos)
 204         // stops forceloading a position
 205         static int l_forceload_free_block(lua_State *L);
 206
 207         // Get a string translated server side
 208         static int l_get_translated_string(lua_State * L);
 209
 210         /* Helpers */
 211
 212         static void collectNodeIds(lua_State *L, int idx,
 213                 const NodeDefManager *ndef, std::vector<content_t> &filter);
 214
 215 public:
 216         static void Initialize(lua_State *L, int top);
 217         static void InitializeClient(lua_State *L, int top);
 218
 219         static struct EnumString es_ClearObjectsMode[];
 220 };
 221
 222 class LuaABM : public ActiveBlockModifier {
 223 private:
 224         int m_id;
 225
 226         std::vector<std::string> m_trigger_contents;
 227         std::vector<std::string> m_required_neighbors;
 228         float m_trigger_interval;
 229         u32 m_trigger_chance;
 230         bool m_simple_catch_up;
 231 public:
 232         LuaABM(lua_State *L, int id,
 233                         const std::vector<std::string> &trigger_contents,
 234                         const std::vector<std::string> &required_neighbors,
 235                         float trigger_interval, u32 trigger_chance, bool simple_catch_up):
 236                 m_id(id),
 237                 m_trigger_contents(trigger_contents),
 238                 m_required_neighbors(required_neighbors),
 239                 m_trigger_interval(trigger_interval),
 240                 m_trigger_chance(trigger_chance),
 241                 m_simple_catch_up(simple_catch_up)
 242         {
 243         }
 244         virtual const std::vector<std::string> &getTriggerContents() const
 245         {
 246                 return m_trigger_contents;
 247         }
 248         virtual const std::vector<std::string> &getRequiredNeighbors() const
 249         {
 250                 return m_required_neighbors;
 251         }
 252         virtual float getTriggerInterval()
 253         {
 254                 return m_trigger_interval;
 255         }
 256         virtual u32 getTriggerChance()
 257         {
 258                 return m_trigger_chance;
 259         }
 260         virtual bool getSimpleCatchUp()
 261         {
 262                 return m_simple_catch_up;
 263         }
 264         virtual void trigger(ServerEnvironment *env, v3s16 p, MapNode n,
 265                         u32 active_object_count, u32 active_object_count_wider);
 266 };
 267
 268 class LuaLBM : public LoadingBlockModifierDef
 269 {
 270 private:
 271         int m_id;
 272 public:
 273         LuaLBM(lua_State *L, int id,
 274                         const std::set<std::string> &trigger_contents,
 275                         const std::string &name,
 276                         bool run_at_every_load):
 277                 m_id(id)
 278         {
 279                 this->run_at_every_load = run_at_every_load;
 280                 this->trigger_contents = trigger_contents;
 281                 this->name = name;
 282         }
 283         virtual void trigger(ServerEnvironment *env, v3s16 p, MapNode n);
 284 };
 285
 286 //! Lua wrapper for RaycastState objects
 287 class LuaRaycast : public ModApiBase
 288 {
 289 private:
 290         static const char className[];
 291         static const luaL_Reg methods[];
 292         //! Inner state
 293         RaycastState state;
 294
 295         // Exported functions
 296
 297         // garbage collector
 298         static int gc_object(lua_State *L);
 299
 300         /*!
 301          * Raycast:next() -> pointed_thing
 302          * Returns the next pointed thing on the ray.
 303          */
 304         static int l_next(lua_State *L);
 305 public:
 306         //! Constructor with the same arguments as RaycastState.
 307         LuaRaycast(
 308                 const core::line3d<f32> &shootline,
 309                 bool objects_pointable,
 310                 bool liquids_pointable) :
 311                 state(shootline, objects_pointable, liquids_pointable)
 312         {}
 313
 314         //! Creates a LuaRaycast and leaves it on top of the stack.
 315         static int create_object(lua_State *L);
 316
 317         /*!
 318          * Returns the Raycast from the stack or throws an error.
 319          * @param narg location of the RaycastState in the stack
 320          */
 321         static LuaRaycast *checkobject(lua_State *L, int narg);
 322
 323         //! Registers Raycast as a Lua userdata type.
 324         static void Register(lua_State *L);
 325 };
 326
 327 struct ScriptCallbackState {
 328         ServerScripting *script;
 329         int callback_ref;
 330         int args_ref;
 331         unsigned int refcount;
 332         std::string origin;
 333 };