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_object.h"
22 #include "lua_api/l_internal.h"
23 #include "lua_api/l_inventory.h"
24 #include "lua_api/l_item.h"
25 #include "lua_api/l_playermeta.h"
26 #include "common/c_converter.h"
27 #include "common/c_content.h"
30 #include "serverobject.h"
31 #include "content_sao.h"
32 #include "remoteplayer.h"
35 #include "scripting_server.h"
42 ObjectRef* ObjectRef::checkobject(lua_State *L, int narg)
44 luaL_checktype(L, narg, LUA_TUSERDATA);
45 void *ud = luaL_checkudata(L, narg, className);
46 if (!ud) luaL_typerror(L, narg, className);
47 return *(ObjectRef**)ud; // unbox pointer
50 ServerActiveObject* ObjectRef::getobject(ObjectRef *ref)
52 ServerActiveObject *co = ref->m_object;
56 LuaEntitySAO* ObjectRef::getluaobject(ObjectRef *ref)
58 ServerActiveObject *obj = getobject(ref);
61 if (obj->getType() != ACTIVEOBJECT_TYPE_LUAENTITY)
63 return (LuaEntitySAO*)obj;
66 PlayerSAO* ObjectRef::getplayersao(ObjectRef *ref)
68 ServerActiveObject *obj = getobject(ref);
71 if (obj->getType() != ACTIVEOBJECT_TYPE_PLAYER)
73 return (PlayerSAO*)obj;
76 RemotePlayer *ObjectRef::getplayer(ObjectRef *ref)
78 PlayerSAO *playersao = getplayersao(ref);
79 if (playersao == NULL)
81 return playersao->getPlayer();
87 int ObjectRef::gc_object(lua_State *L) {
88 ObjectRef *o = *(ObjectRef **)(lua_touserdata(L, 1));
89 //infostream<<"ObjectRef::gc_object: o="<<o<<std::endl;
95 int ObjectRef::l_remove(lua_State *L)
99 ObjectRef *ref = checkobject(L, 1);
100 ServerActiveObject *co = getobject(ref);
103 if (co->getType() == ACTIVEOBJECT_TYPE_PLAYER)
106 co->clearChildAttachments();
107 co->clearParentAttachment();
109 verbosestream << "ObjectRef::l_remove(): id=" << co->getId() << std::endl;
110 co->m_pending_removal = true;
115 // returns: {x=num, y=num, z=num}
116 int ObjectRef::l_get_pos(lua_State *L)
118 NO_MAP_LOCK_REQUIRED;
119 ObjectRef *ref = checkobject(L, 1);
120 ServerActiveObject *co = getobject(ref);
121 if (co == NULL) return 0;
122 v3f pos = co->getBasePosition() / BS;
124 lua_pushnumber(L, pos.X);
125 lua_setfield(L, -2, "x");
126 lua_pushnumber(L, pos.Y);
127 lua_setfield(L, -2, "y");
128 lua_pushnumber(L, pos.Z);
129 lua_setfield(L, -2, "z");
133 // set_pos(self, pos)
134 int ObjectRef::l_set_pos(lua_State *L)
136 NO_MAP_LOCK_REQUIRED;
137 ObjectRef *ref = checkobject(L, 1);
138 //LuaEntitySAO *co = getluaobject(ref);
139 ServerActiveObject *co = getobject(ref);
140 if (co == NULL) return 0;
142 v3f pos = checkFloatPos(L, 2);
148 // move_to(self, pos, continuous=false)
149 int ObjectRef::l_move_to(lua_State *L)
151 NO_MAP_LOCK_REQUIRED;
152 ObjectRef *ref = checkobject(L, 1);
153 //LuaEntitySAO *co = getluaobject(ref);
154 ServerActiveObject *co = getobject(ref);
155 if (co == NULL) return 0;
157 v3f pos = checkFloatPos(L, 2);
159 bool continuous = readParam<bool>(L, 3);
161 co->moveTo(pos, continuous);
165 // punch(self, puncher, time_from_last_punch, tool_capabilities, dir)
166 int ObjectRef::l_punch(lua_State *L)
168 NO_MAP_LOCK_REQUIRED;
169 ObjectRef *ref = checkobject(L, 1);
170 ObjectRef *puncher_ref = checkobject(L, 2);
171 ServerActiveObject *co = getobject(ref);
172 ServerActiveObject *puncher = getobject(puncher_ref);
176 if (lua_type(L, 5) != LUA_TTABLE)
177 dir = co->getBasePosition() - puncher->getBasePosition();
179 dir = read_v3f(L, 5);
180 float time_from_last_punch = 1000000;
181 if (lua_isnumber(L, 3))
182 time_from_last_punch = lua_tonumber(L, 3);
183 ToolCapabilities toolcap = read_tool_capabilities(L, 4);
186 u16 src_original_hp = co->getHP();
187 u16 dst_origin_hp = puncher->getHP();
190 co->punch(dir, &toolcap, puncher, time_from_last_punch);
192 // If the punched is a player, and its HP changed
193 if (src_original_hp != co->getHP() &&
194 co->getType() == ACTIVEOBJECT_TYPE_PLAYER) {
195 getServer(L)->SendPlayerHPOrDie((PlayerSAO *)co,
196 PlayerHPChangeReason(PlayerHPChangeReason::PLAYER_PUNCH, puncher));
199 // If the puncher is a player, and its HP changed
200 if (dst_origin_hp != puncher->getHP() &&
201 puncher->getType() == ACTIVEOBJECT_TYPE_PLAYER) {
202 getServer(L)->SendPlayerHPOrDie((PlayerSAO *)puncher,
203 PlayerHPChangeReason(PlayerHPChangeReason::PLAYER_PUNCH, co));
208 // right_click(self, clicker); clicker = an another ObjectRef
209 int ObjectRef::l_right_click(lua_State *L)
211 NO_MAP_LOCK_REQUIRED;
212 ObjectRef *ref = checkobject(L, 1);
213 ObjectRef *ref2 = checkobject(L, 2);
214 ServerActiveObject *co = getobject(ref);
215 ServerActiveObject *co2 = getobject(ref2);
216 if (co == NULL) return 0;
217 if (co2 == NULL) return 0;
224 // hp = number of hitpoints (2 * number of hearts)
226 int ObjectRef::l_set_hp(lua_State *L)
228 NO_MAP_LOCK_REQUIRED;
231 ObjectRef *ref = checkobject(L, 1);
232 luaL_checknumber(L, 2);
233 ServerActiveObject *co = getobject(ref);
238 int hp = lua_tonumber(L, 2);
241 PlayerHPChangeReason reason(PlayerHPChangeReason::SET_HP);
242 reason.from_mod = true;
243 if (lua_istable(L, 3)) {
246 lua_getfield(L, -1, "type");
247 if (lua_isstring(L, -1) &&
248 !reason.setTypeFromString(readParam<std::string>(L, -1))) {
249 errorstream << "Bad type given!" << std::endl;
253 reason.lua_reference = luaL_ref(L, LUA_REGISTRYINDEX);
257 co->setHP(hp, reason);
258 if (co->getType() == ACTIVEOBJECT_TYPE_PLAYER)
259 getServer(L)->SendPlayerHPOrDie((PlayerSAO *)co, reason);
261 if (reason.hasLuaReference())
262 luaL_unref(L, LUA_REGISTRYINDEX, reason.lua_reference);
269 // returns: number of hitpoints (2 * number of hearts)
270 // 0 if not applicable to this type of object
271 int ObjectRef::l_get_hp(lua_State *L)
273 NO_MAP_LOCK_REQUIRED;
274 ObjectRef *ref = checkobject(L, 1);
275 ServerActiveObject *co = getobject(ref);
278 lua_pushnumber(L, 1);
281 int hp = co->getHP();
282 /*infostream<<"ObjectRef::l_get_hp(): id="<<co->getId()
283 <<" hp="<<hp<<std::endl;*/
285 lua_pushnumber(L, hp);
289 // get_inventory(self)
290 int ObjectRef::l_get_inventory(lua_State *L)
292 NO_MAP_LOCK_REQUIRED;
293 ObjectRef *ref = checkobject(L, 1);
294 ServerActiveObject *co = getobject(ref);
295 if (co == NULL) return 0;
297 InventoryLocation loc = co->getInventoryLocation();
298 if (getServer(L)->getInventory(loc) != NULL)
299 InvRef::create(L, loc);
301 lua_pushnil(L); // An object may have no inventory (nil)
305 // get_wield_list(self)
306 int ObjectRef::l_get_wield_list(lua_State *L)
308 NO_MAP_LOCK_REQUIRED;
309 ObjectRef *ref = checkobject(L, 1);
310 ServerActiveObject *co = getobject(ref);
311 if (co == NULL) return 0;
313 lua_pushstring(L, co->getWieldList().c_str());
317 // get_wield_index(self)
318 int ObjectRef::l_get_wield_index(lua_State *L)
320 NO_MAP_LOCK_REQUIRED;
321 ObjectRef *ref = checkobject(L, 1);
322 ServerActiveObject *co = getobject(ref);
323 if (co == NULL) return 0;
325 lua_pushinteger(L, co->getWieldIndex() + 1);
329 // get_wielded_item(self)
330 int ObjectRef::l_get_wielded_item(lua_State *L)
332 NO_MAP_LOCK_REQUIRED;
333 ObjectRef *ref = checkobject(L, 1);
334 ServerActiveObject *co = getobject(ref);
337 LuaItemStack::create(L, ItemStack());
341 LuaItemStack::create(L, co->getWieldedItem());
345 // set_wielded_item(self, itemstack or itemstring or table or nil)
346 int ObjectRef::l_set_wielded_item(lua_State *L)
348 NO_MAP_LOCK_REQUIRED;
349 ObjectRef *ref = checkobject(L, 1);
350 ServerActiveObject *co = getobject(ref);
351 if (co == NULL) return 0;
353 ItemStack item = read_item(L, 2, getServer(L)->idef());
354 bool success = co->setWieldedItem(item);
355 if (success && co->getType() == ACTIVEOBJECT_TYPE_PLAYER) {
356 getServer(L)->SendInventory(((PlayerSAO*)co));
358 lua_pushboolean(L, success);
362 // set_armor_groups(self, groups)
363 int ObjectRef::l_set_armor_groups(lua_State *L)
365 NO_MAP_LOCK_REQUIRED;
366 ObjectRef *ref = checkobject(L, 1);
367 ServerActiveObject *co = getobject(ref);
368 if (co == NULL) return 0;
370 ItemGroupList groups;
371 read_groups(L, 2, groups);
372 co->setArmorGroups(groups);
376 // get_armor_groups(self)
377 int ObjectRef::l_get_armor_groups(lua_State *L)
379 NO_MAP_LOCK_REQUIRED;
380 ObjectRef *ref = checkobject(L, 1);
381 ServerActiveObject *co = getobject(ref);
385 push_groups(L, co->getArmorGroups());
389 // set_physics_override(self, physics_override_speed, physics_override_jump,
390 // physics_override_gravity, sneak, sneak_glitch, new_move)
391 int ObjectRef::l_set_physics_override(lua_State *L)
393 NO_MAP_LOCK_REQUIRED;
394 ObjectRef *ref = checkobject(L, 1);
395 PlayerSAO *co = (PlayerSAO *) getobject(ref);
396 if (co == NULL) return 0;
398 if (lua_istable(L, 2)) {
399 co->m_physics_override_speed = getfloatfield_default(
400 L, 2, "speed", co->m_physics_override_speed);
401 co->m_physics_override_jump = getfloatfield_default(
402 L, 2, "jump", co->m_physics_override_jump);
403 co->m_physics_override_gravity = getfloatfield_default(
404 L, 2, "gravity", co->m_physics_override_gravity);
405 co->m_physics_override_sneak = getboolfield_default(
406 L, 2, "sneak", co->m_physics_override_sneak);
407 co->m_physics_override_sneak_glitch = getboolfield_default(
408 L, 2, "sneak_glitch", co->m_physics_override_sneak_glitch);
409 co->m_physics_override_new_move = getboolfield_default(
410 L, 2, "new_move", co->m_physics_override_new_move);
411 co->m_physics_override_sent = false;
413 // old, non-table format
414 if (!lua_isnil(L, 2)) {
415 co->m_physics_override_speed = lua_tonumber(L, 2);
416 co->m_physics_override_sent = false;
418 if (!lua_isnil(L, 3)) {
419 co->m_physics_override_jump = lua_tonumber(L, 3);
420 co->m_physics_override_sent = false;
422 if (!lua_isnil(L, 4)) {
423 co->m_physics_override_gravity = lua_tonumber(L, 4);
424 co->m_physics_override_sent = false;
430 // get_physics_override(self)
431 int ObjectRef::l_get_physics_override(lua_State *L)
433 NO_MAP_LOCK_REQUIRED;
434 ObjectRef *ref = checkobject(L, 1);
435 PlayerSAO *co = (PlayerSAO *)getobject(ref);
440 lua_pushnumber(L, co->m_physics_override_speed);
441 lua_setfield(L, -2, "speed");
442 lua_pushnumber(L, co->m_physics_override_jump);
443 lua_setfield(L, -2, "jump");
444 lua_pushnumber(L, co->m_physics_override_gravity);
445 lua_setfield(L, -2, "gravity");
446 lua_pushboolean(L, co->m_physics_override_sneak);
447 lua_setfield(L, -2, "sneak");
448 lua_pushboolean(L, co->m_physics_override_sneak_glitch);
449 lua_setfield(L, -2, "sneak_glitch");
450 lua_pushboolean(L, co->m_physics_override_new_move);
451 lua_setfield(L, -2, "new_move");
455 // set_animation(self, frame_range, frame_speed, frame_blend, frame_loop)
456 int ObjectRef::l_set_animation(lua_State *L)
458 NO_MAP_LOCK_REQUIRED;
459 ObjectRef *ref = checkobject(L, 1);
460 ServerActiveObject *co = getobject(ref);
461 if (co == NULL) return 0;
463 v2f frames = v2f(1, 1);
464 if (!lua_isnil(L, 2))
465 frames = readParam<v2f>(L, 2);
466 float frame_speed = 15;
467 if (!lua_isnil(L, 3))
468 frame_speed = lua_tonumber(L, 3);
469 float frame_blend = 0;
470 if (!lua_isnil(L, 4))
471 frame_blend = lua_tonumber(L, 4);
472 bool frame_loop = true;
473 if (lua_isboolean(L, 5))
474 frame_loop = readParam<bool>(L, 5);
475 co->setAnimation(frames, frame_speed, frame_blend, frame_loop);
479 // get_animation(self)
480 int ObjectRef::l_get_animation(lua_State *L)
482 NO_MAP_LOCK_REQUIRED;
483 ObjectRef *ref = checkobject(L, 1);
484 ServerActiveObject *co = getobject(ref);
488 v2f frames = v2f(1,1);
489 float frame_speed = 15;
490 float frame_blend = 0;
491 bool frame_loop = true;
492 co->getAnimation(&frames, &frame_speed, &frame_blend, &frame_loop);
495 lua_pushnumber(L, frame_speed);
496 lua_pushnumber(L, frame_blend);
497 lua_pushboolean(L, frame_loop);
501 // set_local_animation(self, {stand/idle}, {walk}, {dig}, {walk+dig}, frame_speed)
502 int ObjectRef::l_set_local_animation(lua_State *L)
504 NO_MAP_LOCK_REQUIRED;
505 ObjectRef *ref = checkobject(L, 1);
506 RemotePlayer *player = getplayer(ref);
511 for (int i=0;i<4;i++) {
512 if (!lua_isnil(L, 2+1))
513 frames[i] = read_v2s32(L, 2+i);
515 float frame_speed = 30;
516 if (!lua_isnil(L, 6))
517 frame_speed = lua_tonumber(L, 6);
519 getServer(L)->setLocalPlayerAnimations(player, frames, frame_speed);
520 lua_pushboolean(L, true);
524 // get_local_animation(self)
525 int ObjectRef::l_get_local_animation(lua_State *L)
528 ObjectRef *ref = checkobject(L, 1);
529 RemotePlayer *player = getplayer(ref);
535 player->getLocalAnimations(frames, &frame_speed);
537 for (const v2s32 &frame : frames) {
538 push_v2s32(L, frame);
541 lua_pushnumber(L, frame_speed);
545 // set_eye_offset(self, v3f first pv, v3f third pv)
546 int ObjectRef::l_set_eye_offset(lua_State *L)
548 NO_MAP_LOCK_REQUIRED;
549 ObjectRef *ref = checkobject(L, 1);
550 RemotePlayer *player = getplayer(ref);
554 v3f offset_first = v3f(0, 0, 0);
555 v3f offset_third = v3f(0, 0, 0);
557 if (!lua_isnil(L, 2))
558 offset_first = read_v3f(L, 2);
559 if (!lua_isnil(L, 3))
560 offset_third = read_v3f(L, 3);
562 // Prevent abuse of offset values (keep player always visible)
563 offset_third.X = rangelim(offset_third.X,-10,10);
564 offset_third.Z = rangelim(offset_third.Z,-5,5);
565 /* TODO: if possible: improve the camera colision detetion to allow Y <= -1.5) */
566 offset_third.Y = rangelim(offset_third.Y,-10,15); //1.5*BS
568 getServer(L)->setPlayerEyeOffset(player, offset_first, offset_third);
569 lua_pushboolean(L, true);
573 // get_eye_offset(self)
574 int ObjectRef::l_get_eye_offset(lua_State *L)
576 NO_MAP_LOCK_REQUIRED;
577 ObjectRef *ref = checkobject(L, 1);
578 RemotePlayer *player = getplayer(ref);
582 push_v3f(L, player->eye_offset_first);
583 push_v3f(L, player->eye_offset_third);
587 // send_mapblock(self, pos)
588 int ObjectRef::l_send_mapblock(lua_State *L)
590 NO_MAP_LOCK_REQUIRED;
591 ObjectRef *ref = checkobject(L, 1);
593 RemotePlayer *player = getplayer(ref);
596 v3s16 p = read_v3s16(L, 2);
598 session_t peer_id = player->getPeerId();
599 bool r = getServer(L)->SendBlock(peer_id, p);
601 lua_pushboolean(L, r);
605 // set_animation_frame_speed(self, frame_speed)
606 int ObjectRef::l_set_animation_frame_speed(lua_State *L)
608 NO_MAP_LOCK_REQUIRED;
609 ObjectRef *ref = checkobject(L, 1);
610 ServerActiveObject *co = getobject(ref);
615 if (!lua_isnil(L, 2)) {
616 float frame_speed = lua_tonumber(L, 2);
617 co->setAnimationSpeed(frame_speed);
618 lua_pushboolean(L, true);
620 lua_pushboolean(L, false);
625 // set_bone_position(self, std::string bone, v3f position, v3f rotation)
626 int ObjectRef::l_set_bone_position(lua_State *L)
628 NO_MAP_LOCK_REQUIRED;
629 ObjectRef *ref = checkobject(L, 1);
630 ServerActiveObject *co = getobject(ref);
631 if (co == NULL) return 0;
634 if (!lua_isnil(L, 2))
635 bone = readParam<std::string>(L, 2);
636 v3f position = v3f(0, 0, 0);
637 if (!lua_isnil(L, 3))
638 position = check_v3f(L, 3);
639 v3f rotation = v3f(0, 0, 0);
640 if (!lua_isnil(L, 4))
641 rotation = check_v3f(L, 4);
642 co->setBonePosition(bone, position, rotation);
646 // get_bone_position(self, bone)
647 int ObjectRef::l_get_bone_position(lua_State *L)
649 NO_MAP_LOCK_REQUIRED;
650 ObjectRef *ref = checkobject(L, 1);
651 ServerActiveObject *co = getobject(ref);
656 if (!lua_isnil(L, 2))
657 bone = readParam<std::string>(L, 2);
659 v3f position = v3f(0, 0, 0);
660 v3f rotation = v3f(0, 0, 0);
661 co->getBonePosition(bone, &position, &rotation);
663 push_v3f(L, position);
664 push_v3f(L, rotation);
668 // set_attach(self, parent, bone, position, rotation)
669 int ObjectRef::l_set_attach(lua_State *L)
673 ObjectRef *ref = checkobject(L, 1);
674 ObjectRef *parent_ref = checkobject(L, 2);
675 ServerActiveObject *co = getobject(ref);
676 ServerActiveObject *parent = getobject(parent_ref);
684 v3f position = v3f(0, 0, 0);
685 v3f rotation = v3f(0, 0, 0);
686 co->getAttachment(&parent_id, &bone, &position, &rotation);
688 ServerActiveObject *old_parent = env->getActiveObject(parent_id);
689 old_parent->removeAttachmentChild(co->getId());
693 if (!lua_isnil(L, 3))
694 bone = readParam<std::string>(L, 3);
695 position = v3f(0, 0, 0);
696 if (!lua_isnil(L, 4))
697 position = read_v3f(L, 4);
698 rotation = v3f(0, 0, 0);
699 if (!lua_isnil(L, 5))
700 rotation = read_v3f(L, 5);
701 co->setAttachment(parent->getId(), bone, position, rotation);
702 parent->addAttachmentChild(co->getId());
707 int ObjectRef::l_get_attach(lua_State *L)
711 ObjectRef *ref = checkobject(L, 1);
712 ServerActiveObject *co = getobject(ref);
719 v3f position = v3f(0, 0, 0);
720 v3f rotation = v3f(0, 0, 0);
721 co->getAttachment(&parent_id, &bone, &position, &rotation);
724 ServerActiveObject *parent = env->getActiveObject(parent_id);
726 getScriptApiBase(L)->objectrefGetOrCreate(L, parent);
727 lua_pushlstring(L, bone.c_str(), bone.size());
728 push_v3f(L, position);
729 push_v3f(L, rotation);
734 int ObjectRef::l_set_detach(lua_State *L)
738 ObjectRef *ref = checkobject(L, 1);
739 ServerActiveObject *co = getobject(ref);
743 co->clearParentAttachment();
747 // set_properties(self, properties)
748 int ObjectRef::l_set_properties(lua_State *L)
750 NO_MAP_LOCK_REQUIRED;
751 ObjectRef *ref = checkobject(L, 1);
752 ServerActiveObject *co = getobject(ref);
756 ObjectProperties *prop = co->accessObjectProperties();
760 read_object_properties(L, 2, co, prop, getServer(L)->idef());
761 co->notifyObjectPropertiesModified();
765 // get_properties(self)
766 int ObjectRef::l_get_properties(lua_State *L)
768 NO_MAP_LOCK_REQUIRED;
769 ObjectRef *ref = checkobject(L, 1);
770 ServerActiveObject *co = getobject(ref);
773 ObjectProperties *prop = co->accessObjectProperties();
776 push_object_properties(L, prop);
781 int ObjectRef::l_is_player(lua_State *L)
783 NO_MAP_LOCK_REQUIRED;
784 ObjectRef *ref = checkobject(L, 1);
785 RemotePlayer *player = getplayer(ref);
786 lua_pushboolean(L, (player != NULL));
790 // set_nametag_attributes(self, attributes)
791 int ObjectRef::l_set_nametag_attributes(lua_State *L)
793 NO_MAP_LOCK_REQUIRED;
794 ObjectRef *ref = checkobject(L, 1);
795 ServerActiveObject *co = getobject(ref);
799 ObjectProperties *prop = co->accessObjectProperties();
803 lua_getfield(L, 2, "color");
804 if (!lua_isnil(L, -1)) {
805 video::SColor color = prop->nametag_color;
806 read_color(L, -1, &color);
807 prop->nametag_color = color;
811 std::string nametag = getstringfield_default(L, 2, "text", "");
812 prop->nametag = nametag;
814 co->notifyObjectPropertiesModified();
815 lua_pushboolean(L, true);
819 // get_nametag_attributes(self)
820 int ObjectRef::l_get_nametag_attributes(lua_State *L)
822 NO_MAP_LOCK_REQUIRED;
823 ObjectRef *ref = checkobject(L, 1);
824 ServerActiveObject *co = getobject(ref);
828 ObjectProperties *prop = co->accessObjectProperties();
832 video::SColor color = prop->nametag_color;
835 push_ARGB8(L, color);
836 lua_setfield(L, -2, "color");
837 lua_pushstring(L, prop->nametag.c_str());
838 lua_setfield(L, -2, "text");
842 /* LuaEntitySAO-only */
844 // set_velocity(self, {x=num, y=num, z=num})
845 int ObjectRef::l_set_velocity(lua_State *L)
847 NO_MAP_LOCK_REQUIRED;
848 ObjectRef *ref = checkobject(L, 1);
849 LuaEntitySAO *co = getluaobject(ref);
850 if (co == NULL) return 0;
851 v3f pos = checkFloatPos(L, 2);
853 co->setVelocity(pos);
857 // add_velocity(self, {x=num, y=num, z=num})
858 int ObjectRef::l_add_velocity(lua_State *L)
860 NO_MAP_LOCK_REQUIRED;
861 ObjectRef *ref = checkobject(L, 1);
862 LuaEntitySAO *co = getluaobject(ref);
865 v3f pos = checkFloatPos(L, 2);
867 co->addVelocity(pos);
871 // get_velocity(self)
872 int ObjectRef::l_get_velocity(lua_State *L)
874 NO_MAP_LOCK_REQUIRED;
875 ObjectRef *ref = checkobject(L, 1);
876 LuaEntitySAO *co = getluaobject(ref);
877 if (co == NULL) return 0;
879 v3f v = co->getVelocity();
884 // set_acceleration(self, {x=num, y=num, z=num})
885 int ObjectRef::l_set_acceleration(lua_State *L)
887 NO_MAP_LOCK_REQUIRED;
888 ObjectRef *ref = checkobject(L, 1);
889 LuaEntitySAO *co = getluaobject(ref);
890 if (co == NULL) return 0;
892 v3f pos = checkFloatPos(L, 2);
894 co->setAcceleration(pos);
898 // get_acceleration(self)
899 int ObjectRef::l_get_acceleration(lua_State *L)
901 NO_MAP_LOCK_REQUIRED;
902 ObjectRef *ref = checkobject(L, 1);
903 LuaEntitySAO *co = getluaobject(ref);
904 if (co == NULL) return 0;
906 v3f v = co->getAcceleration();
911 // set_rotation(self, {x=num, y=num, z=num})
912 // Each 'num' is in radians
913 int ObjectRef::l_set_rotation(lua_State *L)
915 NO_MAP_LOCK_REQUIRED;
916 ObjectRef *ref = checkobject(L, 1);
917 LuaEntitySAO *co = getluaobject(ref);
921 v3f rotation = check_v3f(L, 2) * core::RADTODEG;
922 co->setRotation(rotation);
926 // get_rotation(self)
927 // returns: {x=num, y=num, z=num}
928 // Each 'num' is in radians
929 int ObjectRef::l_get_rotation(lua_State *L)
931 NO_MAP_LOCK_REQUIRED;
932 ObjectRef *ref = checkobject(L, 1);
933 LuaEntitySAO *co = getluaobject(ref);
938 v3f rotation = co->getRotation() * core::DEGTORAD;
939 push_v3f(L, rotation);
943 // set_yaw(self, radians)
944 int ObjectRef::l_set_yaw(lua_State *L)
946 NO_MAP_LOCK_REQUIRED;
947 ObjectRef *ref = checkobject(L, 1);
948 LuaEntitySAO *co = getluaobject(ref);
950 if (co == NULL) return 0;
952 throw LuaError("ObjectRef::set_yaw: NaN value is not allowed.");
954 float yaw = readParam<float>(L, 2) * core::RADTODEG;
955 co->setRotation(v3f(0, yaw, 0));
960 int ObjectRef::l_get_yaw(lua_State *L)
962 NO_MAP_LOCK_REQUIRED;
963 ObjectRef *ref = checkobject(L, 1);
964 LuaEntitySAO *co = getluaobject(ref);
968 float yaw = co->getRotation().Y * core::DEGTORAD;
969 lua_pushnumber(L, yaw);
973 // set_texture_mod(self, mod)
974 int ObjectRef::l_set_texture_mod(lua_State *L)
976 NO_MAP_LOCK_REQUIRED;
977 ObjectRef *ref = checkobject(L, 1);
978 LuaEntitySAO *co = getluaobject(ref);
979 if (co == NULL) return 0;
981 std::string mod = luaL_checkstring(L, 2);
982 co->setTextureMod(mod);
986 // get_texture_mod(self)
987 int ObjectRef::l_get_texture_mod(lua_State *L)
989 NO_MAP_LOCK_REQUIRED;
990 ObjectRef *ref = checkobject(L, 1);
991 LuaEntitySAO *co = getluaobject(ref);
992 if (co == NULL) return 0;
994 std::string mod = co->getTextureMod();
995 lua_pushstring(L, mod.c_str());
999 // set_sprite(self, p={x=0,y=0}, num_frames=1, framelength=0.2,
1000 // select_horiz_by_yawpitch=false)
1001 int ObjectRef::l_set_sprite(lua_State *L)
1003 NO_MAP_LOCK_REQUIRED;
1004 ObjectRef *ref = checkobject(L, 1);
1005 LuaEntitySAO *co = getluaobject(ref);
1006 if (co == NULL) return 0;
1009 if (!lua_isnil(L, 2))
1010 p = readParam<v2s16>(L, 2);
1012 if (!lua_isnil(L, 3))
1013 num_frames = lua_tonumber(L, 3);
1014 float framelength = 0.2;
1015 if (!lua_isnil(L, 4))
1016 framelength = lua_tonumber(L, 4);
1017 bool select_horiz_by_yawpitch = false;
1018 if (!lua_isnil(L, 5))
1019 select_horiz_by_yawpitch = readParam<bool>(L, 5);
1020 co->setSprite(p, num_frames, framelength, select_horiz_by_yawpitch);
1025 // get_entity_name(self)
1026 int ObjectRef::l_get_entity_name(lua_State *L)
1028 NO_MAP_LOCK_REQUIRED;
1029 ObjectRef *ref = checkobject(L, 1);
1030 LuaEntitySAO *co = getluaobject(ref);
1031 log_deprecated(L,"Deprecated call to \"get_entity_name");
1032 if (co == NULL) return 0;
1034 std::string name = co->getName();
1035 lua_pushstring(L, name.c_str());
1039 // get_luaentity(self)
1040 int ObjectRef::l_get_luaentity(lua_State *L)
1042 NO_MAP_LOCK_REQUIRED;
1043 ObjectRef *ref = checkobject(L, 1);
1044 LuaEntitySAO *co = getluaobject(ref);
1045 if (co == NULL) return 0;
1047 luaentity_get(L, co->getId());
1053 // is_player_connected(self)
1054 int ObjectRef::l_is_player_connected(lua_State *L)
1056 NO_MAP_LOCK_REQUIRED;
1057 ObjectRef *ref = checkobject(L, 1);
1058 RemotePlayer *player = getplayer(ref);
1059 lua_pushboolean(L, (player != NULL && player->getPeerId() != PEER_ID_INEXISTENT));
1063 // get_player_name(self)
1064 int ObjectRef::l_get_player_name(lua_State *L)
1066 NO_MAP_LOCK_REQUIRED;
1067 ObjectRef *ref = checkobject(L, 1);
1068 RemotePlayer *player = getplayer(ref);
1069 if (player == NULL) {
1070 lua_pushlstring(L, "", 0);
1074 lua_pushstring(L, player->getName());
1078 // get_player_velocity(self)
1079 int ObjectRef::l_get_player_velocity(lua_State *L)
1081 NO_MAP_LOCK_REQUIRED;
1082 ObjectRef *ref = checkobject(L, 1);
1083 RemotePlayer *player = getplayer(ref);
1084 if (player == NULL) {
1089 push_v3f(L, player->getSpeed() / BS);
1093 // get_look_dir(self)
1094 int ObjectRef::l_get_look_dir(lua_State *L)
1096 NO_MAP_LOCK_REQUIRED;
1097 ObjectRef *ref = checkobject(L, 1);
1098 PlayerSAO* co = getplayersao(ref);
1099 if (co == NULL) return 0;
1101 float pitch = co->getRadLookPitchDep();
1102 float yaw = co->getRadYawDep();
1103 v3f v(std::cos(pitch) * std::cos(yaw), std::sin(pitch), std::cos(pitch) *
1110 // get_look_pitch(self)
1111 int ObjectRef::l_get_look_pitch(lua_State *L)
1113 NO_MAP_LOCK_REQUIRED;
1116 "Deprecated call to get_look_pitch, use get_look_vertical instead");
1118 ObjectRef *ref = checkobject(L, 1);
1119 PlayerSAO* co = getplayersao(ref);
1120 if (co == NULL) return 0;
1122 lua_pushnumber(L, co->getRadLookPitchDep());
1127 // get_look_yaw(self)
1128 int ObjectRef::l_get_look_yaw(lua_State *L)
1130 NO_MAP_LOCK_REQUIRED;
1133 "Deprecated call to get_look_yaw, use get_look_horizontal instead");
1135 ObjectRef *ref = checkobject(L, 1);
1136 PlayerSAO* co = getplayersao(ref);
1137 if (co == NULL) return 0;
1139 lua_pushnumber(L, co->getRadYawDep());
1143 // get_look_pitch2(self)
1144 int ObjectRef::l_get_look_vertical(lua_State *L)
1146 NO_MAP_LOCK_REQUIRED;
1147 ObjectRef *ref = checkobject(L, 1);
1148 PlayerSAO* co = getplayersao(ref);
1149 if (co == NULL) return 0;
1151 lua_pushnumber(L, co->getRadLookPitch());
1155 // get_look_yaw2(self)
1156 int ObjectRef::l_get_look_horizontal(lua_State *L)
1158 NO_MAP_LOCK_REQUIRED;
1159 ObjectRef *ref = checkobject(L, 1);
1160 PlayerSAO* co = getplayersao(ref);
1161 if (co == NULL) return 0;
1163 lua_pushnumber(L, co->getRadRotation().Y);
1167 // set_look_vertical(self, radians)
1168 int ObjectRef::l_set_look_vertical(lua_State *L)
1170 NO_MAP_LOCK_REQUIRED;
1171 ObjectRef *ref = checkobject(L, 1);
1172 PlayerSAO* co = getplayersao(ref);
1173 if (co == NULL) return 0;
1174 float pitch = readParam<float>(L, 2) * core::RADTODEG;
1176 co->setLookPitchAndSend(pitch);
1180 // set_look_horizontal(self, radians)
1181 int ObjectRef::l_set_look_horizontal(lua_State *L)
1183 NO_MAP_LOCK_REQUIRED;
1184 ObjectRef *ref = checkobject(L, 1);
1185 PlayerSAO* co = getplayersao(ref);
1186 if (co == NULL) return 0;
1187 float yaw = readParam<float>(L, 2) * core::RADTODEG;
1189 co->setPlayerYawAndSend(yaw);
1194 // set_look_pitch(self, radians)
1195 int ObjectRef::l_set_look_pitch(lua_State *L)
1197 NO_MAP_LOCK_REQUIRED;
1200 "Deprecated call to set_look_pitch, use set_look_vertical instead.");
1202 ObjectRef *ref = checkobject(L, 1);
1203 PlayerSAO* co = getplayersao(ref);
1204 if (co == NULL) return 0;
1205 float pitch = readParam<float>(L, 2) * core::RADTODEG;
1207 co->setLookPitchAndSend(pitch);
1212 // set_look_yaw(self, radians)
1213 int ObjectRef::l_set_look_yaw(lua_State *L)
1215 NO_MAP_LOCK_REQUIRED;
1218 "Deprecated call to set_look_yaw, use set_look_horizontal instead.");
1220 ObjectRef *ref = checkobject(L, 1);
1221 PlayerSAO* co = getplayersao(ref);
1222 if (co == NULL) return 0;
1223 float yaw = readParam<float>(L, 2) * core::RADTODEG;
1225 co->setPlayerYawAndSend(yaw);
1229 // set_breath(self, breath)
1230 int ObjectRef::l_set_breath(lua_State *L)
1232 NO_MAP_LOCK_REQUIRED;
1233 ObjectRef *ref = checkobject(L, 1);
1234 PlayerSAO* co = getplayersao(ref);
1235 if (co == NULL) return 0;
1236 u16 breath = luaL_checknumber(L, 2);
1237 co->setBreath(breath);
1243 int ObjectRef::l_get_breath(lua_State *L)
1245 NO_MAP_LOCK_REQUIRED;
1246 ObjectRef *ref = checkobject(L, 1);
1247 PlayerSAO* co = getplayersao(ref);
1248 if (co == NULL) return 0;
1250 u16 breath = co->getBreath();
1251 lua_pushinteger (L, breath);
1255 // set_attribute(self, attribute, value)
1256 int ObjectRef::l_set_attribute(lua_State *L)
1259 "Deprecated call to set_attribute, use MetaDataRef methods instead.");
1261 ObjectRef *ref = checkobject(L, 1);
1262 PlayerSAO* co = getplayersao(ref);
1266 std::string attr = luaL_checkstring(L, 2);
1267 if (lua_isnil(L, 3)) {
1268 co->getMeta().removeString(attr);
1270 std::string value = luaL_checkstring(L, 3);
1271 co->getMeta().setString(attr, value);
1276 // get_attribute(self, attribute)
1277 int ObjectRef::l_get_attribute(lua_State *L)
1280 "Deprecated call to get_attribute, use MetaDataRef methods instead.");
1282 ObjectRef *ref = checkobject(L, 1);
1283 PlayerSAO* co = getplayersao(ref);
1287 std::string attr = luaL_checkstring(L, 2);
1290 if (co->getMeta().getStringToRef(attr, value)) {
1291 lua_pushstring(L, value.c_str());
1299 // get_meta(self, attribute)
1300 int ObjectRef::l_get_meta(lua_State *L)
1302 ObjectRef *ref = checkobject(L, 1);
1303 PlayerSAO *co = getplayersao(ref);
1307 PlayerMetaRef::create(L, &co->getMeta());
1312 // set_inventory_formspec(self, formspec)
1313 int ObjectRef::l_set_inventory_formspec(lua_State *L)
1315 NO_MAP_LOCK_REQUIRED;
1316 ObjectRef *ref = checkobject(L, 1);
1317 RemotePlayer *player = getplayer(ref);
1318 if (player == NULL) return 0;
1319 std::string formspec = luaL_checkstring(L, 2);
1321 player->inventory_formspec = formspec;
1322 getServer(L)->reportInventoryFormspecModified(player->getName());
1323 lua_pushboolean(L, true);
1327 // get_inventory_formspec(self) -> formspec
1328 int ObjectRef::l_get_inventory_formspec(lua_State *L)
1330 NO_MAP_LOCK_REQUIRED;
1331 ObjectRef *ref = checkobject(L, 1);
1332 RemotePlayer *player = getplayer(ref);
1333 if (player == NULL) return 0;
1335 std::string formspec = player->inventory_formspec;
1336 lua_pushlstring(L, formspec.c_str(), formspec.size());
1340 // set_formspec_prepend(self, formspec)
1341 int ObjectRef::l_set_formspec_prepend(lua_State *L)
1343 NO_MAP_LOCK_REQUIRED;
1344 ObjectRef *ref = checkobject(L, 1);
1345 RemotePlayer *player = getplayer(ref);
1349 std::string formspec = luaL_checkstring(L, 2);
1351 player->formspec_prepend = formspec;
1352 getServer(L)->reportFormspecPrependModified(player->getName());
1353 lua_pushboolean(L, true);
1357 // get_formspec_prepend(self) -> formspec
1358 int ObjectRef::l_get_formspec_prepend(lua_State *L)
1360 NO_MAP_LOCK_REQUIRED;
1361 ObjectRef *ref = checkobject(L, 1);
1362 RemotePlayer *player = getplayer(ref);
1366 std::string formspec = player->formspec_prepend;
1367 lua_pushlstring(L, formspec.c_str(), formspec.size());
1371 // get_player_control(self)
1372 int ObjectRef::l_get_player_control(lua_State *L)
1374 NO_MAP_LOCK_REQUIRED;
1375 ObjectRef *ref = checkobject(L, 1);
1376 RemotePlayer *player = getplayer(ref);
1377 if (player == NULL) {
1378 lua_pushlstring(L, "", 0);
1382 const PlayerControl &control = player->getPlayerControl();
1384 lua_pushboolean(L, control.up);
1385 lua_setfield(L, -2, "up");
1386 lua_pushboolean(L, control.down);
1387 lua_setfield(L, -2, "down");
1388 lua_pushboolean(L, control.left);
1389 lua_setfield(L, -2, "left");
1390 lua_pushboolean(L, control.right);
1391 lua_setfield(L, -2, "right");
1392 lua_pushboolean(L, control.jump);
1393 lua_setfield(L, -2, "jump");
1394 lua_pushboolean(L, control.aux1);
1395 lua_setfield(L, -2, "aux1");
1396 lua_pushboolean(L, control.sneak);
1397 lua_setfield(L, -2, "sneak");
1398 lua_pushboolean(L, control.LMB);
1399 lua_setfield(L, -2, "LMB");
1400 lua_pushboolean(L, control.RMB);
1401 lua_setfield(L, -2, "RMB");
1405 // get_player_control_bits(self)
1406 int ObjectRef::l_get_player_control_bits(lua_State *L)
1408 NO_MAP_LOCK_REQUIRED;
1409 ObjectRef *ref = checkobject(L, 1);
1410 RemotePlayer *player = getplayer(ref);
1411 if (player == NULL) {
1412 lua_pushlstring(L, "", 0);
1416 lua_pushnumber(L, player->keyPressed);
1420 // hud_add(self, form)
1421 int ObjectRef::l_hud_add(lua_State *L)
1423 NO_MAP_LOCK_REQUIRED;
1424 ObjectRef *ref = checkobject(L, 1);
1425 RemotePlayer *player = getplayer(ref);
1429 HudElement *elem = new HudElement;
1430 read_hud_element(L, elem);
1432 u32 id = getServer(L)->hudAdd(player, elem);
1433 if (id == U32_MAX) {
1438 lua_pushnumber(L, id);
1442 // hud_remove(self, id)
1443 int ObjectRef::l_hud_remove(lua_State *L)
1445 NO_MAP_LOCK_REQUIRED;
1446 ObjectRef *ref = checkobject(L, 1);
1447 RemotePlayer *player = getplayer(ref);
1452 if (!lua_isnil(L, 2))
1453 id = lua_tonumber(L, 2);
1455 if (!getServer(L)->hudRemove(player, id))
1458 lua_pushboolean(L, true);
1462 // hud_change(self, id, stat, data)
1463 int ObjectRef::l_hud_change(lua_State *L)
1465 NO_MAP_LOCK_REQUIRED;
1466 ObjectRef *ref = checkobject(L, 1);
1467 RemotePlayer *player = getplayer(ref);
1471 u32 id = lua_isnumber(L, 2) ? lua_tonumber(L, 2) : -1;
1473 HudElement *e = player->getHud(id);
1478 HudElementStat stat = read_hud_change(L, e, &value);
1480 getServer(L)->hudChange(player, id, stat, value);
1482 lua_pushboolean(L, true);
1486 // hud_get(self, id)
1487 int ObjectRef::l_hud_get(lua_State *L)
1489 NO_MAP_LOCK_REQUIRED;
1490 ObjectRef *ref = checkobject(L, 1);
1491 RemotePlayer *player = getplayer(ref);
1495 u32 id = lua_tonumber(L, -1);
1497 HudElement *e = player->getHud(id);
1500 push_hud_element(L, e);
1504 // hud_set_flags(self, flags)
1505 int ObjectRef::l_hud_set_flags(lua_State *L)
1507 NO_MAP_LOCK_REQUIRED;
1508 ObjectRef *ref = checkobject(L, 1);
1509 RemotePlayer *player = getplayer(ref);
1517 const EnumString *esp = es_HudBuiltinElement;
1518 for (int i = 0; esp[i].str; i++) {
1519 if (getboolfield(L, 2, esp[i].str, flag)) {
1520 flags |= esp[i].num * flag;
1524 if (!getServer(L)->hudSetFlags(player, flags, mask))
1527 lua_pushboolean(L, true);
1531 int ObjectRef::l_hud_get_flags(lua_State *L)
1533 NO_MAP_LOCK_REQUIRED;
1534 ObjectRef *ref = checkobject(L, 1);
1535 RemotePlayer *player = getplayer(ref);
1540 lua_pushboolean(L, player->hud_flags & HUD_FLAG_HOTBAR_VISIBLE);
1541 lua_setfield(L, -2, "hotbar");
1542 lua_pushboolean(L, player->hud_flags & HUD_FLAG_HEALTHBAR_VISIBLE);
1543 lua_setfield(L, -2, "healthbar");
1544 lua_pushboolean(L, player->hud_flags & HUD_FLAG_CROSSHAIR_VISIBLE);
1545 lua_setfield(L, -2, "crosshair");
1546 lua_pushboolean(L, player->hud_flags & HUD_FLAG_WIELDITEM_VISIBLE);
1547 lua_setfield(L, -2, "wielditem");
1548 lua_pushboolean(L, player->hud_flags & HUD_FLAG_BREATHBAR_VISIBLE);
1549 lua_setfield(L, -2, "breathbar");
1550 lua_pushboolean(L, player->hud_flags & HUD_FLAG_MINIMAP_VISIBLE);
1551 lua_setfield(L, -2, "minimap");
1552 lua_pushboolean(L, player->hud_flags & HUD_FLAG_MINIMAP_RADAR_VISIBLE);
1553 lua_setfield(L, -2, "minimap_radar");
1558 // hud_set_hotbar_itemcount(self, hotbar_itemcount)
1559 int ObjectRef::l_hud_set_hotbar_itemcount(lua_State *L)
1561 NO_MAP_LOCK_REQUIRED;
1562 ObjectRef *ref = checkobject(L, 1);
1563 RemotePlayer *player = getplayer(ref);
1567 s32 hotbar_itemcount = lua_tonumber(L, 2);
1569 if (!getServer(L)->hudSetHotbarItemcount(player, hotbar_itemcount))
1572 lua_pushboolean(L, true);
1576 // hud_get_hotbar_itemcount(self)
1577 int ObjectRef::l_hud_get_hotbar_itemcount(lua_State *L)
1579 NO_MAP_LOCK_REQUIRED;
1580 ObjectRef *ref = checkobject(L, 1);
1581 RemotePlayer *player = getplayer(ref);
1585 lua_pushnumber(L, player->getHotbarItemcount());
1589 // hud_set_hotbar_image(self, name)
1590 int ObjectRef::l_hud_set_hotbar_image(lua_State *L)
1592 NO_MAP_LOCK_REQUIRED;
1593 ObjectRef *ref = checkobject(L, 1);
1594 RemotePlayer *player = getplayer(ref);
1598 std::string name = readParam<std::string>(L, 2);
1600 getServer(L)->hudSetHotbarImage(player, name);
1604 // hud_get_hotbar_image(self)
1605 int ObjectRef::l_hud_get_hotbar_image(lua_State *L)
1607 NO_MAP_LOCK_REQUIRED;
1608 ObjectRef *ref = checkobject(L, 1);
1609 RemotePlayer *player = getplayer(ref);
1613 const std::string &name = player->getHotbarImage();
1614 lua_pushlstring(L, name.c_str(), name.size());
1618 // hud_set_hotbar_selected_image(self, name)
1619 int ObjectRef::l_hud_set_hotbar_selected_image(lua_State *L)
1621 NO_MAP_LOCK_REQUIRED;
1622 ObjectRef *ref = checkobject(L, 1);
1623 RemotePlayer *player = getplayer(ref);
1627 std::string name = readParam<std::string>(L, 2);
1629 getServer(L)->hudSetHotbarSelectedImage(player, name);
1633 // hud_get_hotbar_selected_image(self)
1634 int ObjectRef::l_hud_get_hotbar_selected_image(lua_State *L)
1636 NO_MAP_LOCK_REQUIRED;
1637 ObjectRef *ref = checkobject(L, 1);
1638 RemotePlayer *player = getplayer(ref);
1642 const std::string &name = player->getHotbarSelectedImage();
1643 lua_pushlstring(L, name.c_str(), name.size());
1647 // set_sky(self, bgcolor, type, list, clouds = true)
1648 int ObjectRef::l_set_sky(lua_State *L)
1650 NO_MAP_LOCK_REQUIRED;
1651 ObjectRef *ref = checkobject(L, 1);
1652 RemotePlayer *player = getplayer(ref);
1656 video::SColor bgcolor(255,255,255,255);
1657 read_color(L, 2, &bgcolor);
1659 std::string type = luaL_checkstring(L, 3);
1661 std::vector<std::string> params;
1662 if (lua_istable(L, 4)) {
1664 while (lua_next(L, 4) != 0) {
1665 // key at index -2 and value at index -1
1666 if (lua_isstring(L, -1))
1667 params.emplace_back(readParam<std::string>(L, -1));
1669 params.emplace_back("");
1670 // removes value, keeps key for next iteration
1675 if (type == "skybox" && params.size() != 6)
1676 throw LuaError("skybox expects 6 textures");
1679 if (lua_isboolean(L, 5))
1680 clouds = readParam<bool>(L, 5);
1682 getServer(L)->setSky(player, bgcolor, type, params, clouds);
1683 lua_pushboolean(L, true);
1688 int ObjectRef::l_get_sky(lua_State *L)
1690 NO_MAP_LOCK_REQUIRED;
1691 ObjectRef *ref = checkobject(L, 1);
1692 RemotePlayer *player = getplayer(ref);
1695 video::SColor bgcolor(255, 255, 255, 255);
1697 std::vector<std::string> params;
1700 player->getSky(&bgcolor, &type, ¶ms, &clouds);
1701 type = type.empty() ? "regular" : type;
1703 push_ARGB8(L, bgcolor);
1704 lua_pushlstring(L, type.c_str(), type.size());
1707 for (const std::string ¶m : params) {
1708 lua_pushlstring(L, param.c_str(), param.size());
1709 lua_rawseti(L, -2, i++);
1711 lua_pushboolean(L, clouds);
1715 // set_clouds(self, {density=, color=, ambient=, height=, thickness=, speed=})
1716 int ObjectRef::l_set_clouds(lua_State *L)
1718 NO_MAP_LOCK_REQUIRED;
1719 ObjectRef *ref = checkobject(L, 1);
1720 RemotePlayer *player = getplayer(ref);
1723 if (!lua_istable(L, 2))
1726 CloudParams cloud_params = player->getCloudParams();
1728 cloud_params.density = getfloatfield_default(L, 2, "density", cloud_params.density);
1730 lua_getfield(L, 2, "color");
1731 if (!lua_isnil(L, -1))
1732 read_color(L, -1, &cloud_params.color_bright);
1734 lua_getfield(L, 2, "ambient");
1735 if (!lua_isnil(L, -1))
1736 read_color(L, -1, &cloud_params.color_ambient);
1739 cloud_params.height = getfloatfield_default(L, 2, "height", cloud_params.height );
1740 cloud_params.thickness = getfloatfield_default(L, 2, "thickness", cloud_params.thickness);
1742 lua_getfield(L, 2, "speed");
1743 if (lua_istable(L, -1)) {
1745 new_speed.X = getfloatfield_default(L, -1, "x", 0);
1746 new_speed.Y = getfloatfield_default(L, -1, "z", 0);
1747 cloud_params.speed = new_speed;
1751 getServer(L)->setClouds(player, cloud_params);
1752 lua_pushboolean(L, true);
1756 int ObjectRef::l_get_clouds(lua_State *L)
1758 NO_MAP_LOCK_REQUIRED;
1759 ObjectRef *ref = checkobject(L, 1);
1760 RemotePlayer *player = getplayer(ref);
1763 const CloudParams &cloud_params = player->getCloudParams();
1766 lua_pushnumber(L, cloud_params.density);
1767 lua_setfield(L, -2, "density");
1768 push_ARGB8(L, cloud_params.color_bright);
1769 lua_setfield(L, -2, "color");
1770 push_ARGB8(L, cloud_params.color_ambient);
1771 lua_setfield(L, -2, "ambient");
1772 lua_pushnumber(L, cloud_params.height);
1773 lua_setfield(L, -2, "height");
1774 lua_pushnumber(L, cloud_params.thickness);
1775 lua_setfield(L, -2, "thickness");
1777 lua_pushnumber(L, cloud_params.speed.X);
1778 lua_setfield(L, -2, "x");
1779 lua_pushnumber(L, cloud_params.speed.Y);
1780 lua_setfield(L, -2, "y");
1781 lua_setfield(L, -2, "speed");
1787 // override_day_night_ratio(self, brightness=0...1)
1788 int ObjectRef::l_override_day_night_ratio(lua_State *L)
1790 NO_MAP_LOCK_REQUIRED;
1791 ObjectRef *ref = checkobject(L, 1);
1792 RemotePlayer *player = getplayer(ref);
1796 bool do_override = false;
1798 if (!lua_isnil(L, 2)) {
1800 ratio = readParam<float>(L, 2);
1803 if (!getServer(L)->overrideDayNightRatio(player, do_override, ratio))
1806 lua_pushboolean(L, true);
1810 // get_day_night_ratio(self)
1811 int ObjectRef::l_get_day_night_ratio(lua_State *L)
1813 NO_MAP_LOCK_REQUIRED;
1814 ObjectRef *ref = checkobject(L, 1);
1815 RemotePlayer *player = getplayer(ref);
1821 player->getDayNightRatio(&do_override, &ratio);
1824 lua_pushnumber(L, ratio);
1831 ObjectRef::ObjectRef(ServerActiveObject *object):
1834 //infostream<<"ObjectRef created for id="<<m_object->getId()<<std::endl;
1837 // Creates an ObjectRef and leaves it on top of stack
1838 // Not callable from Lua; all references are created on the C side.
1839 void ObjectRef::create(lua_State *L, ServerActiveObject *object)
1841 ObjectRef *o = new ObjectRef(object);
1842 //infostream<<"ObjectRef::create: o="<<o<<std::endl;
1843 *(void **)(lua_newuserdata(L, sizeof(void *))) = o;
1844 luaL_getmetatable(L, className);
1845 lua_setmetatable(L, -2);
1848 void ObjectRef::set_null(lua_State *L)
1850 ObjectRef *o = checkobject(L, -1);
1854 void ObjectRef::Register(lua_State *L)
1857 int methodtable = lua_gettop(L);
1858 luaL_newmetatable(L, className);
1859 int metatable = lua_gettop(L);
1861 lua_pushliteral(L, "__metatable");
1862 lua_pushvalue(L, methodtable);
1863 lua_settable(L, metatable); // hide metatable from Lua getmetatable()
1865 lua_pushliteral(L, "__index");
1866 lua_pushvalue(L, methodtable);
1867 lua_settable(L, metatable);
1869 lua_pushliteral(L, "__gc");
1870 lua_pushcfunction(L, gc_object);
1871 lua_settable(L, metatable);
1873 lua_pop(L, 1); // drop metatable
1875 markAliasDeprecated(methods);
1876 luaL_openlib(L, 0, methods, 0); // fill methodtable
1877 lua_pop(L, 1); // drop methodtable
1879 // Cannot be created from Lua
1880 //lua_register(L, className, create_object);
1883 const char ObjectRef::className[] = "ObjectRef";
1884 luaL_Reg ObjectRef::methods[] = {
1885 // ServerActiveObject
1886 luamethod(ObjectRef, remove),
1887 luamethod_aliased(ObjectRef, get_pos, getpos),
1888 luamethod_aliased(ObjectRef, set_pos, setpos),
1889 luamethod_aliased(ObjectRef, move_to, moveto),
1890 luamethod(ObjectRef, punch),
1891 luamethod(ObjectRef, right_click),
1892 luamethod(ObjectRef, set_hp),
1893 luamethod(ObjectRef, get_hp),
1894 luamethod(ObjectRef, get_inventory),
1895 luamethod(ObjectRef, get_wield_list),
1896 luamethod(ObjectRef, get_wield_index),
1897 luamethod(ObjectRef, get_wielded_item),
1898 luamethod(ObjectRef, set_wielded_item),
1899 luamethod(ObjectRef, set_armor_groups),
1900 luamethod(ObjectRef, get_armor_groups),
1901 luamethod(ObjectRef, set_animation),
1902 luamethod(ObjectRef, get_animation),
1903 luamethod(ObjectRef, set_animation_frame_speed),
1904 luamethod(ObjectRef, set_bone_position),
1905 luamethod(ObjectRef, get_bone_position),
1906 luamethod(ObjectRef, set_attach),
1907 luamethod(ObjectRef, get_attach),
1908 luamethod(ObjectRef, set_detach),
1909 luamethod(ObjectRef, set_properties),
1910 luamethod(ObjectRef, get_properties),
1911 luamethod(ObjectRef, set_nametag_attributes),
1912 luamethod(ObjectRef, get_nametag_attributes),
1913 // LuaEntitySAO-only
1914 luamethod_aliased(ObjectRef, set_velocity, setvelocity),
1915 luamethod(ObjectRef, add_velocity),
1916 luamethod_aliased(ObjectRef, get_velocity, getvelocity),
1917 luamethod_aliased(ObjectRef, set_acceleration, setacceleration),
1918 luamethod_aliased(ObjectRef, get_acceleration, getacceleration),
1919 luamethod_aliased(ObjectRef, set_yaw, setyaw),
1920 luamethod_aliased(ObjectRef, get_yaw, getyaw),
1921 luamethod(ObjectRef, set_rotation),
1922 luamethod(ObjectRef, get_rotation),
1923 luamethod_aliased(ObjectRef, set_texture_mod, settexturemod),
1924 luamethod_aliased(ObjectRef, set_sprite, setsprite),
1925 luamethod(ObjectRef, get_entity_name),
1926 luamethod(ObjectRef, get_luaentity),
1928 luamethod(ObjectRef, is_player),
1929 luamethod(ObjectRef, is_player_connected),
1930 luamethod(ObjectRef, get_player_name),
1931 luamethod(ObjectRef, get_player_velocity),
1932 luamethod(ObjectRef, get_look_dir),
1933 luamethod(ObjectRef, get_look_pitch),
1934 luamethod(ObjectRef, get_look_yaw),
1935 luamethod(ObjectRef, get_look_vertical),
1936 luamethod(ObjectRef, get_look_horizontal),
1937 luamethod(ObjectRef, set_look_horizontal),
1938 luamethod(ObjectRef, set_look_vertical),
1939 luamethod(ObjectRef, set_look_yaw),
1940 luamethod(ObjectRef, set_look_pitch),
1941 luamethod(ObjectRef, get_breath),
1942 luamethod(ObjectRef, set_breath),
1943 luamethod(ObjectRef, get_attribute),
1944 luamethod(ObjectRef, set_attribute),
1945 luamethod(ObjectRef, get_meta),
1946 luamethod(ObjectRef, set_inventory_formspec),
1947 luamethod(ObjectRef, get_inventory_formspec),
1948 luamethod(ObjectRef, set_formspec_prepend),
1949 luamethod(ObjectRef, get_formspec_prepend),
1950 luamethod(ObjectRef, get_player_control),
1951 luamethod(ObjectRef, get_player_control_bits),
1952 luamethod(ObjectRef, set_physics_override),
1953 luamethod(ObjectRef, get_physics_override),
1954 luamethod(ObjectRef, hud_add),
1955 luamethod(ObjectRef, hud_remove),
1956 luamethod(ObjectRef, hud_change),
1957 luamethod(ObjectRef, hud_get),
1958 luamethod(ObjectRef, hud_set_flags),
1959 luamethod(ObjectRef, hud_get_flags),
1960 luamethod(ObjectRef, hud_set_hotbar_itemcount),
1961 luamethod(ObjectRef, hud_get_hotbar_itemcount),
1962 luamethod(ObjectRef, hud_set_hotbar_image),
1963 luamethod(ObjectRef, hud_get_hotbar_image),
1964 luamethod(ObjectRef, hud_set_hotbar_selected_image),
1965 luamethod(ObjectRef, hud_get_hotbar_selected_image),
1966 luamethod(ObjectRef, set_sky),
1967 luamethod(ObjectRef, get_sky),
1968 luamethod(ObjectRef, set_clouds),
1969 luamethod(ObjectRef, get_clouds),
1970 luamethod(ObjectRef, override_day_night_ratio),
1971 luamethod(ObjectRef, get_day_night_ratio),
1972 luamethod(ObjectRef, set_local_animation),
1973 luamethod(ObjectRef, get_local_animation),
1974 luamethod(ObjectRef, set_eye_offset),
1975 luamethod(ObjectRef, get_eye_offset),
1976 luamethod(ObjectRef, send_mapblock),