3 Copyright (C) 2010-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.
22 #include "network/networkprotocol.h"
23 #include "util/numeric.h"
24 #include "serverobject.h"
25 #include "itemgroup.h"
26 #include "object_properties.h"
27 #include "constants.h"
29 class UnitSAO: public ServerActiveObject
32 UnitSAO(ServerEnvironment *env, v3f pos);
33 virtual ~UnitSAO() = default;
35 void setRotation(v3f rotation) { m_rotation = rotation; }
36 const v3f &getRotation() const { return m_rotation; }
37 v3f getRadRotation() { return m_rotation * core::DEGTORAD; }
40 f32 getRadYawDep() const { return (m_rotation.Y + 90.) * core::DEGTORAD; }
42 u16 getHP() const { return m_hp; }
43 // Use a function, if isDead can be defined by other conditions
44 bool isDead() const { return m_hp == 0; }
46 inline bool isAttached() const
47 { return getParent(); }
49 inline bool isImmortal() const
50 { return itemgroup_get(getArmorGroups(), "immortal"); }
52 void setArmorGroups(const ItemGroupList &armor_groups);
53 const ItemGroupList &getArmorGroups() const;
54 void setAnimation(v2f frame_range, float frame_speed, float frame_blend, bool frame_loop);
55 void getAnimation(v2f *frame_range, float *frame_speed, float *frame_blend, bool *frame_loop);
56 void setAnimationSpeed(float frame_speed);
57 void setBonePosition(const std::string &bone, v3f position, v3f rotation);
58 void getBonePosition(const std::string &bone, v3f *position, v3f *rotation);
59 void setAttachment(int parent_id, const std::string &bone, v3f position, v3f rotation);
60 void getAttachment(int *parent_id, std::string *bone, v3f *position,
62 void clearChildAttachments();
63 void clearParentAttachment();
64 void addAttachmentChild(int child_id);
65 void removeAttachmentChild(int child_id);
66 const std::unordered_set<int> &getAttachmentChildIds() const;
67 ServerActiveObject *getParent() const;
68 ObjectProperties* accessObjectProperties();
69 void notifyObjectPropertiesModified();
75 bool m_properties_sent = true;
76 ObjectProperties m_prop;
78 ItemGroupList m_armor_groups;
79 bool m_armor_groups_sent = false;
81 v2f m_animation_range;
82 float m_animation_speed = 0.0f;
83 float m_animation_blend = 0.0f;
84 bool m_animation_loop = true;
85 bool m_animation_sent = false;
86 bool m_animation_speed_sent = false;
88 // Stores position and rotation for each bone name
89 std::unordered_map<std::string, core::vector2d<v3f>> m_bone_position;
90 bool m_bone_position_sent = false;
92 int m_attachment_parent_id = 0;
93 std::unordered_set<int> m_attachment_child_ids;
94 std::string m_attachment_bone = "";
95 v3f m_attachment_position;
96 v3f m_attachment_rotation;
97 bool m_attachment_sent = false;
99 void onAttach(int parent_id);
100 void onDetach(int parent_id);
104 LuaEntitySAO needs some internals exposed.
107 class LuaEntitySAO : public UnitSAO
110 LuaEntitySAO(ServerEnvironment *env, v3f pos,
111 const std::string &name, const std::string &state);
113 ActiveObjectType getType() const
114 { return ACTIVEOBJECT_TYPE_LUAENTITY; }
115 ActiveObjectType getSendType() const
116 { return ACTIVEOBJECT_TYPE_GENERIC; }
117 virtual void addedToEnvironment(u32 dtime_s);
118 static ServerActiveObject* create(ServerEnvironment *env, v3f pos,
119 const std::string &data);
120 void step(float dtime, bool send_recommended);
121 std::string getClientInitializationData(u16 protocol_version);
122 bool isStaticAllowed() const
123 { return m_prop.static_save; }
124 void getStaticData(std::string *result) const;
126 const ToolCapabilities *toolcap = nullptr,
127 ServerActiveObject *puncher = nullptr,
128 float time_from_last_punch = 1000000.0f);
129 void rightClick(ServerActiveObject *clicker);
130 void setPos(const v3f &pos);
131 void moveTo(v3f pos, bool continuous);
132 float getMinimumSavedMovement();
133 std::string getDescription();
134 void setHP(s32 hp, const PlayerHPChangeReason &reason);
137 /* LuaEntitySAO-specific */
138 void setVelocity(v3f velocity);
139 void addVelocity(v3f velocity)
141 m_velocity += velocity;
144 void setAcceleration(v3f acceleration);
145 v3f getAcceleration();
147 void setTextureMod(const std::string &mod);
148 std::string getTextureMod() const;
149 void setSprite(v2s16 p, int num_frames, float framelength,
150 bool select_horiz_by_yawpitch);
151 std::string getName();
152 bool getCollisionBox(aabb3f *toset) const;
153 bool getSelectionBox(aabb3f *toset) const;
154 bool collideWithObjects() const;
156 std::string getPropertyPacket();
157 void sendPosition(bool do_interpolate, bool is_movement_end);
159 std::string m_init_name;
160 std::string m_init_state;
161 bool m_registered = false;
166 v3f m_last_sent_position;
167 v3f m_last_sent_velocity;
168 v3f m_last_sent_rotation;
169 float m_last_sent_position_timer = 0.0f;
170 float m_last_sent_move_precision = 0.0f;
171 std::string m_current_texture_modifier = "";
175 PlayerSAO needs some internals exposed.
180 float m_pool = 15.0f;
185 void setMax(float new_max)
192 void add(float dtime)
204 bool grab(float dtime)
208 if(m_pool + dtime > m_max)
217 class PlayerSAO : public UnitSAO
220 PlayerSAO(ServerEnvironment *env_, RemotePlayer *player_, session_t peer_id_,
221 bool is_singleplayer);
223 ActiveObjectType getType() const
224 { return ACTIVEOBJECT_TYPE_PLAYER; }
225 ActiveObjectType getSendType() const
226 { return ACTIVEOBJECT_TYPE_GENERIC; }
227 std::string getDescription();
230 Active object <-> environment interface
233 void addedToEnvironment(u32 dtime_s);
234 void removingFromEnvironment();
235 bool isStaticAllowed() const { return false; }
236 std::string getClientInitializationData(u16 protocol_version);
237 void getStaticData(std::string *result) const;
238 void step(float dtime, bool send_recommended);
239 void setBasePosition(const v3f &position);
240 void setPos(const v3f &pos);
241 void moveTo(v3f pos, bool continuous);
242 void setPlayerYaw(const float yaw);
243 // Data should not be sent at player initialization
244 void setPlayerYawAndSend(const float yaw);
245 void setLookPitch(const float pitch);
246 // Data should not be sent at player initialization
247 void setLookPitchAndSend(const float pitch);
248 f32 getLookPitch() const { return m_pitch; }
249 f32 getRadLookPitch() const { return m_pitch * core::DEGTORAD; }
251 f32 getRadLookPitchDep() const { return -1.0 * m_pitch * core::DEGTORAD; }
252 void setFov(const float pitch);
253 f32 getFov() const { return m_fov; }
254 void setWantedRange(const s16 range);
255 s16 getWantedRange() const { return m_wanted_range; }
258 Interaction interface
262 const ToolCapabilities *toolcap,
263 ServerActiveObject *puncher,
264 float time_from_last_punch);
265 void rightClick(ServerActiveObject *clicker) {}
266 void setHP(s32 hp, const PlayerHPChangeReason &reason);
267 void setHPRaw(u16 hp) { m_hp = hp; }
269 u16 getBreath() const { return m_breath; }
270 void setBreath(const u16 breath, bool send = true);
275 Inventory *getInventory() const;
276 InventoryLocation getInventoryLocation() const;
277 void setInventoryModified() {}
278 std::string getWieldList() const { return "main"; }
279 u16 getWieldIndex() const;
280 ItemStack getWieldedItem(ItemStack *selected, ItemStack *hand = nullptr) const;
281 bool setWieldedItem(const ItemStack &item);
289 RemotePlayer *getPlayer() { return m_player; }
290 session_t getPeerID() const { return m_peer_id; }
294 v3f getLastGoodPosition() const
296 return m_last_good_position;
298 float resetTimeFromLastPunch()
300 float r = m_time_from_last_punch;
301 m_time_from_last_punch = 0.0;
304 void noCheatDigStart(const v3s16 &p)
306 m_nocheat_dig_pos = p;
307 m_nocheat_dig_time = 0;
309 v3s16 getNoCheatDigPos()
311 return m_nocheat_dig_pos;
313 float getNoCheatDigTime()
315 return m_nocheat_dig_time;
319 m_nocheat_dig_pos = v3s16(32767, 32767, 32767);
321 LagPool& getDigPool()
325 void setMaxSpeedOverride(const v3f &vel);
326 // Returns true if cheated
327 bool checkMovementCheat();
331 void updatePrivileges(const std::set<std::string> &privs,
332 bool is_singleplayer)
335 m_is_singleplayer = is_singleplayer;
338 bool getCollisionBox(aabb3f *toset) const;
339 bool getSelectionBox(aabb3f *toset) const;
340 bool collideWithObjects() const { return true; }
342 void finalize(RemotePlayer *player, const std::set<std::string> &privs);
344 v3f getEyePosition() const { return m_base_position + getEyeOffset(); }
345 v3f getEyeOffset() const;
346 float getZoomFOV() const;
348 inline Metadata &getMeta() { return m_meta; }
351 std::string getPropertyPacket();
352 void unlinkPlayerSessionAndSave();
354 RemotePlayer *m_player = nullptr;
355 session_t m_peer_id = 0;
360 v3f m_last_good_position;
361 float m_time_from_last_teleport = 0.0f;
362 float m_time_from_last_punch = 0.0f;
363 v3s16 m_nocheat_dig_pos = v3s16(32767, 32767, 32767);
364 float m_nocheat_dig_time = 0.0f;
365 float m_max_speed_override_time = 0.0f;
366 v3f m_max_speed_override = v3f(0.0f, 0.0f, 0.0f);
369 IntervalLimiter m_breathing_interval;
370 IntervalLimiter m_drowning_interval;
371 IntervalLimiter m_node_hurt_interval;
373 bool m_position_not_sent = false;
375 // Cached privileges for enforcement
376 std::set<std::string> m_privs;
377 bool m_is_singleplayer;
379 u16 m_breath = PLAYER_MAX_BREATH_DEFAULT;
382 s16 m_wanted_range = 0.0f;
386 float m_physics_override_speed = 1.0f;
387 float m_physics_override_jump = 1.0f;
388 float m_physics_override_gravity = 1.0f;
389 bool m_physics_override_sneak = true;
390 bool m_physics_override_sneak_glitch = false;
391 bool m_physics_override_new_move = true;
392 bool m_physics_override_sent = false;
396 struct PlayerHPChangeReason {
407 bool from_mod = false;
408 int lua_reference = -1;
411 ServerActiveObject *object = nullptr;
415 inline bool hasLuaReference() const
417 return lua_reference >= 0;
420 bool setTypeFromString(const std::string &typestr)
422 if (typestr == "set_hp")
424 else if (typestr == "punch")
426 else if (typestr == "fall")
428 else if (typestr == "node_damage")
430 else if (typestr == "drown")
432 else if (typestr == "respawn")
440 std::string getTypeAsString() const
443 case PlayerHPChangeReason::SET_HP:
445 case PlayerHPChangeReason::PLAYER_PUNCH:
447 case PlayerHPChangeReason::FALL:
449 case PlayerHPChangeReason::NODE_DAMAGE:
450 return "node_damage";
451 case PlayerHPChangeReason::DROWNING:
453 case PlayerHPChangeReason::RESPAWN:
460 PlayerHPChangeReason(Type type):
464 PlayerHPChangeReason(Type type, ServerActiveObject *object):
465 type(type), object(object)
468 PlayerHPChangeReason(Type type, std::string node):
469 type(type), node(node)