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.
21 #include "lua_api/l_env.h"
22 #include "lua_api/l_internal.h"
23 #include "lua_api/l_nodemeta.h"
24 #include "lua_api/l_nodetimer.h"
25 #include "lua_api/l_noise.h"
26 #include "lua_api/l_vmanip.h"
27 #include "common/c_converter.h"
28 #include "common/c_content.h"
29 #include "scripting_server.h"
30 #include "environment.h"
34 #include "daynightratio.h"
35 #include "util/pointedthing.h"
36 #include "mapgen/treegen.h"
38 #include "pathfinder.h"
39 #include "face_position_cache.h"
40 #include "remoteplayer.h"
41 #include "server/luaentity_sao.h"
42 #include "server/player_sao.h"
43 #include "util/string.h"
44 #include "translation.h"
46 #include "client/client.h"
49 struct EnumString ModApiEnvMod::es_ClearObjectsMode[] = {
50 {CLEAR_OBJECTS_MODE_FULL, "full"},
51 {CLEAR_OBJECTS_MODE_QUICK, "quick"},
55 ///////////////////////////////////////////////////////////////////////////////
57 void LuaABM::trigger(ServerEnvironment *env, v3s16 p, MapNode n, u32 active_object_count,
58 u32 active_object_count_wider)
60 ServerScripting *scriptIface = env->getScriptIface();
61 scriptIface->realityCheck();
63 lua_State *L = scriptIface->getStack();
64 sanity_check(lua_checkstack(L, 20));
65 StackUnroller stack_unroller(L);
67 int error_handler = PUSH_ERROR_HANDLER(L);
69 // Get registered_abms
70 lua_getglobal(L, "core");
71 lua_getfield(L, -1, "registered_abms");
72 luaL_checktype(L, -1, LUA_TTABLE);
73 lua_remove(L, -2); // Remove core
75 // Get registered_abms[m_id]
76 lua_pushinteger(L, m_id);
80 lua_remove(L, -2); // Remove registered_abms
82 scriptIface->setOriginFromTable(-1);
85 luaL_checktype(L, -1, LUA_TTABLE);
86 lua_getfield(L, -1, "action");
87 luaL_checktype(L, -1, LUA_TFUNCTION);
88 lua_remove(L, -2); // Remove registered_abms[m_id]
90 pushnode(L, n, env->getGameDef()->ndef());
91 lua_pushnumber(L, active_object_count);
92 lua_pushnumber(L, active_object_count_wider);
94 int result = lua_pcall(L, 4, 0, error_handler);
96 scriptIface->scriptError(result, "LuaABM::trigger");
98 lua_pop(L, 1); // Pop error handler
101 void LuaLBM::trigger(ServerEnvironment *env, v3s16 p, MapNode n)
103 ServerScripting *scriptIface = env->getScriptIface();
104 scriptIface->realityCheck();
106 lua_State *L = scriptIface->getStack();
107 sanity_check(lua_checkstack(L, 20));
108 StackUnroller stack_unroller(L);
110 int error_handler = PUSH_ERROR_HANDLER(L);
112 // Get registered_lbms
113 lua_getglobal(L, "core");
114 lua_getfield(L, -1, "registered_lbms");
115 luaL_checktype(L, -1, LUA_TTABLE);
116 lua_remove(L, -2); // Remove core
118 // Get registered_lbms[m_id]
119 lua_pushinteger(L, m_id);
121 FATAL_ERROR_IF(lua_isnil(L, -1),
122 "Entry with given id not found in registered_lbms table");
123 lua_remove(L, -2); // Remove registered_lbms
125 scriptIface->setOriginFromTable(-1);
128 luaL_checktype(L, -1, LUA_TTABLE);
129 lua_getfield(L, -1, "action");
130 luaL_checktype(L, -1, LUA_TFUNCTION);
131 lua_remove(L, -2); // Remove registered_lbms[m_id]
133 pushnode(L, n, env->getGameDef()->ndef());
135 int result = lua_pcall(L, 2, 0, error_handler);
137 scriptIface->scriptError(result, "LuaLBM::trigger");
139 lua_pop(L, 1); // Pop error handler
142 int LuaRaycast::l_next(lua_State *L)
148 csm = getClient(L) != nullptr;
151 LuaRaycast *o = checkobject(L, 1);
152 PointedThing pointed;
153 env->continueRaycast(&o->state, &pointed);
154 if (pointed.type == POINTEDTHING_NOTHING)
157 push_pointed_thing(L, pointed, csm, true);
162 int LuaRaycast::create_object(lua_State *L)
164 NO_MAP_LOCK_REQUIRED;
167 bool liquids = false;
169 v3f pos1 = checkFloatPos(L, 1);
170 v3f pos2 = checkFloatPos(L, 2);
171 if (lua_isboolean(L, 3)) {
172 objects = readParam<bool>(L, 3);
174 if (lua_isboolean(L, 4)) {
175 liquids = readParam<bool>(L, 4);
178 LuaRaycast *o = new LuaRaycast(core::line3d<f32>(pos1, pos2), objects, liquids);
180 *(void **)(lua_newuserdata(L, sizeof(void *))) = o;
181 luaL_getmetatable(L, className);
182 lua_setmetatable(L, -2);
186 LuaRaycast *LuaRaycast::checkobject(lua_State *L, int narg)
188 NO_MAP_LOCK_REQUIRED;
190 luaL_checktype(L, narg, LUA_TUSERDATA);
191 void *ud = luaL_checkudata(L, narg, className);
193 luaL_typerror(L, narg, className);
194 return *(LuaRaycast **)ud;
197 int LuaRaycast::gc_object(lua_State *L)
199 LuaRaycast *o = *(LuaRaycast **)(lua_touserdata(L, 1));
204 void LuaRaycast::Register(lua_State *L)
207 int methodtable = lua_gettop(L);
208 luaL_newmetatable(L, className);
209 int metatable = lua_gettop(L);
211 lua_pushliteral(L, "__metatable");
212 lua_pushvalue(L, methodtable);
213 lua_settable(L, metatable);
215 lua_pushliteral(L, "__index");
216 lua_pushvalue(L, methodtable);
217 lua_settable(L, metatable);
219 lua_pushliteral(L, "__gc");
220 lua_pushcfunction(L, gc_object);
221 lua_settable(L, metatable);
223 lua_pushliteral(L, "__call");
224 lua_pushcfunction(L, l_next);
225 lua_settable(L, metatable);
229 luaL_openlib(L, 0, methods, 0);
232 lua_register(L, className, create_object);
235 const char LuaRaycast::className[] = "Raycast";
236 const luaL_Reg LuaRaycast::methods[] = {luamethod(LuaRaycast, next), {0, 0}};
238 void LuaEmergeAreaCallback(v3s16 blockpos, EmergeAction action, void *param)
240 ScriptCallbackState *state = (ScriptCallbackState *)param;
241 assert(state != NULL);
242 assert(state->script != NULL);
243 assert(state->refcount > 0);
245 // state must be protected by envlock
246 Server *server = state->script->getServer();
247 MutexAutoLock envlock(server->m_env_mutex);
251 state->script->on_emerge_area_completion(blockpos, action, state);
253 if (state->refcount == 0)
257 // Exported functions
259 // set_node(pos, node)
260 // pos = {x=num, y=num, z=num}
261 int ModApiEnvMod::l_set_node(lua_State *L)
265 const NodeDefManager *ndef = env->getGameDef()->ndef();
267 v3s16 pos = read_v3s16(L, 1);
268 MapNode n = readnode(L, 2, ndef);
270 bool succeeded = env->setNode(pos, n);
271 lua_pushboolean(L, succeeded);
275 // bulk_set_node([pos1, pos2, ...], node)
276 // pos = {x=num, y=num, z=num}
277 int ModApiEnvMod::l_bulk_set_node(lua_State *L)
281 const NodeDefManager *ndef = env->getGameDef()->ndef();
283 if (!lua_istable(L, 1)) {
287 s32 len = lua_objlen(L, 1);
289 lua_pushboolean(L, true);
293 MapNode n = readnode(L, 2, ndef);
296 bool succeeded = true;
297 for (s32 i = 1; i <= len; i++) {
298 lua_rawgeti(L, 1, i);
299 if (!env->setNode(read_v3s16(L, -1), n))
304 lua_pushboolean(L, succeeded);
308 int ModApiEnvMod::l_add_node(lua_State *L)
310 return l_set_node(L);
314 // pos = {x=num, y=num, z=num}
315 int ModApiEnvMod::l_remove_node(lua_State *L)
320 v3s16 pos = read_v3s16(L, 1);
322 bool succeeded = env->removeNode(pos);
323 lua_pushboolean(L, succeeded);
327 // swap_node(pos, node)
328 // pos = {x=num, y=num, z=num}
329 int ModApiEnvMod::l_swap_node(lua_State *L)
333 const NodeDefManager *ndef = env->getGameDef()->ndef();
335 v3s16 pos = read_v3s16(L, 1);
336 MapNode n = readnode(L, 2, ndef);
338 bool succeeded = env->swapNode(pos, n);
339 lua_pushboolean(L, succeeded);
344 // pos = {x=num, y=num, z=num}
345 int ModApiEnvMod::l_get_node(lua_State *L)
350 v3s16 pos = read_v3s16(L, 1);
352 MapNode n = env->getMap().getNode(pos);
354 pushnode(L, n, env->getGameDef()->ndef());
358 // get_node_or_nil(pos)
359 // pos = {x=num, y=num, z=num}
360 int ModApiEnvMod::l_get_node_or_nil(lua_State *L)
365 v3s16 pos = read_v3s16(L, 1);
368 MapNode n = env->getMap().getNode(pos, &pos_ok);
371 pushnode(L, n, env->getGameDef()->ndef());
378 // get_node_light(pos, timeofday)
379 // pos = {x=num, y=num, z=num}
380 // timeofday: nil = current time, 0 = night, 0.5 = day
381 int ModApiEnvMod::l_get_node_light(lua_State *L)
386 v3s16 pos = read_v3s16(L, 1);
387 u32 time_of_day = env->getTimeOfDay();
388 if (lua_isnumber(L, 2))
389 time_of_day = 24000.0 * lua_tonumber(L, 2);
390 time_of_day %= 24000;
391 u32 dnr = time_to_daynight_ratio(time_of_day, true);
394 MapNode n = env->getMap().getNode(pos, &is_position_ok);
395 if (is_position_ok) {
396 const NodeDefManager *ndef = env->getGameDef()->ndef();
397 lua_pushinteger(L, n.getLightBlend(dnr, ndef));
404 // place_node(pos, node)
405 // pos = {x=num, y=num, z=num}
406 int ModApiEnvMod::l_place_node(lua_State *L)
410 ScriptApiItem *scriptIfaceItem = getScriptApi<ScriptApiItem>(L);
411 Server *server = getServer(L);
412 const NodeDefManager *ndef = server->ndef();
413 IItemDefManager *idef = server->idef();
415 v3s16 pos = read_v3s16(L, 1);
416 MapNode n = readnode(L, 2, ndef);
418 // Don't attempt to load non-loaded area as of now
419 MapNode n_old = env->getMap().getNode(pos);
420 if (n_old.getContent() == CONTENT_IGNORE) {
421 lua_pushboolean(L, false);
424 // Create item to place
425 ItemStack item(ndef->get(n).name, 1, 0, idef);
426 // Make pointed position
427 PointedThing pointed;
428 pointed.type = POINTEDTHING_NODE;
429 pointed.node_abovesurface = pos;
430 pointed.node_undersurface = pos + v3s16(0, -1, 0);
431 // Place it with a NULL placer (appears in Lua as nil)
432 bool success = scriptIfaceItem->item_OnPlace(item, nullptr, pointed);
433 lua_pushboolean(L, success);
438 // pos = {x=num, y=num, z=num}
439 int ModApiEnvMod::l_dig_node(lua_State *L)
443 ScriptApiNode *scriptIfaceNode = getScriptApi<ScriptApiNode>(L);
445 v3s16 pos = read_v3s16(L, 1);
447 // Don't attempt to load non-loaded area as of now
448 MapNode n = env->getMap().getNode(pos);
449 if (n.getContent() == CONTENT_IGNORE) {
450 lua_pushboolean(L, false);
453 // Dig it out with a NULL digger (appears in Lua as a
454 // non-functional ObjectRef)
455 bool success = scriptIfaceNode->node_on_dig(pos, n, NULL);
456 lua_pushboolean(L, success);
461 // pos = {x=num, y=num, z=num}
462 int ModApiEnvMod::l_punch_node(lua_State *L)
466 ScriptApiNode *scriptIfaceNode = getScriptApi<ScriptApiNode>(L);
468 v3s16 pos = read_v3s16(L, 1);
470 // Don't attempt to load non-loaded area as of now
471 MapNode n = env->getMap().getNode(pos);
472 if (n.getContent() == CONTENT_IGNORE) {
473 lua_pushboolean(L, false);
476 // Punch it with a NULL puncher (appears in Lua as a non-functional
478 bool success = scriptIfaceNode->node_on_punch(pos, n, NULL, PointedThing());
479 lua_pushboolean(L, success);
483 // get_node_max_level(pos)
484 // pos = {x=num, y=num, z=num}
485 int ModApiEnvMod::l_get_node_max_level(lua_State *L)
489 v3s16 pos = read_v3s16(L, 1);
490 MapNode n = env->getMap().getNode(pos);
491 lua_pushnumber(L, n.getMaxLevel(env->getGameDef()->ndef()));
495 // get_node_level(pos)
496 // pos = {x=num, y=num, z=num}
497 int ModApiEnvMod::l_get_node_level(lua_State *L)
501 v3s16 pos = read_v3s16(L, 1);
502 MapNode n = env->getMap().getNode(pos);
503 lua_pushnumber(L, n.getLevel(env->getGameDef()->ndef()));
507 // set_node_level(pos, level)
508 // pos = {x=num, y=num, z=num}
510 int ModApiEnvMod::l_set_node_level(lua_State *L)
514 v3s16 pos = read_v3s16(L, 1);
516 if (lua_isnumber(L, 2))
517 level = lua_tonumber(L, 2);
518 MapNode n = env->getMap().getNode(pos);
519 lua_pushnumber(L, n.setLevel(env->getGameDef()->ndef(), level));
520 env->setNode(pos, n);
524 // add_node_level(pos, level)
525 // pos = {x=num, y=num, z=num}
527 int ModApiEnvMod::l_add_node_level(lua_State *L)
531 v3s16 pos = read_v3s16(L, 1);
533 if (lua_isnumber(L, 2))
534 level = lua_tonumber(L, 2);
535 MapNode n = env->getMap().getNode(pos);
536 lua_pushnumber(L, n.addLevel(env->getGameDef()->ndef(), level));
537 env->setNode(pos, n);
541 // find_nodes_with_meta(pos1, pos2)
542 int ModApiEnvMod::l_find_nodes_with_meta(lua_State *L)
546 std::vector<v3s16> positions = env->getMap().findNodesWithMetadata(
547 check_v3s16(L, 1), check_v3s16(L, 2));
549 lua_createtable(L, positions.size(), 0);
550 for (size_t i = 0; i != positions.size(); i++) {
551 push_v3s16(L, positions[i]);
552 lua_rawseti(L, -2, i + 1);
559 int ModApiEnvMod::l_get_meta(lua_State *L)
564 v3s16 p = read_v3s16(L, 1);
565 NodeMetaRef::create(L, p, env);
569 // get_node_timer(pos)
570 int ModApiEnvMod::l_get_node_timer(lua_State *L)
575 v3s16 p = read_v3s16(L, 1);
576 NodeTimerRef::create(L, p, &env->getServerMap());
580 // add_entity(pos, entityname, [staticdata]) -> ObjectRef or nil
581 // pos = {x=num, y=num, z=num}
582 int ModApiEnvMod::l_add_entity(lua_State *L)
586 v3f pos = checkFloatPos(L, 1);
587 const char *name = luaL_checkstring(L, 2);
588 const char *staticdata = luaL_optstring(L, 3, "");
590 ServerActiveObject *obj = new LuaEntitySAO(env, pos, name, staticdata);
591 int objectid = env->addActiveObject(obj);
592 // If failed to add, return nothing (reads as nil)
596 // If already deleted (can happen in on_activate), return nil
599 getScriptApiBase(L)->objectrefGetOrCreate(L, obj);
603 // add_item(pos, itemstack or itemstring or table) -> ObjectRef or nil
604 // pos = {x=num, y=num, z=num}
605 int ModApiEnvMod::l_add_item(lua_State *L)
610 // v3f pos = checkFloatPos(L, 1);
612 ItemStack item = read_item(L, 2, getServer(L)->idef());
613 if (item.empty() || !item.isKnown(getServer(L)->idef()))
616 int error_handler = PUSH_ERROR_HANDLER(L);
618 // Use spawn_item to spawn a __builtin:item
619 lua_getglobal(L, "core");
620 lua_getfield(L, -1, "spawn_item");
621 lua_remove(L, -2); // Remove core
622 if (lua_isnil(L, -1))
625 lua_pushstring(L, item.getItemString().c_str());
627 PCALL_RESL(L, lua_pcall(L, 2, 1, error_handler));
629 lua_remove(L, error_handler);
633 // get_connected_players()
634 int ModApiEnvMod::l_get_connected_players(lua_State *L)
636 ServerEnvironment *env = (ServerEnvironment *)getEnv(L);
638 log_deprecated(L, "Calling get_connected_players() at mod load time"
640 lua_createtable(L, 0, 0);
644 lua_createtable(L, env->getPlayerCount(), 0);
646 for (RemotePlayer *player : env->getPlayers()) {
647 if (player->getPeerId() == PEER_ID_INEXISTENT)
649 PlayerSAO *sao = player->getPlayerSAO();
650 if (sao && !sao->isGone()) {
651 getScriptApiBase(L)->objectrefGetOrCreate(L, sao);
652 lua_rawseti(L, -2, ++i);
658 // get_player_by_name(name)
659 int ModApiEnvMod::l_get_player_by_name(lua_State *L)
664 const char *name = luaL_checkstring(L, 1);
665 RemotePlayer *player = env->getPlayer(name);
666 if (!player || player->getPeerId() == PEER_ID_INEXISTENT)
668 PlayerSAO *sao = player->getPlayerSAO();
669 if (!sao || sao->isGone())
671 // Put player on stack
672 getScriptApiBase(L)->objectrefGetOrCreate(L, sao);
676 // get_objects_inside_radius(pos, radius)
677 int ModApiEnvMod::l_get_objects_inside_radius(lua_State *L)
680 ScriptApiBase *script = getScriptApiBase(L);
683 v3f pos = checkFloatPos(L, 1);
684 float radius = readParam<float>(L, 2) * BS;
685 std::vector<ServerActiveObject *> objs;
687 auto include_obj_cb = [](ServerActiveObject *obj) { return !obj->isGone(); };
688 env->getObjectsInsideRadius(objs, pos, radius, include_obj_cb);
691 lua_createtable(L, objs.size(), 0);
692 for (const auto obj : objs) {
693 // Insert object reference into table
694 script->objectrefGetOrCreate(L, obj);
695 lua_rawseti(L, -2, ++i);
700 // set_timeofday(val)
702 int ModApiEnvMod::l_set_timeofday(lua_State *L)
707 float timeofday_f = readParam<float>(L, 1);
708 sanity_check(timeofday_f >= 0.0 && timeofday_f <= 1.0);
709 int timeofday_mh = (int)(timeofday_f * 24000.0);
710 // This should be set directly in the environment but currently
711 // such changes aren't immediately sent to the clients, so call
712 // the server instead.
713 // env->setTimeOfDay(timeofday_mh);
714 getServer(L)->setTimeOfDay(timeofday_mh);
718 // get_timeofday() -> 0...1
719 int ModApiEnvMod::l_get_timeofday(lua_State *L)
724 int timeofday_mh = env->getTimeOfDay();
725 float timeofday_f = (float)timeofday_mh / 24000.0f;
726 lua_pushnumber(L, timeofday_f);
730 // get_day_count() -> int
731 int ModApiEnvMod::l_get_day_count(lua_State *L)
735 lua_pushnumber(L, env->getDayCount());
740 int ModApiEnvMod::l_get_gametime(lua_State *L)
744 int game_time = env->getGameTime();
745 lua_pushnumber(L, game_time);
749 void ModApiEnvMod::collectNodeIds(lua_State *L, int idx, const NodeDefManager *ndef,
750 std::vector<content_t> &filter)
752 if (lua_istable(L, idx)) {
754 while (lua_next(L, idx) != 0) {
755 // key at index -2 and value at index -1
756 luaL_checktype(L, -1, LUA_TSTRING);
757 ndef->getIds(readParam<std::string>(L, -1), filter);
758 // removes value, keeps key for next iteration
761 } else if (lua_isstring(L, idx)) {
762 ndef->getIds(readParam<std::string>(L, 3), filter);
766 // find_node_near(pos, radius, nodenames, [search_center]) -> pos or nil
767 // nodenames: eg. {"ignore", "group:tree"} or "default:dirt"
768 int ModApiEnvMod::l_find_node_near(lua_State *L)
772 const NodeDefManager *ndef = env->getGameDef()->ndef();
773 Map &map = env->getMap();
775 v3s16 pos = read_v3s16(L, 1);
776 int radius = luaL_checkinteger(L, 2);
777 std::vector<content_t> filter;
778 collectNodeIds(L, 3, ndef, filter);
779 int start_radius = (lua_isboolean(L, 4) && readParam<bool>(L, 4)) ? 0 : 1;
782 // Client API limitations
783 if (Client *client = getClient(L))
784 radius = client->CSMClampRadius(pos, radius);
787 for (int d = start_radius; d <= radius; d++) {
788 const std::vector<v3s16> &list = FacePositionCache::getFacePositions(d);
789 for (const v3s16 &i : list) {
791 content_t c = map.getNode(p).getContent();
792 if (CONTAINS(filter, c)) {
801 // find_nodes_near(pos, radius, nodenames, [search_center])
802 // nodenames: eg. {"ignore", "group:tree"} or "default:dirt"
803 int ModApiEnvMod::l_find_nodes_near(lua_State *L)
807 const NodeDefManager *ndef = env->getGameDef()->ndef();
808 Map &map = env->getMap();
810 v3s16 pos = read_v3s16(L, 1);
811 int radius = luaL_checkinteger(L, 2);
812 std::vector<content_t> filter;
813 collectNodeIds(L, 3, ndef, filter);
815 int start_radius = (lua_isboolean(L, 4) && readParam<bool>(L, 4)) ? 0 : 1;
818 // Client API limitations
819 if (Client *client = getClient(L))
820 radius = client->CSMClampRadius(pos, radius);
823 std::vector<u32> individual_count;
824 individual_count.resize(filter.size());
829 for (int d = start_radius; d <= radius; d++) {
830 const std::vector<v3s16> &list = FacePositionCache::getFacePositions(d);
831 for (const v3s16 &posi : list) {
832 v3s16 p = pos + posi;
833 content_t c = map.getNode(p).getContent();
834 auto it = std::find(filter.begin(), filter.end(), c);
835 if (it != filter.end()) {
837 lua_rawseti(L, -2, ++i);
839 u32 filt_index = it - filter.begin();
840 individual_count[filt_index]++;
844 lua_createtable(L, 0, filter.size());
845 for (u32 i = 0; i < filter.size(); i++) {
846 lua_pushinteger(L, individual_count[i]);
847 lua_setfield(L, -2, ndef->get(filter[i]).name.c_str());
852 // find_nodes_near_under_air(pos, radius, nodenames, [search_center])
853 // nodenames: eg. {"ignore", "group:tree"} or "default:dirt"
854 int ModApiEnvMod::l_find_nodes_near_under_air(lua_State *L)
858 const NodeDefManager *ndef = env->getGameDef()->ndef();
859 Map &map = env->getMap();
861 v3s16 pos = read_v3s16(L, 1);
862 int radius = luaL_checkinteger(L, 2);
863 std::vector<content_t> filter;
864 collectNodeIds(L, 3, ndef, filter);
865 int start_radius = (lua_isboolean(L, 4) && readParam<bool>(L, 4)) ? 0 : 1;
868 // Client API limitations
869 if (Client *client = getClient(L))
870 radius = client->CSMClampRadius(pos, radius);
873 std::vector<u32> individual_count;
874 individual_count.resize(filter.size());
879 for (int d = start_radius; d <= radius; d++) {
880 const std::vector<v3s16> &list = FacePositionCache::getFacePositions(d);
881 for (const v3s16 &posi : list) {
882 v3s16 p = pos + posi;
883 content_t c = map.getNode(p).getContent();
884 v3s16 psurf(p.X, p.Y + 1, p.Z);
885 content_t csurf = map.getNode(psurf).getContent();
886 if (c == CONTENT_AIR || csurf != CONTENT_AIR)
888 auto it = std::find(filter.begin(), filter.end(), c);
889 if (it != filter.end()) {
891 lua_rawseti(L, -2, ++i);
893 u32 filt_index = it - filter.begin();
894 individual_count[filt_index]++;
898 lua_createtable(L, 0, filter.size());
899 for (u32 i = 0; i < filter.size(); i++) {
900 lua_pushinteger(L, individual_count[i]);
901 lua_setfield(L, -2, ndef->get(filter[i]).name.c_str());
906 // find_nodes_near_under_air_except(pos, radius, nodenames, [search_center])
907 // nodenames: eg. {"ignore", "group:tree"} or "default:dirt"
908 int ModApiEnvMod::l_find_nodes_near_under_air_except(lua_State *L)
912 const NodeDefManager *ndef = env->getGameDef()->ndef();
913 Map &map = env->getMap();
915 v3s16 pos = read_v3s16(L, 1);
916 int radius = luaL_checkinteger(L, 2);
917 std::vector<content_t> filter;
918 collectNodeIds(L, 3, ndef, filter);
919 int start_radius = (lua_isboolean(L, 4) && readParam<bool>(L, 4)) ? 0 : 1;
922 // Client API limitations
923 if (Client *client = getClient(L))
924 radius = client->CSMClampRadius(pos, radius);
927 std::vector<u32> individual_count;
928 individual_count.resize(filter.size());
933 for (int d = start_radius; d <= radius; d++) {
934 const std::vector<v3s16> &list = FacePositionCache::getFacePositions(d);
935 for (const v3s16 &posi : list) {
936 v3s16 p = pos + posi;
937 content_t c = map.getNode(p).getContent();
938 v3s16 psurf(p.X, p.Y + 1, p.Z);
939 content_t csurf = map.getNode(psurf).getContent();
940 if (c == CONTENT_AIR || csurf != CONTENT_AIR)
942 auto it = std::find(filter.begin(), filter.end(), c);
943 if (it == filter.end()) {
945 lua_rawseti(L, -2, ++i);
947 u32 filt_index = it - filter.begin();
948 individual_count[filt_index]++;
952 lua_createtable(L, 0, filter.size());
953 for (u32 i = 0; i < filter.size(); i++) {
954 lua_pushinteger(L, individual_count[i]);
955 lua_setfield(L, -2, ndef->get(filter[i]).name.c_str());
960 // find_nodes_in_area(minp, maxp, nodenames, [grouped])
961 int ModApiEnvMod::l_find_nodes_in_area(lua_State *L)
965 v3s16 minp = read_v3s16(L, 1);
966 v3s16 maxp = read_v3s16(L, 2);
967 sortBoxVerticies(minp, maxp);
969 const NodeDefManager *ndef = env->getGameDef()->ndef();
970 Map &map = env->getMap();
973 if (Client *client = getClient(L)) {
974 minp = client->CSMClampPos(minp);
975 maxp = client->CSMClampPos(maxp);
979 v3s16 cube = maxp - minp + 1;
980 // Volume limit equal to 8 default mapchunks, (80 * 2) ^ 3 = 4,096,000
981 if ((u64)cube.X * (u64)cube.Y * (u64)cube.Z > 4096000) {
982 luaL_error(L, "find_nodes_in_area(): area volume"
983 " exceeds allowed value of 4096000");
987 std::vector<content_t> filter;
988 collectNodeIds(L, 3, ndef, filter);
990 bool grouped = lua_isboolean(L, 4) && readParam<bool>(L, 4);
993 // create the table we will be returning
994 lua_createtable(L, 0, filter.size());
995 int base = lua_gettop(L);
997 // create one table for each filter
998 std::vector<u32> idx;
999 idx.resize(filter.size());
1000 for (u32 i = 0; i < filter.size(); i++)
1004 for (p.X = minp.X; p.X <= maxp.X; p.X++)
1005 for (p.Y = minp.Y; p.Y <= maxp.Y; p.Y++)
1006 for (p.Z = minp.Z; p.Z <= maxp.Z; p.Z++) {
1007 content_t c = map.getNode(p).getContent();
1009 auto it = std::find(
1010 filter.begin(), filter.end(), c);
1011 if (it != filter.end()) {
1012 // Calculate index of the table and append
1014 u32 filt_index = it - filter.begin();
1016 lua_rawseti(L, base + 1 + filt_index,
1021 // last filter table is at top of stack
1022 u32 i = filter.size() - 1;
1025 // No such node found -> drop the empty table
1028 // This node was found -> put table into the return table
1029 lua_setfield(L, base, ndef->get(filter[i]).name.c_str());
1033 assert(lua_gettop(L) == base);
1036 std::vector<u32> individual_count;
1037 individual_count.resize(filter.size());
1042 for (p.X = minp.X; p.X <= maxp.X; p.X++)
1043 for (p.Y = minp.Y; p.Y <= maxp.Y; p.Y++)
1044 for (p.Z = minp.Z; p.Z <= maxp.Z; p.Z++) {
1045 content_t c = env->getMap().getNode(p)
1048 auto it = std::find(
1049 filter.begin(), filter.end(), c);
1050 if (it != filter.end()) {
1052 lua_rawseti(L, -2, ++i);
1054 u32 filt_index = it - filter.begin();
1055 individual_count[filt_index]++;
1059 lua_createtable(L, 0, filter.size());
1060 for (u32 i = 0; i < filter.size(); i++) {
1061 lua_pushinteger(L, individual_count[i]);
1062 lua_setfield(L, -2, ndef->get(filter[i]).name.c_str());
1068 // find_nodes_in_area_under_air(minp, maxp, nodenames) -> list of positions
1069 // nodenames: e.g. {"ignore", "group:tree"} or "default:dirt"
1070 int ModApiEnvMod::l_find_nodes_in_area_under_air(lua_State *L)
1072 /* Note: A similar but generalized (and therefore slower) version of this
1073 * function could be created -- e.g. find_nodes_in_area_under -- which
1074 * would accept a node name (or ID?) or list of names that the "above node"
1081 v3s16 minp = read_v3s16(L, 1);
1082 v3s16 maxp = read_v3s16(L, 2);
1083 sortBoxVerticies(minp, maxp);
1085 const NodeDefManager *ndef = env->getGameDef()->ndef();
1086 Map &map = env->getMap();
1089 if (Client *client = getClient(L)) {
1090 minp = client->CSMClampPos(minp);
1091 maxp = client->CSMClampPos(maxp);
1095 v3s16 cube = maxp - minp + 1;
1096 // Volume limit equal to 8 default mapchunks, (80 * 2) ^ 3 = 4,096,000
1097 if ((u64)cube.X * (u64)cube.Y * (u64)cube.Z > 4096000) {
1098 luaL_error(L, "find_nodes_in_area_under_air(): area volume"
1099 " exceeds allowed value of 4096000");
1103 std::vector<content_t> filter;
1104 collectNodeIds(L, 3, ndef, filter);
1109 for (p.X = minp.X; p.X <= maxp.X; p.X++)
1110 for (p.Z = minp.Z; p.Z <= maxp.Z; p.Z++) {
1112 content_t c = map.getNode(p).getContent();
1113 for (; p.Y <= maxp.Y; p.Y++) {
1114 v3s16 psurf(p.X, p.Y + 1, p.Z);
1115 content_t csurf = map.getNode(psurf).getContent();
1116 if (c != CONTENT_AIR && csurf == CONTENT_AIR &&
1117 CONTAINS(filter, c)) {
1119 lua_rawseti(L, -2, ++i);
1127 // get_perlin(seeddiff, octaves, persistence, scale)
1128 // returns world-specific PerlinNoise
1129 int ModApiEnvMod::l_get_perlin(lua_State *L)
1131 GET_ENV_PTR_NO_MAP_LOCK;
1135 if (lua_istable(L, 1)) {
1136 read_noiseparams(L, 1, ¶ms);
1138 params.seed = luaL_checkint(L, 1);
1139 params.octaves = luaL_checkint(L, 2);
1140 params.persist = readParam<float>(L, 3);
1141 params.spread = v3f(1, 1, 1) * readParam<float>(L, 4);
1144 params.seed += (int)env->getServerMap().getSeed();
1146 LuaPerlinNoise *n = new LuaPerlinNoise(¶ms);
1147 *(void **)(lua_newuserdata(L, sizeof(void *))) = n;
1148 luaL_getmetatable(L, "PerlinNoise");
1149 lua_setmetatable(L, -2);
1153 // get_perlin_map(noiseparams, size)
1154 // returns world-specific PerlinNoiseMap
1155 int ModApiEnvMod::l_get_perlin_map(lua_State *L)
1157 GET_ENV_PTR_NO_MAP_LOCK;
1160 if (!read_noiseparams(L, 1, &np))
1162 v3s16 size = read_v3s16(L, 2);
1164 s32 seed = (s32)(env->getServerMap().getSeed());
1165 LuaPerlinNoiseMap *n = new LuaPerlinNoiseMap(&np, seed, size);
1166 *(void **)(lua_newuserdata(L, sizeof(void *))) = n;
1167 luaL_getmetatable(L, "PerlinNoiseMap");
1168 lua_setmetatable(L, -2);
1172 // get_voxel_manip()
1173 // returns voxel manipulator
1174 int ModApiEnvMod::l_get_voxel_manip(lua_State *L)
1178 Map *map = &(env->getMap());
1179 LuaVoxelManip *o = (lua_istable(L, 1) && lua_istable(L, 2))
1180 ? new LuaVoxelManip(map, read_v3s16(L, 1),
1182 : new LuaVoxelManip(map);
1184 *(void **)(lua_newuserdata(L, sizeof(void *))) = o;
1185 luaL_getmetatable(L, "VoxelManip");
1186 lua_setmetatable(L, -2);
1190 // clear_objects([options])
1191 // clear all objects in the environment
1192 // where options = {mode = "full" or "quick"}
1193 int ModApiEnvMod::l_clear_objects(lua_State *L)
1197 ClearObjectsMode mode = CLEAR_OBJECTS_MODE_QUICK;
1198 if (lua_istable(L, 1)) {
1199 mode = (ClearObjectsMode)getenumfield(
1200 L, 1, "mode", ModApiEnvMod::es_ClearObjectsMode, mode);
1203 env->clearObjects(mode);
1207 // line_of_sight(pos1, pos2) -> true/false, pos
1208 int ModApiEnvMod::l_line_of_sight(lua_State *L)
1212 // read position 1 from lua
1213 v3f pos1 = checkFloatPos(L, 1);
1214 // read position 2 from lua
1215 v3f pos2 = checkFloatPos(L, 2);
1219 bool success = env->line_of_sight(pos1, pos2, &p);
1220 lua_pushboolean(L, success);
1228 // fix_light(p1, p2)
1229 int ModApiEnvMod::l_fix_light(lua_State *L)
1233 v3s16 blockpos1 = getContainerPos(read_v3s16(L, 1), MAP_BLOCKSIZE);
1234 v3s16 blockpos2 = getContainerPos(read_v3s16(L, 2), MAP_BLOCKSIZE);
1235 ServerMap &map = env->getServerMap();
1236 std::map<v3s16, MapBlock *> modified_blocks;
1237 bool success = true;
1239 for (blockpos.X = blockpos1.X; blockpos.X <= blockpos2.X; blockpos.X++)
1240 for (blockpos.Y = blockpos1.Y; blockpos.Y <= blockpos2.Y; blockpos.Y++)
1241 for (blockpos.Z = blockpos1.Z; blockpos.Z <= blockpos2.Z;
1243 success = success & map.repairBlockLight(blockpos,
1246 if (!modified_blocks.empty()) {
1248 event.type = MEET_OTHER;
1249 for (auto &modified_block : modified_blocks)
1250 event.modified_blocks.insert(modified_block.first);
1252 map.dispatchEvent(event);
1254 lua_pushboolean(L, success);
1259 int ModApiEnvMod::l_raycast(lua_State *L)
1261 return LuaRaycast::create_object(L);
1264 // load_area(p1, [p2])
1265 // load mapblocks in area p1..p2, but do not generate map
1266 int ModApiEnvMod::l_load_area(lua_State *L)
1271 Map *map = &(env->getMap());
1272 v3s16 bp1 = getNodeBlockPos(check_v3s16(L, 1));
1273 if (!lua_istable(L, 2)) {
1274 map->emergeBlock(bp1);
1276 v3s16 bp2 = getNodeBlockPos(check_v3s16(L, 2));
1277 sortBoxVerticies(bp1, bp2);
1278 for (s16 z = bp1.Z; z <= bp2.Z; z++)
1279 for (s16 y = bp1.Y; y <= bp2.Y; y++)
1280 for (s16 x = bp1.X; x <= bp2.X; x++) {
1281 map->emergeBlock(v3s16(x, y, z));
1288 // emerge_area(p1, p2, [callback, context])
1289 // emerge mapblocks in area p1..p2, calls callback with context upon completion
1290 int ModApiEnvMod::l_emerge_area(lua_State *L)
1294 EmergeCompletionCallback callback = NULL;
1295 ScriptCallbackState *state = NULL;
1297 EmergeManager *emerge = getServer(L)->getEmergeManager();
1299 v3s16 bpmin = getNodeBlockPos(read_v3s16(L, 1));
1300 v3s16 bpmax = getNodeBlockPos(read_v3s16(L, 2));
1301 sortBoxVerticies(bpmin, bpmax);
1303 size_t num_blocks = VoxelArea(bpmin, bpmax).getVolume();
1304 assert(num_blocks != 0);
1306 if (lua_isfunction(L, 3)) {
1307 callback = LuaEmergeAreaCallback;
1309 lua_pushvalue(L, 3);
1310 int callback_ref = luaL_ref(L, LUA_REGISTRYINDEX);
1312 lua_pushvalue(L, 4);
1313 int args_ref = luaL_ref(L, LUA_REGISTRYINDEX);
1315 state = new ScriptCallbackState;
1316 state->script = getServer(L)->getScriptIface();
1317 state->callback_ref = callback_ref;
1318 state->args_ref = args_ref;
1319 state->refcount = num_blocks;
1320 state->origin = getScriptApiBase(L)->getOrigin();
1323 for (s16 z = bpmin.Z; z <= bpmax.Z; z++)
1324 for (s16 y = bpmin.Y; y <= bpmax.Y; y++)
1325 for (s16 x = bpmin.X; x <= bpmax.X; x++) {
1326 emerge->enqueueBlockEmergeEx(v3s16(x, y, z),
1328 BLOCK_EMERGE_ALLOW_GEN |
1329 BLOCK_EMERGE_FORCE_QUEUE,
1336 // delete_area(p1, p2)
1337 // delete mapblocks in area p1..p2
1338 int ModApiEnvMod::l_delete_area(lua_State *L)
1342 v3s16 bpmin = getNodeBlockPos(read_v3s16(L, 1));
1343 v3s16 bpmax = getNodeBlockPos(read_v3s16(L, 2));
1344 sortBoxVerticies(bpmin, bpmax);
1346 ServerMap &map = env->getServerMap();
1349 event.type = MEET_OTHER;
1351 bool success = true;
1352 for (s16 z = bpmin.Z; z <= bpmax.Z; z++)
1353 for (s16 y = bpmin.Y; y <= bpmax.Y; y++)
1354 for (s16 x = bpmin.X; x <= bpmax.X; x++) {
1356 if (map.deleteBlock(bp)) {
1357 env->setStaticForActiveObjectsInBlock(bp, false);
1358 event.modified_blocks.insert(bp);
1364 map.dispatchEvent(event);
1365 lua_pushboolean(L, success);
1369 // find_path(pos1, pos2, searchdistance,
1370 // max_jump, max_drop, algorithm) -> table containing path
1371 int ModApiEnvMod::l_find_path(lua_State *L)
1373 Environment *env = getEnv(L);
1375 v3s16 pos1 = read_v3s16(L, 1);
1376 v3s16 pos2 = read_v3s16(L, 2);
1377 unsigned int searchdistance = luaL_checkint(L, 3);
1378 unsigned int max_jump = luaL_checkint(L, 4);
1379 unsigned int max_drop = luaL_checkint(L, 5);
1380 PathAlgorithm algo = PA_PLAIN_NP;
1381 if (!lua_isnoneornil(L, 6)) {
1382 std::string algorithm = luaL_checkstring(L, 6);
1384 if (algorithm == "A*")
1387 if (algorithm == "Dijkstra")
1391 std::vector<v3s16> path = get_path(&env->getMap(), env->getGameDef()->ndef(),
1392 pos1, pos2, searchdistance, max_jump, max_drop, algo);
1394 if (!path.empty()) {
1395 lua_createtable(L, path.size(), 0);
1396 int top = lua_gettop(L);
1397 unsigned int index = 1;
1398 for (const v3s16 &i : path) {
1399 lua_pushnumber(L, index);
1401 lua_settable(L, top);
1410 // spawn_tree(pos, treedef)
1411 int ModApiEnvMod::l_spawn_tree(lua_State *L)
1415 v3s16 p0 = read_v3s16(L, 1);
1417 treegen::TreeDef tree_def;
1418 std::string trunk, leaves, fruit;
1419 const NodeDefManager *ndef = env->getGameDef()->ndef();
1421 if (lua_istable(L, 2)) {
1422 getstringfield(L, 2, "axiom", tree_def.initial_axiom);
1423 getstringfield(L, 2, "rules_a", tree_def.rules_a);
1424 getstringfield(L, 2, "rules_b", tree_def.rules_b);
1425 getstringfield(L, 2, "rules_c", tree_def.rules_c);
1426 getstringfield(L, 2, "rules_d", tree_def.rules_d);
1427 getstringfield(L, 2, "trunk", trunk);
1428 tree_def.trunknode = ndef->getId(trunk);
1429 getstringfield(L, 2, "leaves", leaves);
1430 tree_def.leavesnode = ndef->getId(leaves);
1431 tree_def.leaves2_chance = 0;
1432 getstringfield(L, 2, "leaves2", leaves);
1433 if (!leaves.empty()) {
1434 tree_def.leaves2node = ndef->getId(leaves);
1435 getintfield(L, 2, "leaves2_chance", tree_def.leaves2_chance);
1437 getintfield(L, 2, "angle", tree_def.angle);
1438 getintfield(L, 2, "iterations", tree_def.iterations);
1439 if (!getintfield(L, 2, "random_level", tree_def.iterations_random_level))
1440 tree_def.iterations_random_level = 0;
1441 getstringfield(L, 2, "trunk_type", tree_def.trunk_type);
1442 getboolfield(L, 2, "thin_branches", tree_def.thin_branches);
1443 tree_def.fruit_chance = 0;
1444 getstringfield(L, 2, "fruit", fruit);
1445 if (!fruit.empty()) {
1446 tree_def.fruitnode = ndef->getId(fruit);
1447 getintfield(L, 2, "fruit_chance", tree_def.fruit_chance);
1449 tree_def.explicit_seed = getintfield(L, 2, "seed", tree_def.seed);
1453 ServerMap *map = &env->getServerMap();
1455 if ((e = treegen::spawn_ltree(map, p0, ndef, tree_def)) != treegen::SUCCESS) {
1456 if (e == treegen::UNBALANCED_BRACKETS) {
1457 luaL_error(L, "spawn_tree(): closing ']' has no matching opening "
1460 luaL_error(L, "spawn_tree(): unknown error");
1467 // transforming_liquid_add(pos)
1468 int ModApiEnvMod::l_transforming_liquid_add(lua_State *L)
1472 v3s16 p0 = read_v3s16(L, 1);
1473 env->getMap().transforming_liquid_add(p0);
1477 // forceload_block(blockpos)
1478 // blockpos = {x=num, y=num, z=num}
1479 int ModApiEnvMod::l_forceload_block(lua_State *L)
1483 v3s16 blockpos = read_v3s16(L, 1);
1484 env->getForceloadedBlocks()->insert(blockpos);
1488 // forceload_free_block(blockpos)
1489 // blockpos = {x=num, y=num, z=num}
1490 int ModApiEnvMod::l_forceload_free_block(lua_State *L)
1494 v3s16 blockpos = read_v3s16(L, 1);
1495 env->getForceloadedBlocks()->erase(blockpos);
1499 // get_translated_string(lang_code, string)
1500 int ModApiEnvMod::l_get_translated_string(lua_State *L)
1503 std::string lang_code = luaL_checkstring(L, 1);
1504 std::string string = luaL_checkstring(L, 2);
1505 getServer(L)->loadTranslationLanguage(lang_code);
1506 string = wide_to_utf8(translate_string(
1507 utf8_to_wide(string), &(*g_server_translations)[lang_code]));
1508 lua_pushstring(L, string.c_str());
1512 void ModApiEnvMod::Initialize(lua_State *L, int top)
1515 API_FCT(bulk_set_node);
1519 API_FCT(remove_node);
1521 API_FCT(get_node_or_nil);
1522 API_FCT(get_node_light);
1523 API_FCT(place_node);
1525 API_FCT(punch_node);
1526 API_FCT(get_node_max_level);
1527 API_FCT(get_node_level);
1528 API_FCT(set_node_level);
1529 API_FCT(add_node_level);
1530 API_FCT(add_entity);
1531 API_FCT(find_nodes_with_meta);
1533 API_FCT(get_node_timer);
1534 API_FCT(get_connected_players);
1535 API_FCT(get_player_by_name);
1536 API_FCT(get_objects_inside_radius);
1537 API_FCT(set_timeofday);
1538 API_FCT(get_timeofday);
1539 API_FCT(get_gametime);
1540 API_FCT(get_day_count);
1541 API_FCT(find_node_near);
1542 API_FCT(find_nodes_in_area);
1543 API_FCT(find_nodes_in_area_under_air);
1546 API_FCT(emerge_area);
1547 API_FCT(delete_area);
1548 API_FCT(get_perlin);
1549 API_FCT(get_perlin_map);
1550 API_FCT(get_voxel_manip);
1551 API_FCT(clear_objects);
1552 API_FCT(spawn_tree);
1554 API_FCT(line_of_sight);
1556 API_FCT(transforming_liquid_add);
1557 API_FCT(forceload_block);
1558 API_FCT(forceload_free_block);
1559 API_FCT(get_translated_string);
1562 void ModApiEnvMod::InitializeClient(lua_State *L, int top)
1564 API_FCT(get_node_light);
1565 API_FCT(get_timeofday);
1566 API_FCT(get_node_max_level);
1567 API_FCT(get_node_level);
1568 API_FCT(find_nodes_with_meta);
1569 API_FCT(find_node_near);
1570 API_FCT(find_nodes_near);
1571 API_FCT(find_nodes_near_under_air);
1572 API_FCT(find_nodes_near_under_air_except);
1573 API_FCT(find_nodes_in_area);
1574 API_FCT(find_nodes_in_area_under_air);
1576 API_FCT(line_of_sight);