3 Copyright (C) 2010-2011 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 "content_object.h"
25 #include "itemgroup.h"
27 #include "object_properties.h"
29 ServerActiveObject* createItemSAO(ServerEnvironment *env, v3f pos,
30 const std::string itemstring);
33 LuaEntitySAO needs some internals exposed.
36 class LuaEntitySAO : public ServerActiveObject
39 LuaEntitySAO(ServerEnvironment *env, v3f pos,
40 const std::string &name, const std::string &state);
43 { return ACTIVEOBJECT_TYPE_LUAENTITY; }
44 u8 getSendType() const
45 { return ACTIVEOBJECT_TYPE_GENERIC; }
46 virtual void addedToEnvironment(u32 dtime_s);
47 static ServerActiveObject* create(ServerEnvironment *env, v3f pos,
48 const std::string &data);
49 void step(float dtime, bool send_recommended);
50 std::string getClientInitializationData();
51 std::string getStaticData();
53 const ToolCapabilities *toolcap=NULL,
54 ServerActiveObject *puncher=NULL,
55 float time_from_last_punch=1000000);
56 void rightClick(ServerActiveObject *clicker);
58 void moveTo(v3f pos, bool continuous);
59 float getMinimumSavedMovement();
60 std::string getDescription();
63 void setArmorGroups(const ItemGroupList &armor_groups);
64 ObjectProperties* accessObjectProperties();
65 void notifyObjectPropertiesModified();
66 /* LuaEntitySAO-specific */
67 void setVelocity(v3f velocity);
69 void setAcceleration(v3f acceleration);
70 v3f getAcceleration();
71 void setYaw(float yaw);
73 void setTextureMod(const std::string &mod);
74 void setSprite(v2s16 p, int num_frames, float framelength,
75 bool select_horiz_by_yawpitch);
76 void setAnimations(int frame_start, int frame_end, float frame_speed, float frame_blend);
77 std::string getName();
79 std::string getPropertyPacket();
80 void sendPosition(bool do_interpolate, bool is_movement_end);
82 std::string m_init_name;
83 std::string m_init_state;
85 struct ObjectProperties m_prop;
91 ItemGroupList m_armor_groups;
93 bool m_properties_sent;
94 float m_last_sent_yaw;
95 v3f m_last_sent_position;
96 v3f m_last_sent_velocity;
97 float m_last_sent_position_timer;
98 float m_last_sent_move_precision;
99 bool m_armor_groups_sent;
103 PlayerSAO needs some internals exposed.
106 class PlayerSAO : public ServerActiveObject
109 PlayerSAO(ServerEnvironment *env_, Player *player_, u16 peer_id_,
110 const std::set<std::string> &privs, bool is_singleplayer);
113 { return ACTIVEOBJECT_TYPE_PLAYER; }
114 u8 getSendType() const
115 { return ACTIVEOBJECT_TYPE_GENERIC; }
116 std::string getDescription();
119 Active object <-> environment interface
122 void addedToEnvironment(u32 dtime_s);
123 void removingFromEnvironment();
124 bool isStaticAllowed() const;
125 bool unlimitedTransferDistance() const;
126 std::string getClientInitializationData();
127 std::string getStaticData();
128 void step(float dtime, bool send_recommended);
129 void setBasePosition(const v3f &position);
130 void setPos(v3f pos);
131 void moveTo(v3f pos, bool continuous);
134 Interaction interface
138 const ToolCapabilities *toolcap,
139 ServerActiveObject *puncher,
140 float time_from_last_punch);
141 void rightClick(ServerActiveObject *clicker);
145 void setArmorGroups(const ItemGroupList &armor_groups);
146 ObjectProperties* accessObjectProperties();
147 void notifyObjectPropertiesModified();
153 Inventory* getInventory();
154 const Inventory* getInventory() const;
155 InventoryLocation getInventoryLocation() const;
156 void setInventoryModified();
157 std::string getWieldList() const;
158 int getWieldIndex() const;
159 void setWieldIndex(int i);
171 u16 getPeerID() const
178 v3f getLastGoodPosition() const
180 return m_last_good_position;
182 float resetTimeFromLastPunch()
184 float r = m_time_from_last_punch;
185 m_time_from_last_punch = 0.0;
188 void noCheatDigStart(v3s16 p)
190 m_nocheat_dig_pos = p;
191 m_nocheat_dig_time = 0;
193 v3s16 getNoCheatDigPos()
195 return m_nocheat_dig_pos;
197 float getNoCheatDigTime()
199 return m_nocheat_dig_time;
203 m_nocheat_dig_pos = v3s16(32767, 32767, 32767);
208 void updatePrivileges(const std::set<std::string> &privs,
209 bool is_singleplayer)
212 m_is_singleplayer = is_singleplayer;
216 std::string getPropertyPacket();
220 Inventory *m_inventory;
223 v3f m_last_good_position;
224 float m_last_good_position_age;
225 float m_time_from_last_punch;
226 v3s16 m_nocheat_dig_pos;
227 float m_nocheat_dig_time;
230 bool m_position_not_sent;
231 ItemGroupList m_armor_groups;
232 bool m_armor_groups_sent;
233 bool m_properties_sent;
234 struct ObjectProperties m_prop;
235 // Cached privileges for enforcement
236 std::set<std::string> m_privs;
237 bool m_is_singleplayer;
240 // Some flags used by Server
242 bool m_inventory_not_sent;
244 bool m_wielded_item_not_sent;