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"
39 #define GET_ENV_PTR ServerEnvironment* env = \
40 dynamic_cast<ServerEnvironment*>(getEnv(L)); \
41 if( env == NULL) return 0
43 ///////////////////////////////////////////////////////////////////////////////
46 void LuaABM::trigger(ServerEnvironment *env, v3s16 p, MapNode n,
47 u32 active_object_count, u32 active_object_count_wider)
49 GameScripting *scriptIface = env->getScriptIface();
50 scriptIface->realityCheck();
52 lua_State *L = scriptIface->getStack();
53 assert(lua_checkstack(L, 20));
54 StackUnroller stack_unroller(L);
56 lua_pushcfunction(L, script_error_handler);
57 int errorhandler = lua_gettop(L);
59 // Get registered_abms
60 lua_getglobal(L, "core");
61 lua_getfield(L, -1, "registered_abms");
62 luaL_checktype(L, -1, LUA_TTABLE);
63 lua_remove(L, -2); // Remove core
65 // Get registered_abms[m_id]
66 lua_pushnumber(L, m_id);
70 lua_remove(L, -2); // Remove registered_abms
73 luaL_checktype(L, -1, LUA_TTABLE);
74 lua_getfield(L, -1, "action");
75 luaL_checktype(L, -1, LUA_TFUNCTION);
76 lua_remove(L, -2); // Remove registered_abms[m_id]
78 pushnode(L, n, env->getGameDef()->ndef());
79 lua_pushnumber(L, active_object_count);
80 lua_pushnumber(L, active_object_count_wider);
81 if(lua_pcall(L, 4, 0, errorhandler))
83 lua_pop(L, 1); // Pop error handler
88 // set_node(pos, node)
89 // pos = {x=num, y=num, z=num}
90 int ModApiEnvMod::l_set_node(lua_State *L)
94 INodeDefManager *ndef = env->getGameDef()->ndef();
96 v3s16 pos = read_v3s16(L, 1);
97 MapNode n = readnode(L, 2, ndef);
99 bool succeeded = env->setNode(pos, n);
100 lua_pushboolean(L, succeeded);
104 int ModApiEnvMod::l_add_node(lua_State *L)
106 return l_set_node(L);
110 // pos = {x=num, y=num, z=num}
111 int ModApiEnvMod::l_remove_node(lua_State *L)
116 v3s16 pos = read_v3s16(L, 1);
118 bool succeeded = env->removeNode(pos);
119 lua_pushboolean(L, succeeded);
123 // swap_node(pos, node)
124 // pos = {x=num, y=num, z=num}
125 int ModApiEnvMod::l_swap_node(lua_State *L)
129 INodeDefManager *ndef = env->getGameDef()->ndef();
131 v3s16 pos = read_v3s16(L, 1);
132 MapNode n = readnode(L, 2, ndef);
134 bool succeeded = env->swapNode(pos, n);
135 lua_pushboolean(L, succeeded);
140 // pos = {x=num, y=num, z=num}
141 int ModApiEnvMod::l_get_node(lua_State *L)
146 v3s16 pos = read_v3s16(L, 1);
148 MapNode n = env->getMap().getNodeNoEx(pos);
150 pushnode(L, n, env->getGameDef()->ndef());
154 // get_node_or_nil(pos)
155 // pos = {x=num, y=num, z=num}
156 int ModApiEnvMod::l_get_node_or_nil(lua_State *L)
161 v3s16 pos = read_v3s16(L, 1);
164 MapNode n = env->getMap().getNode(pos);
166 pushnode(L, n, env->getGameDef()->ndef());
168 } catch(InvalidPositionException &e)
175 // get_node_light(pos, timeofday)
176 // pos = {x=num, y=num, z=num}
177 // timeofday: nil = current time, 0 = night, 0.5 = day
178 int ModApiEnvMod::l_get_node_light(lua_State *L)
183 v3s16 pos = read_v3s16(L, 1);
184 u32 time_of_day = env->getTimeOfDay();
185 if(lua_isnumber(L, 2))
186 time_of_day = 24000.0 * lua_tonumber(L, 2);
187 time_of_day %= 24000;
188 u32 dnr = time_to_daynight_ratio(time_of_day, true);
190 MapNode n = env->getMap().getNode(pos);
191 INodeDefManager *ndef = env->getGameDef()->ndef();
192 lua_pushinteger(L, n.getLightBlend(dnr, ndef));
194 } catch(InvalidPositionException &e)
201 // place_node(pos, node)
202 // pos = {x=num, y=num, z=num}
203 int ModApiEnvMod::l_place_node(lua_State *L)
207 ScriptApiItem *scriptIfaceItem = getScriptApi<ScriptApiItem>(L);
208 Server *server = getServer(L);
209 INodeDefManager *ndef = server->ndef();
210 IItemDefManager *idef = server->idef();
212 v3s16 pos = read_v3s16(L, 1);
213 MapNode n = readnode(L, 2, ndef);
215 // Don't attempt to load non-loaded area as of now
216 MapNode n_old = env->getMap().getNodeNoEx(pos);
217 if(n_old.getContent() == CONTENT_IGNORE){
218 lua_pushboolean(L, false);
221 // Create item to place
222 ItemStack item(ndef->get(n).name, 1, 0, "", idef);
223 // Make pointed position
224 PointedThing pointed;
225 pointed.type = POINTEDTHING_NODE;
226 pointed.node_abovesurface = pos;
227 pointed.node_undersurface = pos + v3s16(0,-1,0);
228 // Place it with a NULL placer (appears in Lua as a non-functional
230 bool success = scriptIfaceItem->item_OnPlace(item, NULL, pointed);
231 lua_pushboolean(L, success);
236 // pos = {x=num, y=num, z=num}
237 int ModApiEnvMod::l_dig_node(lua_State *L)
241 ScriptApiNode *scriptIfaceNode = getScriptApi<ScriptApiNode>(L);
243 v3s16 pos = read_v3s16(L, 1);
245 // Don't attempt to load non-loaded area as of now
246 MapNode n = env->getMap().getNodeNoEx(pos);
247 if(n.getContent() == CONTENT_IGNORE){
248 lua_pushboolean(L, false);
251 // Dig it out with a NULL digger (appears in Lua as a
252 // non-functional ObjectRef)
253 bool success = scriptIfaceNode->node_on_dig(pos, n, NULL);
254 lua_pushboolean(L, success);
259 // pos = {x=num, y=num, z=num}
260 int ModApiEnvMod::l_punch_node(lua_State *L)
264 ScriptApiNode *scriptIfaceNode = getScriptApi<ScriptApiNode>(L);
266 v3s16 pos = read_v3s16(L, 1);
268 // Don't attempt to load non-loaded area as of now
269 MapNode n = env->getMap().getNodeNoEx(pos);
270 if(n.getContent() == CONTENT_IGNORE){
271 lua_pushboolean(L, false);
274 // Punch it with a NULL puncher (appears in Lua as a non-functional
276 bool success = scriptIfaceNode->node_on_punch(pos, n, NULL, PointedThing());
277 lua_pushboolean(L, success);
281 // get_node_max_level(pos)
282 // pos = {x=num, y=num, z=num}
283 int ModApiEnvMod::l_get_node_max_level(lua_State *L)
287 v3s16 pos = read_v3s16(L, 1);
288 MapNode n = env->getMap().getNodeNoEx(pos);
289 lua_pushnumber(L, n.getMaxLevel(env->getGameDef()->ndef()));
293 // get_node_level(pos)
294 // pos = {x=num, y=num, z=num}
295 int ModApiEnvMod::l_get_node_level(lua_State *L)
299 v3s16 pos = read_v3s16(L, 1);
300 MapNode n = env->getMap().getNodeNoEx(pos);
301 lua_pushnumber(L, n.getLevel(env->getGameDef()->ndef()));
305 // set_node_level(pos, level)
306 // pos = {x=num, y=num, z=num}
308 int ModApiEnvMod::l_set_node_level(lua_State *L)
312 v3s16 pos = read_v3s16(L, 1);
314 if(lua_isnumber(L, 2))
315 level = lua_tonumber(L, 2);
316 MapNode n = env->getMap().getNodeNoEx(pos);
317 lua_pushnumber(L, n.setLevel(env->getGameDef()->ndef(), level));
318 env->setNode(pos, n);
322 // add_node_level(pos, level)
323 // pos = {x=num, y=num, z=num}
325 int ModApiEnvMod::l_add_node_level(lua_State *L)
329 v3s16 pos = read_v3s16(L, 1);
331 if(lua_isnumber(L, 2))
332 level = lua_tonumber(L, 2);
333 MapNode n = env->getMap().getNodeNoEx(pos);
334 lua_pushnumber(L, n.addLevel(env->getGameDef()->ndef(), level));
335 env->setNode(pos, n);
341 int ModApiEnvMod::l_get_meta(lua_State *L)
346 v3s16 p = read_v3s16(L, 1);
347 NodeMetaRef::create(L, p, env);
351 // get_node_timer(pos)
352 int ModApiEnvMod::l_get_node_timer(lua_State *L)
357 v3s16 p = read_v3s16(L, 1);
358 NodeTimerRef::create(L, p, env);
362 // add_entity(pos, entityname) -> ObjectRef or nil
363 // pos = {x=num, y=num, z=num}
364 int ModApiEnvMod::l_add_entity(lua_State *L)
369 v3f pos = checkFloatPos(L, 1);
371 const char *name = luaL_checkstring(L, 2);
373 ServerActiveObject *obj = new LuaEntitySAO(env, pos, name, "");
374 int objectid = env->addActiveObject(obj);
375 // If failed to add, return nothing (reads as nil)
379 getScriptApiBase(L)->objectrefGetOrCreate(obj);
383 // add_item(pos, itemstack or itemstring or table) -> ObjectRef or nil
384 // pos = {x=num, y=num, z=num}
385 int ModApiEnvMod::l_add_item(lua_State *L)
390 //v3f pos = checkFloatPos(L, 1);
392 ItemStack item = read_item(L, 2,getServer(L));
393 if(item.empty() || !item.isKnown(getServer(L)->idef()))
396 lua_pushcfunction(L, script_error_handler);
397 int errorhandler = lua_gettop(L);
399 // Use spawn_item to spawn a __builtin:item
400 lua_getglobal(L, "core");
401 lua_getfield(L, -1, "spawn_item");
402 lua_remove(L, -2); // Remove core
406 lua_pushstring(L, item.getItemString().c_str());
407 if(lua_pcall(L, 2, 1, errorhandler))
409 lua_remove(L, errorhandler); // Remove error handler
411 /*lua_pushvalue(L, 1);
412 lua_pushstring(L, "__builtin:item");
413 lua_pushstring(L, item.getItemString().c_str());
414 return l_add_entity(L);*/
416 ServerActiveObject *obj = createItemSAO(env, pos, item.getItemString());
417 int objectid = env->addActiveObject(obj);
418 // If failed to add, return nothing (reads as nil)
422 objectrefGetOrCreate(L, obj);
426 // get_player_by_name(name)
427 int ModApiEnvMod::l_get_player_by_name(lua_State *L)
432 const char *name = luaL_checkstring(L, 1);
433 Player *player = env->getPlayer(name);
438 PlayerSAO *sao = player->getPlayerSAO();
443 // Put player on stack
444 getScriptApiBase(L)->objectrefGetOrCreate(sao);
448 // get_objects_inside_radius(pos, radius)
449 int ModApiEnvMod::l_get_objects_inside_radius(lua_State *L)
454 v3f pos = checkFloatPos(L, 1);
455 float radius = luaL_checknumber(L, 2) * BS;
456 std::set<u16> ids = env->getObjectsInsideRadius(pos, radius);
457 ScriptApiBase *script = getScriptApiBase(L);
458 lua_createtable(L, ids.size(), 0);
459 std::set<u16>::const_iterator iter = ids.begin();
460 for(u32 i = 0; iter != ids.end(); iter++) {
461 ServerActiveObject *obj = env->getActiveObject(*iter);
462 // Insert object reference into table
463 script->objectrefGetOrCreate(obj);
464 lua_rawseti(L, -2, ++i);
469 // set_timeofday(val)
471 int ModApiEnvMod::l_set_timeofday(lua_State *L)
476 float timeofday_f = luaL_checknumber(L, 1);
477 assert(timeofday_f >= 0.0 && timeofday_f <= 1.0);
478 int timeofday_mh = (int)(timeofday_f * 24000.0);
479 // This should be set directly in the environment but currently
480 // such changes aren't immediately sent to the clients, so call
481 // the server instead.
482 //env->setTimeOfDay(timeofday_mh);
483 getServer(L)->setTimeOfDay(timeofday_mh);
487 // get_timeofday() -> 0...1
488 int ModApiEnvMod::l_get_timeofday(lua_State *L)
493 int timeofday_mh = env->getTimeOfDay();
494 float timeofday_f = (float)timeofday_mh / 24000.0;
495 lua_pushnumber(L, timeofday_f);
500 int ModApiEnvMod::l_get_gametime(lua_State *L)
504 int game_time = env->getGameTime();
505 lua_pushnumber(L, game_time);
510 // find_node_near(pos, radius, nodenames) -> pos or nil
511 // nodenames: eg. {"ignore", "group:tree"} or "default:dirt"
512 int ModApiEnvMod::l_find_node_near(lua_State *L)
516 INodeDefManager *ndef = getServer(L)->ndef();
517 v3s16 pos = read_v3s16(L, 1);
518 int radius = luaL_checkinteger(L, 2);
519 std::set<content_t> filter;
520 if(lua_istable(L, 3)){
523 while(lua_next(L, table) != 0){
524 // key at index -2 and value at index -1
525 luaL_checktype(L, -1, LUA_TSTRING);
526 ndef->getIds(lua_tostring(L, -1), filter);
527 // removes value, keeps key for next iteration
530 } else if(lua_isstring(L, 3)){
531 ndef->getIds(lua_tostring(L, 3), filter);
534 for(int d=1; d<=radius; d++){
535 std::list<v3s16> list;
536 getFacePositions(list, d);
537 for(std::list<v3s16>::iterator i = list.begin();
538 i != list.end(); ++i){
539 v3s16 p = pos + (*i);
540 content_t c = env->getMap().getNodeNoEx(p).getContent();
541 if(filter.count(c) != 0){
550 // find_nodes_in_area(minp, maxp, nodenames) -> list of positions
551 // nodenames: eg. {"ignore", "group:tree"} or "default:dirt"
552 int ModApiEnvMod::l_find_nodes_in_area(lua_State *L)
556 INodeDefManager *ndef = getServer(L)->ndef();
557 v3s16 minp = read_v3s16(L, 1);
558 v3s16 maxp = read_v3s16(L, 2);
559 std::set<content_t> filter;
560 if(lua_istable(L, 3)){
563 while(lua_next(L, table) != 0){
564 // key at index -2 and value at index -1
565 luaL_checktype(L, -1, LUA_TSTRING);
566 ndef->getIds(lua_tostring(L, -1), filter);
567 // removes value, keeps key for next iteration
570 } else if(lua_isstring(L, 3)){
571 ndef->getIds(lua_tostring(L, 3), filter);
576 for(s16 x = minp.X; x <= maxp.X; x++)
577 for(s16 y = minp.Y; y <= maxp.Y; y++)
578 for(s16 z = minp.Z; z <= maxp.Z; z++) {
580 content_t c = env->getMap().getNodeNoEx(p).getContent();
581 if(filter.count(c) != 0) {
583 lua_rawseti(L, -2, ++i);
589 // get_perlin(seeddiff, octaves, persistence, scale)
590 // returns world-specific PerlinNoise
591 int ModApiEnvMod::l_get_perlin(lua_State *L)
595 int seeddiff = luaL_checkint(L, 1);
596 int octaves = luaL_checkint(L, 2);
597 float persistence = luaL_checknumber(L, 3);
598 float scale = luaL_checknumber(L, 4);
600 LuaPerlinNoise *n = new LuaPerlinNoise(seeddiff + int(env->getServerMap().getSeed()), octaves, persistence, scale);
601 *(void **)(lua_newuserdata(L, sizeof(void *))) = n;
602 luaL_getmetatable(L, "PerlinNoise");
603 lua_setmetatable(L, -2);
607 // get_perlin_map(noiseparams, size)
608 // returns world-specific PerlinNoiseMap
609 int ModApiEnvMod::l_get_perlin_map(lua_State *L)
613 NoiseParams *np = read_noiseparams(L, 1);
616 v3s16 size = read_v3s16(L, 2);
618 int seed = (int)(env->getServerMap().getSeed());
619 LuaPerlinNoiseMap *n = new LuaPerlinNoiseMap(np, seed, size);
620 *(void **)(lua_newuserdata(L, sizeof(void *))) = n;
621 luaL_getmetatable(L, "PerlinNoiseMap");
622 lua_setmetatable(L, -2);
627 // returns voxel manipulator
628 int ModApiEnvMod::l_get_voxel_manip(lua_State *L)
632 Map *map = &(env->getMap());
633 LuaVoxelManip *o = new LuaVoxelManip(map);
635 *(void **)(lua_newuserdata(L, sizeof(void *))) = o;
636 luaL_getmetatable(L, "VoxelManip");
637 lua_setmetatable(L, -2);
642 // clear all objects in the environment
643 int ModApiEnvMod::l_clear_objects(lua_State *L)
647 env->clearAllObjects();
651 // line_of_sight(pos1, pos2, stepsize) -> true/false, pos
652 int ModApiEnvMod::l_line_of_sight(lua_State *L) {
653 float stepsize = 1.0;
657 // read position 1 from lua
658 v3f pos1 = checkFloatPos(L, 1);
659 // read position 2 from lua
660 v3f pos2 = checkFloatPos(L, 2);
661 //read step size from lua
662 if (lua_isnumber(L, 3)) {
663 stepsize = lua_tonumber(L, 3);
667 bool success = env->line_of_sight(pos1, pos2, stepsize, &p);
668 lua_pushboolean(L, success);
676 // find_path(pos1, pos2, searchdistance,
677 // max_jump, max_drop, algorithm) -> table containing path
678 int ModApiEnvMod::l_find_path(lua_State *L)
682 v3s16 pos1 = read_v3s16(L, 1);
683 v3s16 pos2 = read_v3s16(L, 2);
684 unsigned int searchdistance = luaL_checkint(L, 3);
685 unsigned int max_jump = luaL_checkint(L, 4);
686 unsigned int max_drop = luaL_checkint(L, 5);
687 algorithm algo = A_PLAIN_NP;
688 if (!lua_isnil(L, 6)) {
689 std::string algorithm = luaL_checkstring(L,6);
691 if (algorithm == "A*")
694 if (algorithm == "Dijkstra")
698 std::vector<v3s16> path =
699 get_Path(env,pos1,pos2,searchdistance,max_jump,max_drop,algo);
704 int top = lua_gettop(L);
705 unsigned int index = 1;
706 for (std::vector<v3s16>::iterator i = path.begin(); i != path.end();i++)
708 lua_pushnumber(L,index);
710 lua_settable(L, top);
719 // spawn_tree(pos, treedef)
720 int ModApiEnvMod::l_spawn_tree(lua_State *L)
724 v3s16 p0 = read_v3s16(L, 1);
726 treegen::TreeDef tree_def;
727 std::string trunk,leaves,fruit;
728 INodeDefManager *ndef = env->getGameDef()->ndef();
730 if(lua_istable(L, 2))
732 getstringfield(L, 2, "axiom", tree_def.initial_axiom);
733 getstringfield(L, 2, "rules_a", tree_def.rules_a);
734 getstringfield(L, 2, "rules_b", tree_def.rules_b);
735 getstringfield(L, 2, "rules_c", tree_def.rules_c);
736 getstringfield(L, 2, "rules_d", tree_def.rules_d);
737 getstringfield(L, 2, "trunk", trunk);
738 tree_def.trunknode=ndef->getId(trunk);
739 getstringfield(L, 2, "leaves", leaves);
740 tree_def.leavesnode=ndef->getId(leaves);
741 tree_def.leaves2_chance=0;
742 getstringfield(L, 2, "leaves2", leaves);
745 tree_def.leaves2node=ndef->getId(leaves);
746 getintfield(L, 2, "leaves2_chance", tree_def.leaves2_chance);
748 getintfield(L, 2, "angle", tree_def.angle);
749 getintfield(L, 2, "iterations", tree_def.iterations);
750 getintfield(L, 2, "random_level", tree_def.iterations_random_level);
751 getstringfield(L, 2, "trunk_type", tree_def.trunk_type);
752 getboolfield(L, 2, "thin_branches", tree_def.thin_branches);
753 tree_def.fruit_chance=0;
754 getstringfield(L, 2, "fruit", fruit);
757 tree_def.fruitnode=ndef->getId(fruit);
758 getintfield(L, 2, "fruit_chance",tree_def.fruit_chance);
760 getintfield(L, 2, "seed", tree_def.seed);
764 treegen::spawn_ltree (env, p0, ndef, tree_def);
768 // transforming_liquid_add(pos)
769 int ModApiEnvMod::l_transforming_liquid_add(lua_State *L)
773 v3s16 p0 = read_v3s16(L, 1);
774 env->getMap().transforming_liquid_add(p0);
778 // forceload_block(blockpos)
779 // blockpos = {x=num, y=num, z=num}
780 int ModApiEnvMod::l_forceload_block(lua_State *L)
784 v3s16 blockpos = read_v3s16(L, 1);
785 env->getForceloadedBlocks()->insert(blockpos);
789 // forceload_free_block(blockpos)
790 // blockpos = {x=num, y=num, z=num}
791 int ModApiEnvMod::l_forceload_free_block(lua_State *L)
795 v3s16 blockpos = read_v3s16(L, 1);
796 env->getForceloadedBlocks()->erase(blockpos);
800 void ModApiEnvMod::Initialize(lua_State *L, int top)
806 API_FCT(remove_node);
808 API_FCT(get_node_or_nil);
809 API_FCT(get_node_light);
813 API_FCT(get_node_max_level);
814 API_FCT(get_node_level);
815 API_FCT(set_node_level);
816 API_FCT(add_node_level);
819 API_FCT(get_node_timer);
820 API_FCT(get_player_by_name);
821 API_FCT(get_objects_inside_radius);
822 API_FCT(set_timeofday);
823 API_FCT(get_timeofday);
824 API_FCT(get_gametime);
825 API_FCT(find_node_near);
826 API_FCT(find_nodes_in_area);
828 API_FCT(get_perlin_map);
829 API_FCT(get_voxel_manip);
830 API_FCT(clear_objects);
833 API_FCT(line_of_sight);
834 API_FCT(transforming_liquid_add);
835 API_FCT(forceload_block);
836 API_FCT(forceload_free_block);