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 #ifndef L_ENV_H_
  21 #define L_ENV_H_
  22
  23 #include "lua_api/l_base.h"
  24 #include "environment.h"
  25
  26 class ModApiEnvMod : public ModApiBase {
  27 private:
  28         // minetest.set_node(pos, node)
  29         // pos = {x=num, y=num, z=num}
  30         static int l_set_node(lua_State *L);
  31
  32         static int l_add_node(lua_State *L);
  33
  34         // minetest.remove_node(pos)
  35         // pos = {x=num, y=num, z=num}
  36         static int l_remove_node(lua_State *L);
  37
  38         // minetest.get_node(pos)
  39         // pos = {x=num, y=num, z=num}
  40         static int l_get_node(lua_State *L);
  41
  42         // minetest.get_node_or_nil(pos)
  43         // pos = {x=num, y=num, z=num}
  44         static int l_get_node_or_nil(lua_State *L);
  45
  46         // minetest.get_node_light(pos, timeofday)
  47         // pos = {x=num, y=num, z=num}
  48         // timeofday: nil = current time, 0 = night, 0.5 = day
  49         static int l_get_node_light(lua_State *L);
  50
  51         // minetest.place_node(pos, node)
  52         // pos = {x=num, y=num, z=num}
  53         static int l_place_node(lua_State *L);
  54
  55         // minetest.dig_node(pos)
  56         // pos = {x=num, y=num, z=num}
  57         static int l_dig_node(lua_State *L);
  58
  59         // minetest.punch_node(pos)
  60         // pos = {x=num, y=num, z=num}
  61         static int l_punch_node(lua_State *L);
  62
  63
  64         // minetest.get_node_max_level(pos)
  65         // pos = {x=num, y=num, z=num}
  66         static int l_get_node_max_level(lua_State *L);
  67
  68         // minetest.get_node_level(pos)
  69         // pos = {x=num, y=num, z=num}
  70         static int l_get_node_level(lua_State *L);
  71
  72         // minetest.set_node_level(pos)
  73         // pos = {x=num, y=num, z=num}
  74         static int l_set_node_level(lua_State *L);
  75
  76         // minetest.add_node_level(pos)
  77         // pos = {x=num, y=num, z=num}
  78         static int l_add_node_level(lua_State *L);
  79
  80         // minetest.get_meta(pos)
  81         static int l_get_meta(lua_State *L);
  82
  83         // minetest.get_node_timer(pos)
  84         static int l_get_node_timer(lua_State *L);
  85
  86         // minetest.add_entity(pos, entityname) -> ObjectRef or nil
  87         // pos = {x=num, y=num, z=num}
  88         static int l_add_entity(lua_State *L);
  89
  90         // minetest.add_item(pos, itemstack or itemstring or table) -> ObjectRef or nil
  91         // pos = {x=num, y=num, z=num}
  92         static int l_add_item(lua_State *L);
  93
  94         // minetest.get_player_by_name(name)
  95         static int l_get_player_by_name(lua_State *L);
  96
  97         // minetest.get_objects_inside_radius(pos, radius)
  98         static int l_get_objects_inside_radius(lua_State *L);
  99
 100         // minetest.set_timeofday(val)
 101         // val = 0...1
 102         static int l_set_timeofday(lua_State *L);
 103
 104         // minetest.get_timeofday() -> 0...1
 105         static int l_get_timeofday(lua_State *L);
 106
 107         // minetest.find_node_near(pos, radius, nodenames) -> pos or nil
 108         // nodenames: eg. {"ignore", "group:tree"} or "default:dirt"
 109         static int l_find_node_near(lua_State *L);
 110
 111         // minetest.find_nodes_in_area(minp, maxp, nodenames) -> list of positions
 112         // nodenames: eg. {"ignore", "group:tree"} or "default:dirt"
 113         static int l_find_nodes_in_area(lua_State *L);
 114
 115         // minetest.get_perlin(seeddiff, octaves, persistence, scale)
 116         // returns world-specific PerlinNoise
 117         static int l_get_perlin(lua_State *L);
 118
 119         // minetest.get_perlin_map(noiseparams, size)
 120         // returns world-specific PerlinNoiseMap
 121         static int l_get_perlin_map(lua_State *L);
 122
 123         // minetest.get_voxel_manip()
 124         // returns world-specific voxel manipulator
 125         static int l_get_voxel_manip(lua_State *L);
 126
 127         // minetest.clear_objects()
 128         // clear all objects in the environment
 129         static int l_clear_objects(lua_State *L);
 130
 131         // minetest.spawn_tree(pos, treedef)
 132         static int l_spawn_tree(lua_State *L);
 133
 134         // minetest.line_of_sight(pos1, pos2, stepsize) -> true/false
 135         static int l_line_of_sight(lua_State *L);
 136
 137         // minetest.find_path(pos1, pos2, searchdistance,
 138         //     max_jump, max_drop, algorithm) -> table containing path
 139         static int l_find_path(lua_State *L);
 140
 141         // minetest.transforming_liquid_add(pos)
 142         static int l_transforming_liquid_add(lua_State *L);
 143
 144         static int l_get_heat(lua_State *L);
 145         static int l_get_humidity(lua_State *L);
 146
 147 public:
 148         static void Initialize(lua_State *L, int top);
 149 };
 150
 151 class LuaABM : public ActiveBlockModifier
 152 {
 153 private:
 154         int m_id;
 155
 156         std::set<std::string> m_trigger_contents;
 157         std::set<std::string> m_required_neighbors;
 158         float m_trigger_interval;
 159         u32 m_trigger_chance;
 160 public:
 161         LuaABM(lua_State *L, int id,
 162                         const std::set<std::string> &trigger_contents,
 163                         const std::set<std::string> &required_neighbors,
 164                         float trigger_interval, u32 trigger_chance):
 165                 m_id(id),
 166                 m_trigger_contents(trigger_contents),
 167                 m_required_neighbors(required_neighbors),
 168                 m_trigger_interval(trigger_interval),
 169                 m_trigger_chance(trigger_chance)
 170         {
 171         }
 172         virtual std::set<std::string> getTriggerContents()
 173         {
 174                 return m_trigger_contents;
 175         }
 176         virtual std::set<std::string> getRequiredNeighbors()
 177         {
 178                 return m_required_neighbors;
 179         }
 180         virtual float getTriggerInterval()
 181         {
 182                 return m_trigger_interval;
 183         }
 184         virtual u32 getTriggerChance()
 185         {
 186                 return m_trigger_chance;
 187         }
 188         virtual void trigger(ServerEnvironment *env, v3s16 p, MapNode n,
 189                         u32 active_object_count, u32 active_object_count_wider);
 190 };
 191
 192 #endif /* L_ENV_H_ */