3 Copyright (C) 2010-2013 celeron55, Perttu Ahola <celeron55@gmail.com>
4 Copyright (C) 2013-2020 Minetest core developers & community
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU Lesser General Public License as published by
8 the Free Software Foundation; either version 2.1 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU Lesser General Public License for more details.
16 You should have received a copy of the GNU Lesser General Public License along
17 with this program; if not, write to the Free Software Foundation, Inc.,
18 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
21 #include "luaentity_sao.h"
22 #include "collision.h"
23 #include "constants.h"
24 #include "player_sao.h"
25 #include "scripting_server.h"
27 #include "serverenvironment.h"
29 LuaEntitySAO::LuaEntitySAO(ServerEnvironment *env, v3f pos, const std::string &data)
38 while (!data.empty()) { // breakable, run for one iteration
39 std::istringstream is(data, std::ios::binary);
40 // 'version' does not allow to incrementally extend the parameter list thus
41 // we need another variable to build on top of 'version=1'. Ugly hack but works™
43 u8 version = readU8(is);
45 name = deSerializeString(is);
46 state = deSerializeLongString(is);
52 velocity = readV3F1000(is);
53 // yaw must be yaw to be backwards-compatible
54 rotation.Y = readF1000(is);
56 if (is.good()) // EOF for old formats
57 version2 = readU8(is);
59 if (version2 < 1) // PROTOCOL_VERSION < 37
63 rotation.X = readF1000(is);
64 rotation.Z = readF1000(is);
72 infostream << "LuaEntitySAO::create(name=\"" << name << "\" state=\""
73 << state << "\")" << std::endl;
78 m_velocity = velocity;
79 m_rotation = rotation;
82 LuaEntitySAO::~LuaEntitySAO()
85 m_env->getScriptIface()->luaentity_Remove(m_id);
88 for (u32 attached_particle_spawner : m_attached_particle_spawners) {
89 m_env->deleteParticleSpawner(attached_particle_spawner, false);
93 void LuaEntitySAO::addedToEnvironment(u32 dtime_s)
95 ServerActiveObject::addedToEnvironment(dtime_s);
97 // Create entity from name
98 m_registered = m_env->getScriptIface()->
99 luaentity_Add(m_id, m_init_name.c_str());
103 m_env->getScriptIface()->
104 luaentity_GetProperties(m_id, this, &m_prop);
105 // Initialize HP from properties
106 m_hp = m_prop.hp_max;
107 // Activate entity, supplying serialized state
108 m_env->getScriptIface()->
109 luaentity_Activate(m_id, m_init_state, dtime_s);
111 m_prop.infotext = m_init_name;
115 void LuaEntitySAO::step(float dtime, bool send_recommended)
117 if(!m_properties_sent)
119 m_properties_sent = true;
120 std::string str = getPropertyPacket();
121 // create message and add to list
122 m_messages_out.emplace(getId(), true, str);
125 // If attached, check that our parent is still there. If it isn't, detach.
126 if (m_attachment_parent_id && !isAttached()) {
127 // This is handled when objects are removed from the map
128 warningstream << "LuaEntitySAO::step() id=" << m_id <<
129 " is attached to nonexistent parent. This is a bug." << std::endl;
130 clearParentAttachment();
131 sendPosition(false, true);
134 m_last_sent_position_timer += dtime;
136 collisionMoveResult moveresult, *moveresult_p = nullptr;
138 // Each frame, parent position is copied if the object is attached, otherwise it's calculated normally
139 // If the object gets detached this comes into effect automatically from the last known origin
142 v3f pos = m_env->getActiveObject(m_attachment_parent_id)->getBasePosition();
143 m_base_position = pos;
144 m_velocity = v3f(0,0,0);
145 m_acceleration = v3f(0,0,0);
150 aabb3f box = m_prop.collisionbox;
153 f32 pos_max_d = BS*0.25; // Distance per iteration
154 v3f p_pos = m_base_position;
155 v3f p_velocity = m_velocity;
156 v3f p_acceleration = m_acceleration;
157 moveresult = collisionMoveSimple(m_env, m_env->getGameDef(),
158 pos_max_d, box, m_prop.stepheight, dtime,
159 &p_pos, &p_velocity, p_acceleration,
160 this, m_prop.collideWithObjects);
161 moveresult_p = &moveresult;
164 m_base_position = p_pos;
165 m_velocity = p_velocity;
166 m_acceleration = p_acceleration;
168 m_base_position += dtime * m_velocity + 0.5 * dtime
169 * dtime * m_acceleration;
170 m_velocity += dtime * m_acceleration;
173 if (m_prop.automatic_face_movement_dir &&
174 (fabs(m_velocity.Z) > 0.001 || fabs(m_velocity.X) > 0.001)) {
175 float target_yaw = atan2(m_velocity.Z, m_velocity.X) * 180 / M_PI
176 + m_prop.automatic_face_movement_dir_offset;
177 float max_rotation_per_sec =
178 m_prop.automatic_face_movement_max_rotation_per_sec;
180 if (max_rotation_per_sec > 0) {
181 m_rotation.Y = wrapDegrees_0_360(m_rotation.Y);
182 wrappedApproachShortest(m_rotation.Y, target_yaw,
183 dtime * max_rotation_per_sec, 360.f);
185 // Negative values of max_rotation_per_sec mean disabled.
186 m_rotation.Y = target_yaw;
192 m_env->getScriptIface()->luaentity_Step(m_id, dtime, moveresult_p);
195 if (!send_recommended)
200 // TODO: force send when acceleration changes enough?
201 float minchange = 0.2*BS;
202 if(m_last_sent_position_timer > 1.0){
204 } else if(m_last_sent_position_timer > 0.2){
207 float move_d = m_base_position.getDistanceFrom(m_last_sent_position);
208 move_d += m_last_sent_move_precision;
209 float vel_d = m_velocity.getDistanceFrom(m_last_sent_velocity);
210 if (move_d > minchange || vel_d > minchange ||
211 std::fabs(m_rotation.X - m_last_sent_rotation.X) > 1.0f ||
212 std::fabs(m_rotation.Y - m_last_sent_rotation.Y) > 1.0f ||
213 std::fabs(m_rotation.Z - m_last_sent_rotation.Z) > 1.0f) {
215 sendPosition(true, false);
222 std::string LuaEntitySAO::getClientInitializationData(u16 protocol_version)
224 std::ostringstream os(std::ios::binary);
226 // PROTOCOL_VERSION >= 37
227 writeU8(os, 1); // version
228 os << serializeString(""); // name
229 writeU8(os, 0); // is_player
230 writeU16(os, getId()); //id
231 writeV3F32(os, m_base_position);
232 writeV3F32(os, m_rotation);
235 std::ostringstream msg_os(std::ios::binary);
236 msg_os << serializeLongString(getPropertyPacket()); // message 1
237 msg_os << serializeLongString(generateUpdateArmorGroupsCommand()); // 2
238 msg_os << serializeLongString(generateUpdateAnimationCommand()); // 3
239 for (const auto &bone_pos : m_bone_position) {
240 msg_os << serializeLongString(generateUpdateBonePositionCommand(
241 bone_pos.first, bone_pos.second.X, bone_pos.second.Y)); // m_bone_position.size
243 msg_os << serializeLongString(generateUpdateAttachmentCommand()); // 4
245 int message_count = 4 + m_bone_position.size();
247 for (const auto &id : getAttachmentChildIds()) {
248 if (ServerActiveObject *obj = m_env->getActiveObject(id)) {
250 msg_os << serializeLongString(obj->generateUpdateInfantCommand(
251 id, protocol_version));
255 msg_os << serializeLongString(generateSetTextureModCommand());
258 writeU8(os, message_count);
259 std::string serialized = msg_os.str();
260 os.write(serialized.c_str(), serialized.size());
266 void LuaEntitySAO::getStaticData(std::string *result) const
268 verbosestream<<FUNCTION_NAME<<std::endl;
269 std::ostringstream os(std::ios::binary);
270 // version must be 1 to keep backwards-compatibility. See version2
273 os<<serializeString(m_init_name);
276 std::string state = m_env->getScriptIface()->
277 luaentity_GetStaticdata(m_id);
278 os<<serializeLongString(state);
280 os<<serializeLongString(m_init_state);
283 writeV3F1000(os, m_velocity);
285 writeF1000(os, m_rotation.Y);
287 // version2. Increase this variable for new values
288 writeU8(os, 1); // PROTOCOL_VERSION >= 37
290 writeF1000(os, m_rotation.X);
291 writeF1000(os, m_rotation.Z);
293 // <write new values>
298 u16 LuaEntitySAO::punch(v3f dir,
299 const ToolCapabilities *toolcap,
300 ServerActiveObject *puncher,
301 float time_from_last_punch)
304 // Delete unknown LuaEntities when punched
305 m_pending_removal = true;
309 FATAL_ERROR_IF(!puncher, "Punch action called without SAO");
311 s32 old_hp = getHP();
312 ItemStack selected_item, hand_item;
313 ItemStack tool_item = puncher->getWieldedItem(&selected_item, &hand_item);
315 PunchDamageResult result = getPunchDamage(
319 time_from_last_punch);
321 bool damage_handled = m_env->getScriptIface()->luaentity_Punch(m_id, puncher,
322 time_from_last_punch, toolcap, dir, result.did_punch ? result.damage : 0);
324 if (!damage_handled) {
325 if (result.did_punch) {
326 setHP((s32)getHP() - result.damage,
327 PlayerHPChangeReason(PlayerHPChangeReason::PLAYER_PUNCH, puncher));
329 // create message and add to list
334 if (getHP() == 0 && !isGone()) {
335 clearParentAttachment();
336 clearChildAttachments();
337 m_env->getScriptIface()->luaentity_on_death(m_id, puncher);
338 m_pending_removal = true;
341 actionstream << puncher->getDescription() << " (id=" << puncher->getId() <<
342 ", hp=" << puncher->getHP() << ") punched " <<
343 getDescription() << " (id=" << m_id << ", hp=" << m_hp <<
344 "), damage=" << (old_hp - (s32)getHP()) <<
345 (damage_handled ? " (handled by Lua)" : "") << std::endl;
347 // TODO: give Lua control over wear
351 void LuaEntitySAO::rightClick(ServerActiveObject *clicker)
356 m_env->getScriptIface()->luaentity_Rightclick(m_id, clicker);
359 void LuaEntitySAO::setPos(const v3f &pos)
363 m_base_position = pos;
364 sendPosition(false, true);
367 void LuaEntitySAO::moveTo(v3f pos, bool continuous)
371 m_base_position = pos;
373 sendPosition(true, true);
376 float LuaEntitySAO::getMinimumSavedMovement()
381 std::string LuaEntitySAO::getDescription()
383 std::ostringstream oss;
384 oss << "LuaEntitySAO \"" << m_init_name << "\" ";
385 auto pos = floatToInt(m_base_position, BS);
386 oss << "at " << PP(pos);
390 void LuaEntitySAO::setHP(s32 hp, const PlayerHPChangeReason &reason)
392 m_hp = rangelim(hp, 0, U16_MAX);
395 u16 LuaEntitySAO::getHP() const
400 void LuaEntitySAO::setVelocity(v3f velocity)
402 m_velocity = velocity;
405 v3f LuaEntitySAO::getVelocity()
410 void LuaEntitySAO::setAcceleration(v3f acceleration)
412 m_acceleration = acceleration;
415 v3f LuaEntitySAO::getAcceleration()
417 return m_acceleration;
420 void LuaEntitySAO::setTextureMod(const std::string &mod)
422 m_current_texture_modifier = mod;
423 // create message and add to list
424 m_messages_out.emplace(getId(), true, generateSetTextureModCommand());
427 std::string LuaEntitySAO::getTextureMod() const
429 return m_current_texture_modifier;
433 std::string LuaEntitySAO::generateSetTextureModCommand() const
435 std::ostringstream os(std::ios::binary);
437 writeU8(os, AO_CMD_SET_TEXTURE_MOD);
439 os << serializeString(m_current_texture_modifier);
443 std::string LuaEntitySAO::generateSetSpriteCommand(v2s16 p, u16 num_frames,
444 f32 framelength, bool select_horiz_by_yawpitch)
446 std::ostringstream os(std::ios::binary);
448 writeU8(os, AO_CMD_SET_SPRITE);
451 writeU16(os, num_frames);
452 writeF32(os, framelength);
453 writeU8(os, select_horiz_by_yawpitch);
457 void LuaEntitySAO::setSprite(v2s16 p, int num_frames, float framelength,
458 bool select_horiz_by_yawpitch)
460 std::string str = generateSetSpriteCommand(
464 select_horiz_by_yawpitch
466 // create message and add to list
467 m_messages_out.emplace(getId(), true, str);
470 std::string LuaEntitySAO::getName()
475 std::string LuaEntitySAO::getPropertyPacket()
477 return generateSetPropertiesCommand(m_prop);
480 void LuaEntitySAO::sendPosition(bool do_interpolate, bool is_movement_end)
482 // If the object is attached client-side, don't waste bandwidth sending its position to clients
486 m_last_sent_move_precision = m_base_position.getDistanceFrom(
487 m_last_sent_position);
488 m_last_sent_position_timer = 0;
489 m_last_sent_position = m_base_position;
490 m_last_sent_velocity = m_velocity;
491 //m_last_sent_acceleration = m_acceleration;
492 m_last_sent_rotation = m_rotation;
494 float update_interval = m_env->getSendRecommendedInterval();
496 std::string str = generateUpdatePositionCommand(
505 // create message and add to list
506 m_messages_out.emplace(getId(), false, str);
509 bool LuaEntitySAO::getCollisionBox(aabb3f *toset) const
513 //update collision box
514 toset->MinEdge = m_prop.collisionbox.MinEdge * BS;
515 toset->MaxEdge = m_prop.collisionbox.MaxEdge * BS;
517 toset->MinEdge += m_base_position;
518 toset->MaxEdge += m_base_position;
526 bool LuaEntitySAO::getSelectionBox(aabb3f *toset) const
528 if (!m_prop.is_visible || !m_prop.pointable) {
532 toset->MinEdge = m_prop.selectionbox.MinEdge * BS;
533 toset->MaxEdge = m_prop.selectionbox.MaxEdge * BS;
538 bool LuaEntitySAO::collideWithObjects() const
540 return m_prop.collideWithObjects;