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 "serverenvironment.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         static int l_add_node(lua_State *L);
  33
  34         // remove_node(pos)
  35         // pos = {x=num, y=num, z=num}
  36         static int l_remove_node(lua_State *L);
  37
  38         // swap_node(pos, node)
  39         // pos = {x=num, y=num, z=num}
  40         static int l_swap_node(lua_State *L);
  41
  42         // get_node(pos)
  43         // pos = {x=num, y=num, z=num}
  44         static int l_get_node(lua_State *L);
  45
  46         // get_node_or_nil(pos)
  47         // pos = {x=num, y=num, z=num}
  48         static int l_get_node_or_nil(lua_State *L);
  49
  50         // get_node_light(pos, timeofday)
  51         // pos = {x=num, y=num, z=num}
  52         // timeofday: nil = current time, 0 = night, 0.5 = day
  53         static int l_get_node_light(lua_State *L);
  54
  55         // place_node(pos, node)
  56         // pos = {x=num, y=num, z=num}
  57         static int l_place_node(lua_State *L);
  58
  59         // dig_node(pos)
  60         // pos = {x=num, y=num, z=num}
  61         static int l_dig_node(lua_State *L);
  62
  63         // punch_node(pos)
  64         // pos = {x=num, y=num, z=num}
  65         static int l_punch_node(lua_State *L);
  66
  67         // get_node_max_level(pos)
  68         // pos = {x=num, y=num, z=num}
  69         static int l_get_node_max_level(lua_State *L);
  70
  71         // get_node_level(pos)
  72         // pos = {x=num, y=num, z=num}
  73         static int l_get_node_level(lua_State *L);
  74
  75         // set_node_level(pos)
  76         // pos = {x=num, y=num, z=num}
  77         static int l_set_node_level(lua_State *L);
  78
  79         // add_node_level(pos)
  80         // pos = {x=num, y=num, z=num}
  81         static int l_add_node_level(lua_State *L);
  82
  83         // find_nodes_with_meta(pos1, pos2)
  84         static int l_find_nodes_with_meta(lua_State *L);
  85
  86         // get_meta(pos)
  87         static int l_get_meta(lua_State *L);
  88
  89         // get_node_timer(pos)
  90         static int l_get_node_timer(lua_State *L);
  91
  92         // add_entity(pos, entityname) -> ObjectRef or nil
  93         // pos = {x=num, y=num, z=num}
  94         static int l_add_entity(lua_State *L);
  95
  96         // add_item(pos, itemstack or itemstring or table) -> ObjectRef or nil
  97         // pos = {x=num, y=num, z=num}
  98         static int l_add_item(lua_State *L);
  99
 100         // get_player_by_name(name)
 101         static int l_get_player_by_name(lua_State *L);
 102
 103         // get_objects_inside_radius(pos, radius)
 104         static int l_get_objects_inside_radius(lua_State *L);
 105
 106         // set_timeofday(val)
 107         // val = 0...1
 108         static int l_set_timeofday(lua_State *L);
 109
 110         // get_timeofday() -> 0...1
 111         static int l_get_timeofday(lua_State *L);
 112
 113         // get_gametime()
 114         static int l_get_gametime(lua_State *L);
 115
 116         // get_day_count() -> int
 117         static int l_get_day_count(lua_State *L);
 118
 119         // find_node_near(pos, radius, nodenames) -> pos or nil
 120         // nodenames: eg. {"ignore", "group:tree"} or "default:dirt"
 121         static int l_find_node_near(lua_State *L);
 122
 123         // find_nodes_in_area(minp, maxp, nodenames) -> list of positions
 124         // nodenames: eg. {"ignore", "group:tree"} or "default:dirt"
 125         static int l_find_nodes_in_area(lua_State *L);
 126
 127         // find_surface_nodes_in_area(minp, maxp, nodenames) -> list of positions
 128         // nodenames: eg. {"ignore", "group:tree"} or "default:dirt"
 129         static int l_find_nodes_in_area_under_air(lua_State *L);
 130
 131         // emerge_area(p1, p2)
 132         static int l_emerge_area(lua_State *L);
 133
 134         // delete_area(p1, p2) -> true/false
 135         static int l_delete_area(lua_State *L);
 136
 137         // get_perlin(seeddiff, octaves, persistence, scale)
 138         // returns world-specific PerlinNoise
 139         static int l_get_perlin(lua_State *L);
 140
 141         // get_perlin_map(noiseparams, size)
 142         // returns world-specific PerlinNoiseMap
 143         static int l_get_perlin_map(lua_State *L);
 144
 145         // get_voxel_manip()
 146         // returns world-specific voxel manipulator
 147         static int l_get_voxel_manip(lua_State *L);
 148
 149         // clear_objects()
 150         // clear all objects in the environment
 151         static int l_clear_objects(lua_State *L);
 152
 153         // spawn_tree(pos, treedef)
 154         static int l_spawn_tree(lua_State *L);
 155
 156         // line_of_sight(pos1, pos2, stepsize) -> true/false
 157         static int l_line_of_sight(lua_State *L);
 158
 159         // find_path(pos1, pos2, searchdistance,
 160         //     max_jump, max_drop, algorithm) -> table containing path
 161         static int l_find_path(lua_State *L);
 162
 163         // transforming_liquid_add(pos)
 164         static int l_transforming_liquid_add(lua_State *L);
 165
 166         // forceload_block(blockpos)
 167         // forceloads a block
 168         static int l_forceload_block(lua_State *L);
 169
 170         // forceload_free_block(blockpos)
 171         // stops forceloading a position
 172         static int l_forceload_free_block(lua_State *L);
 173
 174 public:
 175         static void Initialize(lua_State *L, int top);
 176         static void InitializeClient(lua_State *L, int top);
 177
 178         static struct EnumString es_ClearObjectsMode[];
 179 };
 180
 181 class LuaABM : public ActiveBlockModifier {
 182 private:
 183         int m_id;
 184
 185         std::set<std::string> m_trigger_contents;
 186         std::set<std::string> m_required_neighbors;
 187         float m_trigger_interval;
 188         u32 m_trigger_chance;
 189         bool m_simple_catch_up;
 190 public:
 191         LuaABM(lua_State *L, int id,
 192                         const std::set<std::string> &trigger_contents,
 193                         const std::set<std::string> &required_neighbors,
 194                         float trigger_interval, u32 trigger_chance, bool simple_catch_up):
 195                 m_id(id),
 196                 m_trigger_contents(trigger_contents),
 197                 m_required_neighbors(required_neighbors),
 198                 m_trigger_interval(trigger_interval),
 199                 m_trigger_chance(trigger_chance),
 200                 m_simple_catch_up(simple_catch_up)
 201         {
 202         }
 203         virtual std::set<std::string> getTriggerContents()
 204         {
 205                 return m_trigger_contents;
 206         }
 207         virtual std::set<std::string> getRequiredNeighbors()
 208         {
 209                 return m_required_neighbors;
 210         }
 211         virtual float getTriggerInterval()
 212         {
 213                 return m_trigger_interval;
 214         }
 215         virtual u32 getTriggerChance()
 216         {
 217                 return m_trigger_chance;
 218         }
 219         virtual bool getSimpleCatchUp()
 220         {
 221                 return m_simple_catch_up;
 222         }
 223         virtual void trigger(ServerEnvironment *env, v3s16 p, MapNode n,
 224                         u32 active_object_count, u32 active_object_count_wider);
 225 };
 226
 227 class LuaLBM : public LoadingBlockModifierDef
 228 {
 229 private:
 230         int m_id;
 231 public:
 232         LuaLBM(lua_State *L, int id,
 233                         const std::set<std::string> &trigger_contents,
 234                         const std::string &name,
 235                         bool run_at_every_load):
 236                 m_id(id)
 237         {
 238                 this->run_at_every_load = run_at_every_load;
 239                 this->trigger_contents = trigger_contents;
 240                 this->name = name;
 241         }
 242         virtual void trigger(ServerEnvironment *env, v3s16 p, MapNode n);
 243 };
 244
 245 struct ScriptCallbackState {
 246         ServerScripting *script;
 247         int callback_ref;
 248         int args_ref;
 249         unsigned int refcount;
 250         std::string origin;
 251 };
 252
 253 #endif /* L_ENV_H_ */