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.
20 #ifndef CONTENT_SAO_HEADER
21 #define CONTENT_SAO_HEADER
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);
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 setBonePosition(const std::string &bone, v3f position, v3f rotation);
51 void getBonePosition(const std::string &bone, v3f *position, v3f *rotation);
52 void setAttachment(int parent_id, const std::string &bone, v3f position, v3f rotation);
53 void getAttachment(int *parent_id, std::string *bone, v3f *position, v3f *rotation);
54 void addAttachmentChild(int child_id);
55 void removeAttachmentChild(int child_id);
56 const std::unordered_set<int> &getAttachmentChildIds();
57 ObjectProperties* accessObjectProperties();
58 void notifyObjectPropertiesModified();
63 bool m_properties_sent = true;
64 struct ObjectProperties m_prop;
66 ItemGroupList m_armor_groups;
67 bool m_armor_groups_sent = false;
69 v2f m_animation_range;
70 float m_animation_speed = 0.0f;
71 float m_animation_blend = 0.0f;
72 bool m_animation_loop = true;
73 bool m_animation_sent = false;
75 // Stores position and rotation for each bone name
76 std::unordered_map<std::string, core::vector2d<v3f>> m_bone_position;
77 bool m_bone_position_sent = false;
79 int m_attachment_parent_id = 0;
80 std::unordered_set<int> m_attachment_child_ids;
81 std::string m_attachment_bone = "";
82 v3f m_attachment_position;
83 v3f m_attachment_rotation;
84 bool m_attachment_sent = false;
88 LuaEntitySAO needs some internals exposed.
91 class LuaEntitySAO : public UnitSAO
94 LuaEntitySAO(ServerEnvironment *env, v3f pos,
95 const std::string &name, const std::string &state);
97 ActiveObjectType getType() const
98 { return ACTIVEOBJECT_TYPE_LUAENTITY; }
99 ActiveObjectType getSendType() const
100 { return ACTIVEOBJECT_TYPE_GENERIC; }
101 virtual void addedToEnvironment(u32 dtime_s);
102 static ServerActiveObject* create(ServerEnvironment *env, v3f pos,
103 const std::string &data);
104 void step(float dtime, bool send_recommended);
105 std::string getClientInitializationData(u16 protocol_version);
106 void getStaticData(std::string *result) const;
108 const ToolCapabilities *toolcap=NULL,
109 ServerActiveObject *puncher=NULL,
110 float time_from_last_punch=1000000);
111 void rightClick(ServerActiveObject *clicker);
112 void setPos(const v3f &pos);
113 void moveTo(v3f pos, bool continuous);
114 float getMinimumSavedMovement();
115 std::string getDescription();
118 /* LuaEntitySAO-specific */
119 void setVelocity(v3f velocity);
121 void setAcceleration(v3f acceleration);
122 v3f getAcceleration();
124 void setTextureMod(const std::string &mod);
125 std::string getTextureMod() const;
126 void setSprite(v2s16 p, int num_frames, float framelength,
127 bool select_horiz_by_yawpitch);
128 std::string getName();
129 bool getCollisionBox(aabb3f *toset) const;
130 bool getSelectionBox(aabb3f *toset) const;
131 bool collideWithObjects() const;
133 std::string getPropertyPacket();
134 void sendPosition(bool do_interpolate, bool is_movement_end);
136 std::string m_init_name;
137 std::string m_init_state;
138 bool m_registered = false;
143 float m_last_sent_yaw = 0.0f;
144 v3f m_last_sent_position;
145 v3f m_last_sent_velocity;
146 float m_last_sent_position_timer = 0.0f;
147 float m_last_sent_move_precision = 0.0f;
148 std::string m_current_texture_modifier = "";
152 PlayerSAO needs some internals exposed.
157 float m_pool = 15.0f;
162 void setMax(float new_max)
169 void add(float dtime)
181 bool grab(float dtime)
185 if(m_pool + dtime > m_max)
192 typedef std::unordered_map<std::string, std::string> PlayerAttributes;
195 class PlayerSAO : public UnitSAO
198 PlayerSAO(ServerEnvironment *env_, RemotePlayer *player_, u16 peer_id_, bool is_singleplayer);
200 ActiveObjectType getType() const
201 { return ACTIVEOBJECT_TYPE_PLAYER; }
202 ActiveObjectType getSendType() const
203 { return ACTIVEOBJECT_TYPE_GENERIC; }
204 std::string getDescription();
207 Active object <-> environment interface
210 void addedToEnvironment(u32 dtime_s);
211 void removingFromEnvironment();
212 bool isStaticAllowed() const { return false; }
213 std::string getClientInitializationData(u16 protocol_version);
214 void getStaticData(std::string *result) const;
215 void step(float dtime, bool send_recommended);
216 void setBasePosition(const v3f &position);
217 void setPos(const v3f &pos);
218 void moveTo(v3f pos, bool continuous);
219 void setYaw(const float yaw);
220 // Data should not be sent at player initialization
221 void setYawAndSend(const float yaw);
222 void setPitch(const float pitch);
223 // Data should not be sent at player initialization
224 void setPitchAndSend(const float pitch);
225 f32 getPitch() const { return m_pitch; }
226 f32 getRadPitch() const { return m_pitch * core::DEGTORAD; }
228 f32 getRadPitchDep() const { return -1.0 * m_pitch * core::DEGTORAD; }
229 void setFov(const float pitch);
230 f32 getFov() const { return m_fov; }
231 void setWantedRange(const s16 range);
232 s16 getWantedRange() const { return m_wanted_range; }
235 Interaction interface
239 const ToolCapabilities *toolcap,
240 ServerActiveObject *puncher,
241 float time_from_last_punch);
242 void rightClick(ServerActiveObject *clicker) {}
244 void setHPRaw(s16 hp) { m_hp = hp; }
246 u16 getBreath() const { return m_breath; }
247 void setBreath(const u16 breath, bool send = true);
253 Inventory* getInventory();
254 const Inventory* getInventory() const;
255 InventoryLocation getInventoryLocation() const;
256 std::string getWieldList() const;
257 ItemStack getWieldedItem() const;
258 ItemStack getWieldedItemOrHand() const;
259 bool setWieldedItem(const ItemStack &item);
260 int getWieldIndex() const;
261 void setWieldIndex(int i);
266 inline void setExtendedAttribute(const std::string &attr, const std::string &value)
268 m_extra_attributes[attr] = value;
269 m_extended_attributes_modified = true;
272 inline bool getExtendedAttribute(const std::string &attr, std::string *value)
274 if (m_extra_attributes.find(attr) == m_extra_attributes.end())
277 *value = m_extra_attributes[attr];
281 inline void removeExtendedAttribute(const std::string &attr)
283 PlayerAttributes::iterator it = m_extra_attributes.find(attr);
284 if (it == m_extra_attributes.end())
287 m_extra_attributes.erase(it);
288 m_extended_attributes_modified = true;
291 inline const PlayerAttributes &getExtendedAttributes()
293 return m_extra_attributes;
296 inline bool extendedAttributesModified() const
298 return m_extended_attributes_modified;
301 inline void setExtendedAttributeModified(bool v)
303 m_extended_attributes_modified = v;
312 RemotePlayer *getPlayer() { return m_player; }
313 u16 getPeerID() const { return m_peer_id; }
317 v3f getLastGoodPosition() const
319 return m_last_good_position;
321 float resetTimeFromLastPunch()
323 float r = m_time_from_last_punch;
324 m_time_from_last_punch = 0.0;
327 void noCheatDigStart(v3s16 p)
329 m_nocheat_dig_pos = p;
330 m_nocheat_dig_time = 0;
332 v3s16 getNoCheatDigPos()
334 return m_nocheat_dig_pos;
336 float getNoCheatDigTime()
338 return m_nocheat_dig_time;
342 m_nocheat_dig_pos = v3s16(32767, 32767, 32767);
344 LagPool& getDigPool()
348 // Returns true if cheated
349 bool checkMovementCheat();
353 void updatePrivileges(const std::set<std::string> &privs,
354 bool is_singleplayer)
357 m_is_singleplayer = is_singleplayer;
360 bool getCollisionBox(aabb3f *toset) const;
361 bool getSelectionBox(aabb3f *toset) const;
362 bool collideWithObjects() const { return true; }
364 void finalize(RemotePlayer *player, const std::set<std::string> &privs);
366 v3f getEyePosition() const { return m_base_position + getEyeOffset(); }
367 v3f getEyeOffset() const;
370 std::string getPropertyPacket();
371 void unlinkPlayerSessionAndSave();
373 RemotePlayer *m_player = nullptr;
375 Inventory *m_inventory = nullptr;
381 v3f m_last_good_position;
382 float m_time_from_last_teleport = 0.0f;
383 float m_time_from_last_punch = 0.0f;
384 v3s16 m_nocheat_dig_pos = v3s16(32767, 32767, 32767);
385 float m_nocheat_dig_time = 0.0f;
388 IntervalLimiter m_breathing_interval;
389 IntervalLimiter m_drowning_interval;
390 IntervalLimiter m_node_hurt_interval;
392 int m_wield_index = 0;
393 bool m_position_not_sent = false;
395 // Cached privileges for enforcement
396 std::set<std::string> m_privs;
397 bool m_is_singleplayer;
399 u16 m_breath = PLAYER_MAX_BREATH;
402 s16 m_wanted_range = 0.0f;
404 PlayerAttributes m_extra_attributes;
405 bool m_extended_attributes_modified = false;
407 float m_physics_override_speed = 1.0f;
408 float m_physics_override_jump = 1.0f;
409 float m_physics_override_gravity = 1.0f;
410 bool m_physics_override_sneak = true;
411 bool m_physics_override_sneak_glitch = false;
412 bool m_physics_override_new_move = true;
413 bool m_physics_override_sent = false;