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.
20 #include "lua_api/l_env.h"
21 #include "lua_api/l_internal.h"
22 #include "lua_api/l_nodemeta.h"
23 #include "lua_api/l_nodetimer.h"
24 #include "lua_api/l_noise.h"
25 #include "lua_api/l_vmanip.h"
26 #include "common/c_converter.h"
27 #include "common/c_content.h"
28 #include "scripting_game.h"
29 #include "environment.h"
32 #include "daynightratio.h"
33 #include "util/pointedthing.h"
34 #include "content_sao.h"
36 #include "pathfinder.h"
38 #define GET_ENV_PTR ServerEnvironment* env = \
39 dynamic_cast<ServerEnvironment*>(getEnv(L)); \
40 if (env == NULL) return 0
42 ///////////////////////////////////////////////////////////////////////////////
45 void LuaABM::trigger(ServerEnvironment *env, v3s16 p, MapNode n,
46 u32 active_object_count, u32 active_object_count_wider)
48 GameScripting *scriptIface = env->getScriptIface();
49 scriptIface->realityCheck();
51 lua_State *L = scriptIface->getStack();
52 assert(lua_checkstack(L, 20));
53 StackUnroller stack_unroller(L);
55 lua_pushcfunction(L, script_error_handler);
56 int errorhandler = lua_gettop(L);
58 // Get registered_abms
59 lua_getglobal(L, "core");
60 lua_getfield(L, -1, "registered_abms");
61 luaL_checktype(L, -1, LUA_TTABLE);
62 lua_remove(L, -2); // Remove core
64 // Get registered_abms[m_id]
65 lua_pushnumber(L, m_id);
69 lua_remove(L, -2); // Remove registered_abms
72 luaL_checktype(L, -1, LUA_TTABLE);
73 lua_getfield(L, -1, "action");
74 luaL_checktype(L, -1, LUA_TFUNCTION);
75 lua_remove(L, -2); // Remove registered_abms[m_id]
77 pushnode(L, n, env->getGameDef()->ndef());
78 lua_pushnumber(L, active_object_count);
79 lua_pushnumber(L, active_object_count_wider);
80 if(lua_pcall(L, 4, 0, errorhandler))
82 lua_pop(L, 1); // Pop error handler
87 // set_node(pos, node)
88 // pos = {x=num, y=num, z=num}
89 int ModApiEnvMod::l_set_node(lua_State *L)
93 INodeDefManager *ndef = env->getGameDef()->ndef();
95 v3s16 pos = read_v3s16(L, 1);
96 MapNode n = readnode(L, 2, ndef);
98 bool succeeded = env->setNode(pos, n);
99 lua_pushboolean(L, succeeded);
103 int ModApiEnvMod::l_add_node(lua_State *L)
105 return l_set_node(L);
109 // pos = {x=num, y=num, z=num}
110 int ModApiEnvMod::l_remove_node(lua_State *L)
115 v3s16 pos = read_v3s16(L, 1);
117 bool succeeded = env->removeNode(pos);
118 lua_pushboolean(L, succeeded);
122 // swap_node(pos, node)
123 // pos = {x=num, y=num, z=num}
124 int ModApiEnvMod::l_swap_node(lua_State *L)
128 INodeDefManager *ndef = env->getGameDef()->ndef();
130 v3s16 pos = read_v3s16(L, 1);
131 MapNode n = readnode(L, 2, ndef);
133 bool succeeded = env->swapNode(pos, n);
134 lua_pushboolean(L, succeeded);
139 // pos = {x=num, y=num, z=num}
140 int ModApiEnvMod::l_get_node(lua_State *L)
145 v3s16 pos = read_v3s16(L, 1);
147 MapNode n = env->getMap().getNodeNoEx(pos);
149 pushnode(L, n, env->getGameDef()->ndef());
153 // get_node_or_nil(pos)
154 // pos = {x=num, y=num, z=num}
155 int ModApiEnvMod::l_get_node_or_nil(lua_State *L)
160 v3s16 pos = read_v3s16(L, 1);
163 MapNode n = env->getMap().getNodeNoEx(pos, &pos_ok);
166 pushnode(L, n, env->getGameDef()->ndef());
173 // get_node_light(pos, timeofday)
174 // pos = {x=num, y=num, z=num}
175 // timeofday: nil = current time, 0 = night, 0.5 = day
176 int ModApiEnvMod::l_get_node_light(lua_State *L)
181 v3s16 pos = read_v3s16(L, 1);
182 u32 time_of_day = env->getTimeOfDay();
183 if(lua_isnumber(L, 2))
184 time_of_day = 24000.0 * lua_tonumber(L, 2);
185 time_of_day %= 24000;
186 u32 dnr = time_to_daynight_ratio(time_of_day, true);
189 MapNode n = env->getMap().getNodeNoEx(pos, &is_position_ok);
190 if (is_position_ok) {
191 INodeDefManager *ndef = env->getGameDef()->ndef();
192 lua_pushinteger(L, n.getLightBlend(dnr, ndef));
199 // place_node(pos, node)
200 // pos = {x=num, y=num, z=num}
201 int ModApiEnvMod::l_place_node(lua_State *L)
205 ScriptApiItem *scriptIfaceItem = getScriptApi<ScriptApiItem>(L);
206 Server *server = getServer(L);
207 INodeDefManager *ndef = server->ndef();
208 IItemDefManager *idef = server->idef();
210 v3s16 pos = read_v3s16(L, 1);
211 MapNode n = readnode(L, 2, ndef);
213 // Don't attempt to load non-loaded area as of now
214 MapNode n_old = env->getMap().getNodeNoEx(pos);
215 if(n_old.getContent() == CONTENT_IGNORE){
216 lua_pushboolean(L, false);
219 // Create item to place
220 ItemStack item(ndef->get(n).name, 1, 0, "", idef);
221 // Make pointed position
222 PointedThing pointed;
223 pointed.type = POINTEDTHING_NODE;
224 pointed.node_abovesurface = pos;
225 pointed.node_undersurface = pos + v3s16(0,-1,0);
226 // Place it with a NULL placer (appears in Lua as a non-functional
228 bool success = scriptIfaceItem->item_OnPlace(item, NULL, pointed);
229 lua_pushboolean(L, success);
234 // pos = {x=num, y=num, z=num}
235 int ModApiEnvMod::l_dig_node(lua_State *L)
239 ScriptApiNode *scriptIfaceNode = getScriptApi<ScriptApiNode>(L);
241 v3s16 pos = read_v3s16(L, 1);
243 // Don't attempt to load non-loaded area as of now
244 MapNode n = env->getMap().getNodeNoEx(pos);
245 if(n.getContent() == CONTENT_IGNORE){
246 lua_pushboolean(L, false);
249 // Dig it out with a NULL digger (appears in Lua as a
250 // non-functional ObjectRef)
251 bool success = scriptIfaceNode->node_on_dig(pos, n, NULL);
252 lua_pushboolean(L, success);
257 // pos = {x=num, y=num, z=num}
258 int ModApiEnvMod::l_punch_node(lua_State *L)
262 ScriptApiNode *scriptIfaceNode = getScriptApi<ScriptApiNode>(L);
264 v3s16 pos = read_v3s16(L, 1);
266 // Don't attempt to load non-loaded area as of now
267 MapNode n = env->getMap().getNodeNoEx(pos);
268 if(n.getContent() == CONTENT_IGNORE){
269 lua_pushboolean(L, false);
272 // Punch it with a NULL puncher (appears in Lua as a non-functional
274 bool success = scriptIfaceNode->node_on_punch(pos, n, NULL, PointedThing());
275 lua_pushboolean(L, success);
279 // get_node_max_level(pos)
280 // pos = {x=num, y=num, z=num}
281 int ModApiEnvMod::l_get_node_max_level(lua_State *L)
285 v3s16 pos = read_v3s16(L, 1);
286 MapNode n = env->getMap().getNodeNoEx(pos);
287 lua_pushnumber(L, n.getMaxLevel(env->getGameDef()->ndef()));
291 // get_node_level(pos)
292 // pos = {x=num, y=num, z=num}
293 int ModApiEnvMod::l_get_node_level(lua_State *L)
297 v3s16 pos = read_v3s16(L, 1);
298 MapNode n = env->getMap().getNodeNoEx(pos);
299 lua_pushnumber(L, n.getLevel(env->getGameDef()->ndef()));
303 // set_node_level(pos, level)
304 // pos = {x=num, y=num, z=num}
306 int ModApiEnvMod::l_set_node_level(lua_State *L)
310 v3s16 pos = read_v3s16(L, 1);
312 if(lua_isnumber(L, 2))
313 level = lua_tonumber(L, 2);
314 MapNode n = env->getMap().getNodeNoEx(pos);
315 lua_pushnumber(L, n.setLevel(env->getGameDef()->ndef(), level));
316 env->setNode(pos, n);
320 // add_node_level(pos, level)
321 // pos = {x=num, y=num, z=num}
323 int ModApiEnvMod::l_add_node_level(lua_State *L)
327 v3s16 pos = read_v3s16(L, 1);
329 if(lua_isnumber(L, 2))
330 level = lua_tonumber(L, 2);
331 MapNode n = env->getMap().getNodeNoEx(pos);
332 lua_pushnumber(L, n.addLevel(env->getGameDef()->ndef(), level));
333 env->setNode(pos, n);
339 int ModApiEnvMod::l_get_meta(lua_State *L)
344 v3s16 p = read_v3s16(L, 1);
345 NodeMetaRef::create(L, p, env);
349 // get_node_timer(pos)
350 int ModApiEnvMod::l_get_node_timer(lua_State *L)
355 v3s16 p = read_v3s16(L, 1);
356 NodeTimerRef::create(L, p, env);
360 // add_entity(pos, entityname) -> ObjectRef or nil
361 // pos = {x=num, y=num, z=num}
362 int ModApiEnvMod::l_add_entity(lua_State *L)
367 v3f pos = checkFloatPos(L, 1);
369 const char *name = luaL_checkstring(L, 2);
371 ServerActiveObject *obj = new LuaEntitySAO(env, pos, name, "");
372 int objectid = env->addActiveObject(obj);
373 // If failed to add, return nothing (reads as nil)
377 getScriptApiBase(L)->objectrefGetOrCreate(L, obj);
381 // add_item(pos, itemstack or itemstring or table) -> ObjectRef or nil
382 // pos = {x=num, y=num, z=num}
383 int ModApiEnvMod::l_add_item(lua_State *L)
388 //v3f pos = checkFloatPos(L, 1);
390 ItemStack item = read_item(L, 2,getServer(L));
391 if(item.empty() || !item.isKnown(getServer(L)->idef()))
394 lua_pushcfunction(L, script_error_handler);
395 int errorhandler = lua_gettop(L);
397 // Use spawn_item to spawn a __builtin:item
398 lua_getglobal(L, "core");
399 lua_getfield(L, -1, "spawn_item");
400 lua_remove(L, -2); // Remove core
404 lua_pushstring(L, item.getItemString().c_str());
405 if(lua_pcall(L, 2, 1, errorhandler))
407 lua_remove(L, errorhandler); // Remove error handler
409 /*lua_pushvalue(L, 1);
410 lua_pushstring(L, "__builtin:item");
411 lua_pushstring(L, item.getItemString().c_str());
412 return l_add_entity(L);*/
414 ServerActiveObject *obj = createItemSAO(env, pos, item.getItemString());
415 int objectid = env->addActiveObject(obj);
416 // If failed to add, return nothing (reads as nil)
420 objectrefGetOrCreate(L, obj);
424 // get_player_by_name(name)
425 int ModApiEnvMod::l_get_player_by_name(lua_State *L)
430 const char *name = luaL_checkstring(L, 1);
431 Player *player = env->getPlayer(name);
436 PlayerSAO *sao = player->getPlayerSAO();
441 // Put player on stack
442 getScriptApiBase(L)->objectrefGetOrCreate(L, sao);
446 // get_objects_inside_radius(pos, radius)
447 int ModApiEnvMod::l_get_objects_inside_radius(lua_State *L)
452 v3f pos = checkFloatPos(L, 1);
453 float radius = luaL_checknumber(L, 2) * BS;
454 std::set<u16> ids = env->getObjectsInsideRadius(pos, radius);
455 ScriptApiBase *script = getScriptApiBase(L);
456 lua_createtable(L, ids.size(), 0);
457 std::set<u16>::const_iterator iter = ids.begin();
458 for(u32 i = 0; iter != ids.end(); iter++) {
459 ServerActiveObject *obj = env->getActiveObject(*iter);
460 // Insert object reference into table
461 script->objectrefGetOrCreate(L, obj);
462 lua_rawseti(L, -2, ++i);
467 // set_timeofday(val)
469 int ModApiEnvMod::l_set_timeofday(lua_State *L)
474 float timeofday_f = luaL_checknumber(L, 1);
475 assert(timeofday_f >= 0.0 && timeofday_f <= 1.0);
476 int timeofday_mh = (int)(timeofday_f * 24000.0);
477 // This should be set directly in the environment but currently
478 // such changes aren't immediately sent to the clients, so call
479 // the server instead.
480 //env->setTimeOfDay(timeofday_mh);
481 getServer(L)->setTimeOfDay(timeofday_mh);
485 // get_timeofday() -> 0...1
486 int ModApiEnvMod::l_get_timeofday(lua_State *L)
491 int timeofday_mh = env->getTimeOfDay();
492 float timeofday_f = (float)timeofday_mh / 24000.0;
493 lua_pushnumber(L, timeofday_f);
498 int ModApiEnvMod::l_get_gametime(lua_State *L)
502 int game_time = env->getGameTime();
503 lua_pushnumber(L, game_time);
508 // find_node_near(pos, radius, nodenames) -> pos or nil
509 // nodenames: eg. {"ignore", "group:tree"} or "default:dirt"
510 int ModApiEnvMod::l_find_node_near(lua_State *L)
514 INodeDefManager *ndef = getServer(L)->ndef();
515 v3s16 pos = read_v3s16(L, 1);
516 int radius = luaL_checkinteger(L, 2);
517 std::set<content_t> filter;
518 if(lua_istable(L, 3)){
521 while(lua_next(L, table) != 0){
522 // key at index -2 and value at index -1
523 luaL_checktype(L, -1, LUA_TSTRING);
524 ndef->getIds(lua_tostring(L, -1), filter);
525 // removes value, keeps key for next iteration
528 } else if(lua_isstring(L, 3)){
529 ndef->getIds(lua_tostring(L, 3), filter);
532 for(int d=1; d<=radius; d++){
533 std::list<v3s16> list;
534 getFacePositions(list, d);
535 for(std::list<v3s16>::iterator i = list.begin();
536 i != list.end(); ++i){
537 v3s16 p = pos + (*i);
538 content_t c = env->getMap().getNodeNoEx(p).getContent();
539 if(filter.count(c) != 0){
548 // find_nodes_in_area(minp, maxp, nodenames) -> list of positions
549 // nodenames: eg. {"ignore", "group:tree"} or "default:dirt"
550 int ModApiEnvMod::l_find_nodes_in_area(lua_State *L)
554 INodeDefManager *ndef = getServer(L)->ndef();
555 v3s16 minp = read_v3s16(L, 1);
556 v3s16 maxp = read_v3s16(L, 2);
557 std::set<content_t> filter;
558 if(lua_istable(L, 3)){
561 while(lua_next(L, table) != 0){
562 // key at index -2 and value at index -1
563 luaL_checktype(L, -1, LUA_TSTRING);
564 ndef->getIds(lua_tostring(L, -1), filter);
565 // removes value, keeps key for next iteration
568 } else if(lua_isstring(L, 3)){
569 ndef->getIds(lua_tostring(L, 3), filter);
574 for(s16 x = minp.X; x <= maxp.X; x++)
575 for(s16 y = minp.Y; y <= maxp.Y; y++)
576 for(s16 z = minp.Z; z <= maxp.Z; z++) {
578 content_t c = env->getMap().getNodeNoEx(p).getContent();
579 if(filter.count(c) != 0) {
581 lua_rawseti(L, -2, ++i);
587 // get_perlin(seeddiff, octaves, persistence, scale)
588 // returns world-specific PerlinNoise
589 int ModApiEnvMod::l_get_perlin(lua_State *L)
595 if (lua_istable(L, 1)) {
596 read_noiseparams(L, 1, ¶ms);
598 params.seed = luaL_checkint(L, 1);
599 params.octaves = luaL_checkint(L, 2);
600 params.persist = luaL_checknumber(L, 3);
601 params.spread = v3f(1, 1, 1) * luaL_checknumber(L, 4);
604 params.seed += (int)env->getServerMap().getSeed();
606 LuaPerlinNoise *n = new LuaPerlinNoise(¶ms);
607 *(void **)(lua_newuserdata(L, sizeof(void *))) = n;
608 luaL_getmetatable(L, "PerlinNoise");
609 lua_setmetatable(L, -2);
613 // get_perlin_map(noiseparams, size)
614 // returns world-specific PerlinNoiseMap
615 int ModApiEnvMod::l_get_perlin_map(lua_State *L)
620 if (!read_noiseparams(L, 1, &np))
622 v3s16 size = read_v3s16(L, 2);
624 int seed = (int)(env->getServerMap().getSeed());
625 LuaPerlinNoiseMap *n = new LuaPerlinNoiseMap(&np, seed, size);
626 *(void **)(lua_newuserdata(L, sizeof(void *))) = n;
627 luaL_getmetatable(L, "PerlinNoiseMap");
628 lua_setmetatable(L, -2);
633 // returns voxel manipulator
634 int ModApiEnvMod::l_get_voxel_manip(lua_State *L)
638 Map *map = &(env->getMap());
639 LuaVoxelManip *o = (lua_istable(L, 1) && lua_istable(L, 2)) ?
640 new LuaVoxelManip(map, read_v3s16(L, 1), read_v3s16(L, 2)) :
641 new LuaVoxelManip(map);
643 *(void **)(lua_newuserdata(L, sizeof(void *))) = o;
644 luaL_getmetatable(L, "VoxelManip");
645 lua_setmetatable(L, -2);
650 // clear all objects in the environment
651 int ModApiEnvMod::l_clear_objects(lua_State *L)
655 env->clearAllObjects();
659 // line_of_sight(pos1, pos2, stepsize) -> true/false, pos
660 int ModApiEnvMod::l_line_of_sight(lua_State *L) {
661 float stepsize = 1.0;
665 // read position 1 from lua
666 v3f pos1 = checkFloatPos(L, 1);
667 // read position 2 from lua
668 v3f pos2 = checkFloatPos(L, 2);
669 //read step size from lua
670 if (lua_isnumber(L, 3)) {
671 stepsize = lua_tonumber(L, 3);
675 bool success = env->line_of_sight(pos1, pos2, stepsize, &p);
676 lua_pushboolean(L, success);
684 // find_path(pos1, pos2, searchdistance,
685 // max_jump, max_drop, algorithm) -> table containing path
686 int ModApiEnvMod::l_find_path(lua_State *L)
690 v3s16 pos1 = read_v3s16(L, 1);
691 v3s16 pos2 = read_v3s16(L, 2);
692 unsigned int searchdistance = luaL_checkint(L, 3);
693 unsigned int max_jump = luaL_checkint(L, 4);
694 unsigned int max_drop = luaL_checkint(L, 5);
695 algorithm algo = A_PLAIN_NP;
696 if (!lua_isnil(L, 6)) {
697 std::string algorithm = luaL_checkstring(L,6);
699 if (algorithm == "A*")
702 if (algorithm == "Dijkstra")
706 std::vector<v3s16> path =
707 get_Path(env,pos1,pos2,searchdistance,max_jump,max_drop,algo);
712 int top = lua_gettop(L);
713 unsigned int index = 1;
714 for (std::vector<v3s16>::iterator i = path.begin(); i != path.end();i++)
716 lua_pushnumber(L,index);
718 lua_settable(L, top);
727 // spawn_tree(pos, treedef)
728 int ModApiEnvMod::l_spawn_tree(lua_State *L)
732 v3s16 p0 = read_v3s16(L, 1);
734 treegen::TreeDef tree_def;
735 std::string trunk,leaves,fruit;
736 INodeDefManager *ndef = env->getGameDef()->ndef();
738 if(lua_istable(L, 2))
740 getstringfield(L, 2, "axiom", tree_def.initial_axiom);
741 getstringfield(L, 2, "rules_a", tree_def.rules_a);
742 getstringfield(L, 2, "rules_b", tree_def.rules_b);
743 getstringfield(L, 2, "rules_c", tree_def.rules_c);
744 getstringfield(L, 2, "rules_d", tree_def.rules_d);
745 getstringfield(L, 2, "trunk", trunk);
746 tree_def.trunknode=ndef->getId(trunk);
747 getstringfield(L, 2, "leaves", leaves);
748 tree_def.leavesnode=ndef->getId(leaves);
749 tree_def.leaves2_chance=0;
750 getstringfield(L, 2, "leaves2", leaves);
753 tree_def.leaves2node=ndef->getId(leaves);
754 getintfield(L, 2, "leaves2_chance", tree_def.leaves2_chance);
756 getintfield(L, 2, "angle", tree_def.angle);
757 getintfield(L, 2, "iterations", tree_def.iterations);
758 if (!getintfield(L, 2, "random_level", tree_def.iterations_random_level))
759 tree_def.iterations_random_level = 0;
760 getstringfield(L, 2, "trunk_type", tree_def.trunk_type);
761 getboolfield(L, 2, "thin_branches", tree_def.thin_branches);
762 tree_def.fruit_chance=0;
763 getstringfield(L, 2, "fruit", fruit);
766 tree_def.fruitnode=ndef->getId(fruit);
767 getintfield(L, 2, "fruit_chance",tree_def.fruit_chance);
769 tree_def.explicit_seed = getintfield(L, 2, "seed", tree_def.seed);
775 if ((e = treegen::spawn_ltree (env, p0, ndef, tree_def)) != treegen::SUCCESS) {
776 if (e == treegen::UNBALANCED_BRACKETS) {
777 luaL_error(L, "spawn_tree(): closing ']' has no matching opening bracket");
779 luaL_error(L, "spawn_tree(): unknown error");
786 // transforming_liquid_add(pos)
787 int ModApiEnvMod::l_transforming_liquid_add(lua_State *L)
791 v3s16 p0 = read_v3s16(L, 1);
792 env->getMap().transforming_liquid_add(p0);
796 // forceload_block(blockpos)
797 // blockpos = {x=num, y=num, z=num}
798 int ModApiEnvMod::l_forceload_block(lua_State *L)
802 v3s16 blockpos = read_v3s16(L, 1);
803 env->getForceloadedBlocks()->insert(blockpos);
807 // forceload_free_block(blockpos)
808 // blockpos = {x=num, y=num, z=num}
809 int ModApiEnvMod::l_forceload_free_block(lua_State *L)
813 v3s16 blockpos = read_v3s16(L, 1);
814 env->getForceloadedBlocks()->erase(blockpos);
819 int ModApiEnvMod::l_get_us_time(lua_State *L)
821 lua_pushnumber(L, porting::getTimeUs());
825 void ModApiEnvMod::Initialize(lua_State *L, int top)
831 API_FCT(remove_node);
833 API_FCT(get_node_or_nil);
834 API_FCT(get_node_light);
838 API_FCT(get_node_max_level);
839 API_FCT(get_node_level);
840 API_FCT(set_node_level);
841 API_FCT(add_node_level);
844 API_FCT(get_node_timer);
845 API_FCT(get_player_by_name);
846 API_FCT(get_objects_inside_radius);
847 API_FCT(set_timeofday);
848 API_FCT(get_timeofday);
849 API_FCT(get_gametime);
850 API_FCT(find_node_near);
851 API_FCT(find_nodes_in_area);
853 API_FCT(get_perlin_map);
854 API_FCT(get_voxel_manip);
855 API_FCT(clear_objects);
858 API_FCT(line_of_sight);
859 API_FCT(transforming_liquid_add);
860 API_FCT(forceload_block);
861 API_FCT(forceload_free_block);
862 API_FCT(get_us_time);