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 // 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);
64 // place_node(pos, node)
65 // pos = {x=num, y=num, z=num}
66 static int l_place_node(lua_State *L);
69 // pos = {x=num, y=num, z=num}
70 static int l_dig_node(lua_State *L);
73 // pos = {x=num, y=num, z=num}
74 static int l_punch_node(lua_State *L);
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);
80 // get_node_level(pos)
81 // pos = {x=num, y=num, z=num}
82 static int l_get_node_level(lua_State *L);
84 // set_node_level(pos)
85 // pos = {x=num, y=num, z=num}
86 static int l_set_node_level(lua_State *L);
88 // add_node_level(pos)
89 // pos = {x=num, y=num, z=num}
90 static int l_add_node_level(lua_State *L);
92 // find_nodes_with_meta(pos1, pos2)
93 static int l_find_nodes_with_meta(lua_State *L);
96 static int l_get_meta(lua_State *L);
98 // get_node_timer(pos)
99 static int l_get_node_timer(lua_State *L);
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);
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);
109 // get_connected_players()
110 static int l_get_connected_players(lua_State *L);
112 // get_player_by_name(name)
113 static int l_get_player_by_name(lua_State *L);
115 // get_objects_inside_radius(pos, radius)
116 static int l_get_objects_inside_radius(lua_State *L);
118 // get_objects_in_area(pos, minp, maxp)
119 static int l_get_objects_in_area(lua_State *L);
121 // set_timeofday(val)
123 static int l_set_timeofday(lua_State *L);
125 // get_timeofday() -> 0...1
126 static int l_get_timeofday(lua_State *L);
129 static int l_get_gametime(lua_State *L);
131 // get_day_count() -> int
132 static int l_get_day_count(lua_State *L);
134 // find_node_near(pos, radius, nodenames, search_center) -> pos or nil
135 // nodenames: eg. {"ignore", "group:tree"} or "default:dirt"
136 static int l_find_node_near(lua_State *L);
138 // find_nodes_near(pos, radius, nodenames, search_center) -> list of positions
139 // nodenames: eg. {"ignore", "group:tree"} or "default:dirt"
140 static int l_find_nodes_near(lua_State *L);
142 // find_nodes_near_under_air(pos, radius, nodenames, search_center) -> list of positions
143 // nodenames: eg. {"ignore", "group:tree"} or "default:dirt"
144 static int l_find_nodes_near_under_air(lua_State *L);
146 // find_nodes_near_under_air(pos, radius, nodenames, search_center) -> list of positions
147 // nodenames: eg. {"ignore", "group:tree"} or "default:dirt"
148 static int l_find_nodes_near_under_air_except(lua_State *L);
150 // find_nodes_in_area(minp, maxp, nodenames) -> list of positions
151 // nodenames: eg. {"ignore", "group:tree"} or "default:dirt"
152 static int l_find_nodes_in_area(lua_State *L);
154 // find_surface_nodes_in_area(minp, maxp, nodenames) -> list of positions
155 // nodenames: eg. {"ignore", "group:tree"} or "default:dirt"
156 static int l_find_nodes_in_area_under_air(lua_State *L);
158 // fix_light(p1, p2) -> true/false
159 static int l_fix_light(lua_State *L);
162 static int l_load_area(lua_State *L);
164 // emerge_area(p1, p2)
165 static int l_emerge_area(lua_State *L);
167 // delete_area(p1, p2) -> true/false
168 static int l_delete_area(lua_State *L);
170 // get_perlin(seeddiff, octaves, persistence, scale)
171 // returns world-specific PerlinNoise
172 static int l_get_perlin(lua_State *L);
174 // get_perlin_map(noiseparams, size)
175 // returns world-specific PerlinNoiseMap
176 static int l_get_perlin_map(lua_State *L);
179 // returns world-specific voxel manipulator
180 static int l_get_voxel_manip(lua_State *L);
183 // clear all objects in the environment
184 static int l_clear_objects(lua_State *L);
186 // spawn_tree(pos, treedef)
187 static int l_spawn_tree(lua_State *L);
189 // line_of_sight(pos1, pos2) -> true/false
190 static int l_line_of_sight(lua_State *L);
192 // raycast(pos1, pos2, objects, liquids) -> Raycast
193 static int l_raycast(lua_State *L);
195 // find_path(pos1, pos2, searchdistance,
196 // max_jump, max_drop, algorithm) -> table containing path
197 static int l_find_path(lua_State *L);
199 // transforming_liquid_add(pos)
200 static int l_transforming_liquid_add(lua_State *L);
202 // forceload_block(blockpos)
203 // forceloads a block
204 static int l_forceload_block(lua_State *L);
206 // forceload_free_block(blockpos)
207 // stops forceloading a position
208 static int l_forceload_free_block(lua_State *L);
210 // compare_block_status(nodepos)
211 static int l_compare_block_status(lua_State *L);
213 // Get a string translated server side
214 static int l_get_translated_string(lua_State * L);
218 static void collectNodeIds(lua_State *L, int idx,
219 const NodeDefManager *ndef, std::vector<content_t> &filter);
222 static void Initialize(lua_State *L, int top);
223 static void InitializeClient(lua_State *L, int top);
225 static const EnumString es_ClearObjectsMode[];
226 static const EnumString es_BlockStatusType[];
229 class LuaABM : public ActiveBlockModifier {
233 std::vector<std::string> m_trigger_contents;
234 std::vector<std::string> m_required_neighbors;
235 float m_trigger_interval;
236 u32 m_trigger_chance;
237 bool m_simple_catch_up;
241 LuaABM(lua_State *L, int id,
242 const std::vector<std::string> &trigger_contents,
243 const std::vector<std::string> &required_neighbors,
244 float trigger_interval, u32 trigger_chance, bool simple_catch_up, s16 min_y, s16 max_y):
246 m_trigger_contents(trigger_contents),
247 m_required_neighbors(required_neighbors),
248 m_trigger_interval(trigger_interval),
249 m_trigger_chance(trigger_chance),
250 m_simple_catch_up(simple_catch_up),
255 virtual const std::vector<std::string> &getTriggerContents() const
257 return m_trigger_contents;
259 virtual const std::vector<std::string> &getRequiredNeighbors() const
261 return m_required_neighbors;
263 virtual float getTriggerInterval()
265 return m_trigger_interval;
267 virtual u32 getTriggerChance()
269 return m_trigger_chance;
271 virtual bool getSimpleCatchUp()
273 return m_simple_catch_up;
275 virtual s16 getMinY()
279 virtual s16 getMaxY()
283 virtual void trigger(ServerEnvironment *env, v3s16 p, MapNode n,
284 u32 active_object_count, u32 active_object_count_wider);
287 class LuaLBM : public LoadingBlockModifierDef
292 LuaLBM(lua_State *L, int id,
293 const std::set<std::string> &trigger_contents,
294 const std::string &name,
295 bool run_at_every_load):
298 this->run_at_every_load = run_at_every_load;
299 this->trigger_contents = trigger_contents;
302 virtual void trigger(ServerEnvironment *env, v3s16 p, MapNode n);
305 //! Lua wrapper for RaycastState objects
306 class LuaRaycast : public ModApiBase
309 static const char className[];
310 static const luaL_Reg methods[];
314 // Exported functions
317 static int gc_object(lua_State *L);
320 * Raycast:next() -> pointed_thing
321 * Returns the next pointed thing on the ray.
323 static int l_next(lua_State *L);
325 //! Constructor with the same arguments as RaycastState.
327 const core::line3d<f32> &shootline,
328 bool objects_pointable,
329 bool liquids_pointable) :
330 state(shootline, objects_pointable, liquids_pointable)
333 //! Creates a LuaRaycast and leaves it on top of the stack.
334 static int create_object(lua_State *L);
337 * Returns the Raycast from the stack or throws an error.
338 * @param narg location of the RaycastState in the stack
340 static LuaRaycast *checkobject(lua_State *L, int narg);
342 //! Registers Raycast as a Lua userdata type.
343 static void Register(lua_State *L);
346 struct ScriptCallbackState {
347 ServerScripting *script;
350 unsigned int refcount;