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 virtual void setYaw(const float yaw) { m_yaw = yaw; }
36 float getYaw() const { return m_yaw; };
37 f32 getRadYaw() const { return m_yaw * core::DEGTORAD; }
39 f32 getRadYawDep() const { return (m_yaw + 90.) * core::DEGTORAD; }
41 s16 getHP() const { return m_hp; }
42 // Use a function, if isDead can be defined by other conditions
43 bool isDead() const { return m_hp == 0; }
45 bool isAttached() const;
46 void setArmorGroups(const ItemGroupList &armor_groups);
47 const ItemGroupList &getArmorGroups();
48 void setAnimation(v2f frame_range, float frame_speed, float frame_blend, bool frame_loop);
49 void getAnimation(v2f *frame_range, float *frame_speed, float *frame_blend, bool *frame_loop);
50 void setAnimationSpeed(float frame_speed);
51 void setBonePosition(const std::string &bone, v3f position, v3f rotation);
52 void getBonePosition(const std::string &bone, v3f *position, v3f *rotation);
53 void setAttachment(int parent_id, const std::string &bone, v3f position, v3f rotation);
54 void getAttachment(int *parent_id, std::string *bone, v3f *position, v3f *rotation);
55 void addAttachmentChild(int child_id);
56 void removeAttachmentChild(int child_id);
57 const std::unordered_set<int> &getAttachmentChildIds();
58 ObjectProperties* accessObjectProperties();
59 void notifyObjectPropertiesModified();
64 bool m_properties_sent = true;
65 struct ObjectProperties m_prop;
67 ItemGroupList m_armor_groups;
68 bool m_armor_groups_sent = false;
70 v2f m_animation_range;
71 float m_animation_speed = 0.0f;
72 float m_animation_blend = 0.0f;
73 bool m_animation_loop = true;
74 bool m_animation_sent = false;
75 bool m_animation_speed_sent = false;
77 // Stores position and rotation for each bone name
78 std::unordered_map<std::string, core::vector2d<v3f>> m_bone_position;
79 bool m_bone_position_sent = false;
81 int m_attachment_parent_id = 0;
82 std::unordered_set<int> m_attachment_child_ids;
83 std::string m_attachment_bone = "";
84 v3f m_attachment_position;
85 v3f m_attachment_rotation;
86 bool m_attachment_sent = false;
90 LuaEntitySAO needs some internals exposed.
93 class LuaEntitySAO : public UnitSAO
96 LuaEntitySAO(ServerEnvironment *env, v3f pos,
97 const std::string &name, const std::string &state);
99 ActiveObjectType getType() const
100 { return ACTIVEOBJECT_TYPE_LUAENTITY; }
101 ActiveObjectType getSendType() const
102 { return ACTIVEOBJECT_TYPE_GENERIC; }
103 virtual void addedToEnvironment(u32 dtime_s);
104 static ServerActiveObject* create(ServerEnvironment *env, v3f pos,
105 const std::string &data);
106 void step(float dtime, bool send_recommended);
107 std::string getClientInitializationData(u16 protocol_version);
108 void getStaticData(std::string *result) const;
110 const ToolCapabilities *toolcap=NULL,
111 ServerActiveObject *puncher=NULL,
112 float time_from_last_punch=1000000);
113 void rightClick(ServerActiveObject *clicker);
114 void setPos(const v3f &pos);
115 void moveTo(v3f pos, bool continuous);
116 float getMinimumSavedMovement();
117 std::string getDescription();
120 /* LuaEntitySAO-specific */
121 void setVelocity(v3f velocity);
123 void setAcceleration(v3f acceleration);
124 v3f getAcceleration();
126 void setTextureMod(const std::string &mod);
127 std::string getTextureMod() const;
128 void setSprite(v2s16 p, int num_frames, float framelength,
129 bool select_horiz_by_yawpitch);
130 std::string getName();
131 bool getCollisionBox(aabb3f *toset) const;
132 bool getSelectionBox(aabb3f *toset) const;
133 bool collideWithObjects() const;
135 std::string getPropertyPacket();
136 void sendPosition(bool do_interpolate, bool is_movement_end);
138 std::string m_init_name;
139 std::string m_init_state;
140 bool m_registered = false;
145 float m_last_sent_yaw = 0.0f;
146 v3f m_last_sent_position;
147 v3f m_last_sent_velocity;
148 float m_last_sent_position_timer = 0.0f;
149 float m_last_sent_move_precision = 0.0f;
150 std::string m_current_texture_modifier = "";
154 PlayerSAO needs some internals exposed.
159 float m_pool = 15.0f;
164 void setMax(float new_max)
171 void add(float dtime)
183 bool grab(float dtime)
187 if(m_pool + dtime > m_max)
194 typedef std::unordered_map<std::string, std::string> PlayerAttributes;
197 class PlayerSAO : public UnitSAO
200 PlayerSAO(ServerEnvironment *env_, RemotePlayer *player_, session_t peer_id_,
201 bool is_singleplayer);
203 ActiveObjectType getType() const
204 { return ACTIVEOBJECT_TYPE_PLAYER; }
205 ActiveObjectType getSendType() const
206 { return ACTIVEOBJECT_TYPE_GENERIC; }
207 std::string getDescription();
210 Active object <-> environment interface
213 void addedToEnvironment(u32 dtime_s);
214 void removingFromEnvironment();
215 bool isStaticAllowed() const { return false; }
216 std::string getClientInitializationData(u16 protocol_version);
217 void getStaticData(std::string *result) const;
218 void step(float dtime, bool send_recommended);
219 void setBasePosition(const v3f &position);
220 void setPos(const v3f &pos);
221 void moveTo(v3f pos, bool continuous);
222 void setYaw(const float yaw);
223 // Data should not be sent at player initialization
224 void setYawAndSend(const float yaw);
225 void setPitch(const float pitch);
226 // Data should not be sent at player initialization
227 void setPitchAndSend(const float pitch);
228 f32 getPitch() const { return m_pitch; }
229 f32 getRadPitch() const { return m_pitch * core::DEGTORAD; }
231 f32 getRadPitchDep() const { return -1.0 * m_pitch * core::DEGTORAD; }
232 void setFov(const float pitch);
233 f32 getFov() const { return m_fov; }
234 void setWantedRange(const s16 range);
235 s16 getWantedRange() const { return m_wanted_range; }
238 Interaction interface
242 const ToolCapabilities *toolcap,
243 ServerActiveObject *puncher,
244 float time_from_last_punch);
245 void rightClick(ServerActiveObject *clicker) {}
247 void setHPRaw(s16 hp) { m_hp = hp; }
249 u16 getBreath() const { return m_breath; }
250 void setBreath(const u16 breath, bool send = true);
256 Inventory* getInventory();
257 const Inventory* getInventory() const;
258 InventoryLocation getInventoryLocation() const;
259 std::string getWieldList() const;
260 ItemStack getWieldedItem() const;
261 ItemStack getWieldedItemOrHand() const;
262 bool setWieldedItem(const ItemStack &item);
263 int getWieldIndex() const;
264 void setWieldIndex(int i);
269 inline void setExtendedAttribute(const std::string &attr, const std::string &value)
271 m_extra_attributes[attr] = value;
272 m_extended_attributes_modified = true;
275 inline bool getExtendedAttribute(const std::string &attr, std::string *value)
277 if (m_extra_attributes.find(attr) == m_extra_attributes.end())
280 *value = m_extra_attributes[attr];
284 inline void removeExtendedAttribute(const std::string &attr)
286 PlayerAttributes::iterator it = m_extra_attributes.find(attr);
287 if (it == m_extra_attributes.end())
290 m_extra_attributes.erase(it);
291 m_extended_attributes_modified = true;
294 inline const PlayerAttributes &getExtendedAttributes()
296 return m_extra_attributes;
299 inline bool extendedAttributesModified() const
301 return m_extended_attributes_modified;
304 inline void setExtendedAttributeModified(bool v)
306 m_extended_attributes_modified = v;
315 RemotePlayer *getPlayer() { return m_player; }
316 session_t getPeerID() const { return m_peer_id; }
320 v3f getLastGoodPosition() const
322 return m_last_good_position;
324 float resetTimeFromLastPunch()
326 float r = m_time_from_last_punch;
327 m_time_from_last_punch = 0.0;
330 void noCheatDigStart(const v3s16 &p)
332 m_nocheat_dig_pos = p;
333 m_nocheat_dig_time = 0;
335 v3s16 getNoCheatDigPos()
337 return m_nocheat_dig_pos;
339 float getNoCheatDigTime()
341 return m_nocheat_dig_time;
345 m_nocheat_dig_pos = v3s16(32767, 32767, 32767);
347 LagPool& getDigPool()
351 // Returns true if cheated
352 bool checkMovementCheat();
356 void updatePrivileges(const std::set<std::string> &privs,
357 bool is_singleplayer)
360 m_is_singleplayer = is_singleplayer;
363 bool getCollisionBox(aabb3f *toset) const;
364 bool getSelectionBox(aabb3f *toset) const;
365 bool collideWithObjects() const { return true; }
367 void finalize(RemotePlayer *player, const std::set<std::string> &privs);
369 v3f getEyePosition() const { return m_base_position + getEyeOffset(); }
370 v3f getEyeOffset() const;
373 std::string getPropertyPacket();
374 void unlinkPlayerSessionAndSave();
376 RemotePlayer *m_player = nullptr;
377 session_t m_peer_id = 0;
378 Inventory *m_inventory = nullptr;
384 v3f m_last_good_position;
385 float m_time_from_last_teleport = 0.0f;
386 float m_time_from_last_punch = 0.0f;
387 v3s16 m_nocheat_dig_pos = v3s16(32767, 32767, 32767);
388 float m_nocheat_dig_time = 0.0f;
391 IntervalLimiter m_breathing_interval;
392 IntervalLimiter m_drowning_interval;
393 IntervalLimiter m_node_hurt_interval;
395 int m_wield_index = 0;
396 bool m_position_not_sent = false;
398 // Cached privileges for enforcement
399 std::set<std::string> m_privs;
400 bool m_is_singleplayer;
402 u16 m_breath = PLAYER_MAX_BREATH_DEFAULT;
405 s16 m_wanted_range = 0.0f;
407 PlayerAttributes m_extra_attributes;
408 bool m_extended_attributes_modified = false;
410 float m_physics_override_speed = 1.0f;
411 float m_physics_override_jump = 1.0f;
412 float m_physics_override_gravity = 1.0f;
413 bool m_physics_override_sneak = true;
414 bool m_physics_override_sneak_glitch = false;
415 bool m_physics_override_new_move = true;
416 bool m_physics_override_sent = false;