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 "serverobject.h"
24 #include "itemgroup.h"
25 #include "object_properties.h"
26 #include "constants.h"
28 class UnitSAO: public ServerActiveObject
31 UnitSAO(ServerEnvironment *env, v3f pos):
32 ServerActiveObject(env, pos),
36 virtual void setYaw(const float yaw) { m_yaw = yaw; }
37 float getYaw() const { return m_yaw; };
38 f32 getRadYaw() const { return m_yaw * core::DEGTORAD; }
40 f32 getRadYawDep() const { return (m_yaw + 90.) * core::DEGTORAD; }
42 s16 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; }
51 LuaEntitySAO needs some internals exposed.
54 class LuaEntitySAO : public UnitSAO
57 LuaEntitySAO(ServerEnvironment *env, v3f pos,
58 const std::string &name, const std::string &state);
60 ActiveObjectType getType() const
61 { return ACTIVEOBJECT_TYPE_LUAENTITY; }
62 ActiveObjectType getSendType() const
63 { return ACTIVEOBJECT_TYPE_GENERIC; }
64 virtual void addedToEnvironment(u32 dtime_s);
65 static ServerActiveObject* create(ServerEnvironment *env, v3f pos,
66 const std::string &data);
68 void step(float dtime, bool send_recommended);
69 std::string getClientInitializationData(u16 protocol_version);
70 std::string getStaticData();
72 const ToolCapabilities *toolcap=NULL,
73 ServerActiveObject *puncher=NULL,
74 float time_from_last_punch=1000000);
75 void rightClick(ServerActiveObject *clicker);
76 void setPos(const v3f &pos);
77 void moveTo(v3f pos, bool continuous);
78 float getMinimumSavedMovement();
79 std::string getDescription();
82 void setArmorGroups(const ItemGroupList &armor_groups);
83 ItemGroupList getArmorGroups();
84 void setAnimation(v2f frame_range, float frame_speed, float frame_blend, bool frame_loop);
85 void getAnimation(v2f *frame_range, float *frame_speed, float *frame_blend, bool *frame_loop);
86 void setBonePosition(const std::string &bone, v3f position, v3f rotation);
87 void getBonePosition(const std::string &bone, v3f *position, v3f *rotation);
88 void setAttachment(int parent_id, const std::string &bone, v3f position, v3f rotation);
89 void getAttachment(int *parent_id, std::string *bone, v3f *position, v3f *rotation);
90 void addAttachmentChild(int child_id);
91 void removeAttachmentChild(int child_id);
92 UNORDERED_SET<int> getAttachmentChildIds();
93 ObjectProperties* accessObjectProperties();
94 void notifyObjectPropertiesModified();
95 /* LuaEntitySAO-specific */
96 void setVelocity(v3f velocity);
98 void setAcceleration(v3f acceleration);
99 v3f getAcceleration();
101 void setTextureMod(const std::string &mod);
102 void setSprite(v2s16 p, int num_frames, float framelength,
103 bool select_horiz_by_yawpitch);
104 std::string getName();
105 bool getCollisionBox(aabb3f *toset);
106 bool collideWithObjects();
108 std::string getPropertyPacket();
109 void sendPosition(bool do_interpolate, bool is_movement_end);
111 std::string m_init_name;
112 std::string m_init_state;
114 struct ObjectProperties m_prop;
119 ItemGroupList m_armor_groups;
121 bool m_properties_sent;
122 float m_last_sent_yaw;
123 v3f m_last_sent_position;
124 v3f m_last_sent_velocity;
125 float m_last_sent_position_timer;
126 float m_last_sent_move_precision;
127 bool m_armor_groups_sent;
129 v2f m_animation_range;
130 float m_animation_speed;
131 float m_animation_blend;
132 bool m_animation_loop;
133 bool m_animation_sent;
135 UNORDERED_MAP<std::string, core::vector2d<v3f> > m_bone_position;
136 bool m_bone_position_sent;
138 int m_attachment_parent_id;
139 UNORDERED_SET<int> m_attachment_child_ids;
140 std::string m_attachment_bone;
141 v3f m_attachment_position;
142 v3f m_attachment_rotation;
143 bool m_attachment_sent;
147 PlayerSAO needs some internals exposed.
155 LagPool(): m_pool(15), m_max(15)
157 void setMax(float new_max)
163 void add(float dtime)
169 bool grab(float dtime)
173 if(m_pool + dtime > m_max)
182 class PlayerSAO : public UnitSAO
185 PlayerSAO(ServerEnvironment *env_, u16 peer_id_, bool is_singleplayer);
187 ActiveObjectType getType() const
188 { return ACTIVEOBJECT_TYPE_PLAYER; }
189 ActiveObjectType getSendType() const
190 { return ACTIVEOBJECT_TYPE_GENERIC; }
191 std::string getDescription();
194 Active object <-> environment interface
197 void addedToEnvironment(u32 dtime_s);
198 void removingFromEnvironment();
199 bool isStaticAllowed() const;
200 std::string getClientInitializationData(u16 protocol_version);
201 std::string getStaticData();
203 void step(float dtime, bool send_recommended);
204 void setBasePosition(const v3f &position);
205 void setPos(const v3f &pos);
206 void moveTo(v3f pos, bool continuous);
207 void setYaw(const float yaw);
208 // Data should not be sent at player initialization
209 void setYawAndSend(const float yaw);
210 void setPitch(const float pitch);
211 // Data should not be sent at player initialization
212 void setPitchAndSend(const float pitch);
213 f32 getPitch() const { return m_pitch; }
214 f32 getRadPitch() const { return m_pitch * core::DEGTORAD; }
216 f32 getRadPitchDep() const { return -1.0 * m_pitch * core::DEGTORAD; }
217 void setFov(const float pitch);
218 f32 getFov() const { return m_fov; }
219 void setWantedRange(const s16 range);
220 s16 getWantedRange() const { return m_wanted_range; }
223 Interaction interface
227 const ToolCapabilities *toolcap,
228 ServerActiveObject *puncher,
229 float time_from_last_punch);
230 void rightClick(ServerActiveObject *clicker);
232 void setHPRaw(s16 hp) { m_hp = hp; }
234 u16 getBreath() const { return m_breath; }
235 void setBreath(const u16 breath);
236 void setArmorGroups(const ItemGroupList &armor_groups);
237 ItemGroupList getArmorGroups();
238 void setAnimation(v2f frame_range, float frame_speed, float frame_blend, bool frame_loop);
239 void getAnimation(v2f *frame_range, float *frame_speed, float *frame_blend, bool *frame_loop);
240 void setBonePosition(const std::string &bone, v3f position, v3f rotation);
241 void getBonePosition(const std::string &bone, v3f *position, v3f *rotation);
242 void setAttachment(int parent_id, const std::string &bone, v3f position, v3f rotation);
243 void getAttachment(int *parent_id, std::string *bone, v3f *position, v3f *rotation);
244 void addAttachmentChild(int child_id);
245 void removeAttachmentChild(int child_id);
246 UNORDERED_SET<int> getAttachmentChildIds();
247 ObjectProperties* accessObjectProperties();
248 void notifyObjectPropertiesModified();
254 Inventory* getInventory();
255 const Inventory* getInventory() const;
256 InventoryLocation getInventoryLocation() const;
257 std::string getWieldList() const;
258 ItemStack getWieldedItem() const;
259 bool setWieldedItem(const ItemStack &item);
260 int getWieldIndex() const;
261 void setWieldIndex(int i);
269 RemotePlayer *getPlayer() { return m_player; }
270 u16 getPeerID() const { return m_peer_id; }
274 v3f getLastGoodPosition() const
276 return m_last_good_position;
278 float resetTimeFromLastPunch()
280 float r = m_time_from_last_punch;
281 m_time_from_last_punch = 0.0;
284 void noCheatDigStart(v3s16 p)
286 m_nocheat_dig_pos = p;
287 m_nocheat_dig_time = 0;
289 v3s16 getNoCheatDigPos()
291 return m_nocheat_dig_pos;
293 float getNoCheatDigTime()
295 return m_nocheat_dig_time;
299 m_nocheat_dig_pos = v3s16(32767, 32767, 32767);
301 LagPool& getDigPool()
305 // Returns true if cheated
306 bool checkMovementCheat();
310 void updatePrivileges(const std::set<std::string> &privs,
311 bool is_singleplayer)
314 m_is_singleplayer = is_singleplayer;
317 bool getCollisionBox(aabb3f *toset);
318 bool collideWithObjects();
320 void initialize(RemotePlayer *player, const std::set<std::string> &privs);
322 v3f getEyePosition() const { return m_base_position + getEyeOffset(); }
323 v3f getEyeOffset() const { return v3f(0, BS * 1.625f, 0); }
326 std::string getPropertyPacket();
327 void unlinkPlayerSessionAndSave();
329 RemotePlayer *m_player;
331 Inventory *m_inventory;
337 v3f m_last_good_position;
338 float m_time_from_last_punch;
339 v3s16 m_nocheat_dig_pos;
340 float m_nocheat_dig_time;
343 bool m_position_not_sent;
344 ItemGroupList m_armor_groups;
345 bool m_armor_groups_sent;
347 bool m_properties_sent;
348 struct ObjectProperties m_prop;
349 // Cached privileges for enforcement
350 std::set<std::string> m_privs;
351 bool m_is_singleplayer;
353 v2f m_animation_range;
354 float m_animation_speed;
355 float m_animation_blend;
356 bool m_animation_loop;
357 bool m_animation_sent;
359 // Stores position and rotation for each bone name
360 UNORDERED_MAP<std::string, core::vector2d<v3f> > m_bone_position;
361 bool m_bone_position_sent;
363 int m_attachment_parent_id;
364 UNORDERED_SET<int> m_attachment_child_ids;
365 std::string m_attachment_bone;
366 v3f m_attachment_position;
367 v3f m_attachment_rotation;
368 bool m_attachment_sent;
374 float m_physics_override_speed;
375 float m_physics_override_jump;
376 float m_physics_override_gravity;
377 bool m_physics_override_sneak;
378 bool m_physics_override_sneak_glitch;
379 bool m_physics_override_sent;