3 Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
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.
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.
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.
22 #include "lua_api/l_base.h"
23 #include "serverenvironment.h"
26 class ModApiEnvMod : public ModApiBase {
28 // set_node(pos, node)
29 // pos = {x=num, y=num, z=num}
30 static int l_set_node(lua_State *L);
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);
36 static int l_add_node(lua_State *L);
39 // pos = {x=num, y=num, z=num}
40 static int l_remove_node(lua_State *L);
42 // swap_node(pos, node)
43 // pos = {x=num, y=num, z=num}
44 static int l_swap_node(lua_State *L);
47 // pos = {x=num, y=num, z=num}
48 static int l_get_node(lua_State *L);
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);
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);
59 // place_node(pos, node)
60 // pos = {x=num, y=num, z=num}
61 static int l_place_node(lua_State *L);
64 // pos = {x=num, y=num, z=num}
65 static int l_dig_node(lua_State *L);
68 // pos = {x=num, y=num, z=num}
69 static int l_punch_node(lua_State *L);
71 // get_node_max_level(pos)
72 // pos = {x=num, y=num, z=num}
73 static int l_get_node_max_level(lua_State *L);
75 // get_node_level(pos)
76 // pos = {x=num, y=num, z=num}
77 static int l_get_node_level(lua_State *L);
79 // set_node_level(pos)
80 // pos = {x=num, y=num, z=num}
81 static int l_set_node_level(lua_State *L);
83 // add_node_level(pos)
84 // pos = {x=num, y=num, z=num}
85 static int l_add_node_level(lua_State *L);
87 // find_nodes_with_meta(pos1, pos2)
88 static int l_find_nodes_with_meta(lua_State *L);
91 static int l_get_meta(lua_State *L);
93 // get_node_timer(pos)
94 static int l_get_node_timer(lua_State *L);
96 // add_entity(pos, entityname) -> ObjectRef or nil
97 // pos = {x=num, y=num, z=num}
98 static int l_add_entity(lua_State *L);
100 // add_item(pos, itemstack or itemstring or table) -> ObjectRef or nil
101 // pos = {x=num, y=num, z=num}
102 static int l_add_item(lua_State *L);
104 // get_connected_players()
105 static int l_get_connected_players(lua_State *L);
107 // get_player_by_name(name)
108 static int l_get_player_by_name(lua_State *L);
110 // get_objects_inside_radius(pos, radius)
111 static int l_get_objects_inside_radius(lua_State *L);
113 // set_timeofday(val)
115 static int l_set_timeofday(lua_State *L);
117 // get_timeofday() -> 0...1
118 static int l_get_timeofday(lua_State *L);
121 static int l_get_gametime(lua_State *L);
123 // get_day_count() -> int
124 static int l_get_day_count(lua_State *L);
126 // find_node_near(pos, radius, nodenames, search_center) -> pos or nil
127 // nodenames: eg. {"ignore", "group:tree"} or "default:dirt"
128 static int l_find_node_near(lua_State *L);
130 // find_nodes_in_area(minp, maxp, nodenames) -> list of positions
131 // nodenames: eg. {"ignore", "group:tree"} or "default:dirt"
132 static int l_find_nodes_in_area(lua_State *L);
134 // find_surface_nodes_in_area(minp, maxp, nodenames) -> list of positions
135 // nodenames: eg. {"ignore", "group:tree"} or "default:dirt"
136 static int l_find_nodes_in_area_under_air(lua_State *L);
138 // fix_light(p1, p2) -> true/false
139 static int l_fix_light(lua_State *L);
142 static int l_load_area(lua_State *L);
144 // emerge_area(p1, p2)
145 static int l_emerge_area(lua_State *L);
147 // delete_area(p1, p2) -> true/false
148 static int l_delete_area(lua_State *L);
150 // get_perlin(seeddiff, octaves, persistence, scale)
151 // returns world-specific PerlinNoise
152 static int l_get_perlin(lua_State *L);
154 // get_perlin_map(noiseparams, size)
155 // returns world-specific PerlinNoiseMap
156 static int l_get_perlin_map(lua_State *L);
159 // returns world-specific voxel manipulator
160 static int l_get_voxel_manip(lua_State *L);
163 // clear all objects in the environment
164 static int l_clear_objects(lua_State *L);
166 // spawn_tree(pos, treedef)
167 static int l_spawn_tree(lua_State *L);
169 // line_of_sight(pos1, pos2) -> true/false
170 static int l_line_of_sight(lua_State *L);
172 // raycast(pos1, pos2, objects, liquids) -> Raycast
173 static int l_raycast(lua_State *L);
175 // find_path(pos1, pos2, searchdistance,
176 // max_jump, max_drop, algorithm) -> table containing path
177 static int l_find_path(lua_State *L);
179 // transforming_liquid_add(pos)
180 static int l_transforming_liquid_add(lua_State *L);
182 // forceload_block(blockpos)
183 // forceloads a block
184 static int l_forceload_block(lua_State *L);
186 // forceload_free_block(blockpos)
187 // stops forceloading a position
188 static int l_forceload_free_block(lua_State *L);
190 // Get a string translated server side
191 static int l_get_translated_string(lua_State * L);
194 static void Initialize(lua_State *L, int top);
195 static void InitializeClient(lua_State *L, int top);
197 static struct EnumString es_ClearObjectsMode[];
200 class LuaABM : public ActiveBlockModifier {
204 std::vector<std::string> m_trigger_contents;
205 std::vector<std::string> m_required_neighbors;
206 float m_trigger_interval;
207 u32 m_trigger_chance;
208 bool m_simple_catch_up;
210 LuaABM(lua_State *L, int id,
211 const std::vector<std::string> &trigger_contents,
212 const std::vector<std::string> &required_neighbors,
213 float trigger_interval, u32 trigger_chance, bool simple_catch_up):
215 m_trigger_contents(trigger_contents),
216 m_required_neighbors(required_neighbors),
217 m_trigger_interval(trigger_interval),
218 m_trigger_chance(trigger_chance),
219 m_simple_catch_up(simple_catch_up)
222 virtual const std::vector<std::string> &getTriggerContents() const
224 return m_trigger_contents;
226 virtual const std::vector<std::string> &getRequiredNeighbors() const
228 return m_required_neighbors;
230 virtual float getTriggerInterval()
232 return m_trigger_interval;
234 virtual u32 getTriggerChance()
236 return m_trigger_chance;
238 virtual bool getSimpleCatchUp()
240 return m_simple_catch_up;
242 virtual void trigger(ServerEnvironment *env, v3s16 p, MapNode n,
243 u32 active_object_count, u32 active_object_count_wider);
246 class LuaLBM : public LoadingBlockModifierDef
251 LuaLBM(lua_State *L, int id,
252 const std::set<std::string> &trigger_contents,
253 const std::string &name,
254 bool run_at_every_load):
257 this->run_at_every_load = run_at_every_load;
258 this->trigger_contents = trigger_contents;
261 virtual void trigger(ServerEnvironment *env, v3s16 p, MapNode n);
264 //! Lua wrapper for RaycastState objects
265 class LuaRaycast : public ModApiBase
268 static const char className[];
269 static const luaL_Reg methods[];
273 // Exported functions
276 static int gc_object(lua_State *L);
279 * Raycast:next() -> pointed_thing
280 * Returns the next pointed thing on the ray.
282 static int l_next(lua_State *L);
284 //! Constructor with the same arguments as RaycastState.
286 const core::line3d<f32> &shootline,
287 bool objects_pointable,
288 bool liquids_pointable) :
289 state(shootline, objects_pointable, liquids_pointable)
292 //! Creates a LuaRaycast and leaves it on top of the stack.
293 static int create_object(lua_State *L);
296 * Returns the Raycast from the stack or throws an error.
297 * @param narg location of the RaycastState in the stack
299 static LuaRaycast *checkobject(lua_State *L, int narg);
301 //! Registers Raycast as a Lua userdata type.
302 static void Register(lua_State *L);
305 struct ScriptCallbackState {
306 ServerScripting *script;
309 unsigned int refcount;