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 <unordered_set>
23 #include "irrlichttypes_bloated.h"
24 #include "activeobject.h"
25 #include "inventorymanager.h"
26 #include "itemgroup.h"
27 #include "util/container.h"
34 * Server environment adds an active object, which gets the id 1
35 * The active object list is scanned for each client once in a while,
36 and it finds out what objects have been added that are not known
37 by the client yet. This scan is initiated by the Server class and
38 the result ends up directly to the server.
39 * A network packet is created with the info and sent to the client.
40 * Environment converts objects to static data and static data to
41 objects, based on how close players are to them.
45 class ServerEnvironment;
47 struct ToolCapabilities;
48 struct ObjectProperties;
49 struct PlayerHPChangeReason;
51 class ServerActiveObject : public ActiveObject
55 NOTE: m_env can be NULL, but step() isn't called if it is.
56 Prototypes are used that way.
58 ServerActiveObject(ServerEnvironment *env, v3f pos);
59 virtual ~ServerActiveObject() = default;
61 virtual ActiveObjectType getSendType() const
64 // Called after id has been set and has been inserted in environment
65 virtual void addedToEnvironment(u32 dtime_s){};
66 // Called before removing from environment
67 virtual void removingFromEnvironment(){};
68 // Returns true if object's deletion is the job of the
70 virtual bool environmentDeletes() const
73 // Safely mark the object for removal or deactivation
74 void markForRemoval();
75 void markForDeactivation();
77 // Create a certain type of ServerActiveObject
78 static ServerActiveObject* create(ActiveObjectType type,
79 ServerEnvironment *env, u16 id, v3f pos,
80 const std::string &data);
83 Some simple getters/setters
85 v3f getBasePosition() const { return m_base_position; }
86 void setBasePosition(v3f pos){ m_base_position = pos; }
87 ServerEnvironment* getEnv(){ return m_env; }
90 Some more dynamic interface
93 virtual void setPos(const v3f &pos)
94 { setBasePosition(pos); }
95 // continuous: if true, object does not stop immediately at pos
96 virtual void moveTo(v3f pos, bool continuous)
97 { setBasePosition(pos); }
98 // If object has moved less than this and data has not changed,
99 // saving to disk may be omitted
100 virtual float getMinimumSavedMovement();
102 virtual std::string getDescription(){return "SAO";}
106 Messages added to messages are sent to client over network.
109 True at around 5-10 times a second, same for all objects.
110 This is used to let objects send most of the data at the
111 same time so that the data can be combined in a single
114 virtual void step(float dtime, bool send_recommended){}
117 The return value of this is passed to the client-side object
120 virtual std::string getClientInitializationData(u16 protocol_version) {return "";}
123 The return value of this is passed to the server-side object
124 when it is created (converted from static to active - actually
125 the data is the static form)
127 virtual void getStaticData(std::string *result) const
129 assert(isStaticAllowed());
134 Return false in here to never save and instead remove object
135 on unload. getStaticData() will not be called in that case.
137 virtual bool isStaticAllowed() const
141 Return false here to never unload the object.
142 isStaticAllowed && shouldUnload -> unload when out of active block range
143 !isStaticAllowed && shouldUnload -> unload when block is unloaded
145 virtual bool shouldUnload() const
148 // Returns added tool wear
149 virtual u32 punch(v3f dir,
150 const ToolCapabilities *toolcap = nullptr,
151 ServerActiveObject *puncher = nullptr,
152 float time_from_last_punch = 1000000.0f,
153 u16 initial_wear = 0)
155 virtual void rightClick(ServerActiveObject *clicker)
157 virtual void setHP(s32 hp, const PlayerHPChangeReason &reason)
159 virtual u16 getHP() const
162 virtual void setArmorGroups(const ItemGroupList &armor_groups)
164 virtual const ItemGroupList &getArmorGroups() const
165 { static ItemGroupList rv; return rv; }
166 virtual void setAnimation(v2f frames, float frame_speed, float frame_blend, bool frame_loop)
168 virtual void getAnimation(v2f *frames, float *frame_speed, float *frame_blend, bool *frame_loop)
170 virtual void setAnimationSpeed(float frame_speed)
172 virtual void setBonePosition(const std::string &bone, v3f position, v3f rotation)
174 virtual void getBonePosition(const std::string &bone, v3f *position, v3f *lotation)
176 virtual const std::unordered_set<int> &getAttachmentChildIds() const
177 { static std::unordered_set<int> rv; return rv; }
178 virtual ServerActiveObject *getParent() const { return nullptr; }
179 virtual ObjectProperties* accessObjectProperties()
181 virtual void notifyObjectPropertiesModified()
184 // Inventory and wielded item
185 virtual Inventory *getInventory() const
187 virtual InventoryLocation getInventoryLocation() const
188 { return InventoryLocation(); }
189 virtual void setInventoryModified()
191 virtual std::string getWieldList() const
193 virtual u16 getWieldIndex() const
195 virtual ItemStack getWieldedItem(ItemStack *selected,
196 ItemStack *hand = nullptr) const;
197 virtual bool setWieldedItem(const ItemStack &item);
198 inline void attachParticleSpawner(u32 id)
200 m_attached_particle_spawners.insert(id);
202 inline void detachParticleSpawner(u32 id)
204 m_attached_particle_spawners.erase(id);
207 std::string generateUpdateInfantCommand(u16 infant_id, u16 protocol_version);
209 void dumpAOMessagesToQueue(std::queue<ActiveObjectMessage> &queue);
212 Number of players which know about this object. Object won't be
213 deleted until this is 0 to keep the id preserved for the right
216 u16 m_known_by_count = 0;
219 A getter that unifies the above to answer the question:
220 "Can the environment still interact with this object?"
222 inline bool isGone() const
223 { return m_pending_removal || m_pending_deactivation; }
225 inline bool isPendingRemoval() const
226 { return m_pending_removal; }
229 Whether the object's static data has been stored to a block
231 bool m_static_exists = false;
233 The block from which the object was loaded from, and in which
234 a copy of the static data resides.
236 v3s16 m_static_block = v3s16(1337,1337,1337);
239 virtual void onMarkedForDeactivation() {}
240 virtual void onMarkedForRemoval() {}
242 virtual void onAttach(int parent_id) {}
243 virtual void onDetach(int parent_id) {}
245 ServerEnvironment *m_env;
247 std::unordered_set<u32> m_attached_particle_spawners;
250 Same purpose as m_pending_removal but for deactivation.
251 deactvation = save static data in block, remove active object
253 If this is set alongside with m_pending_removal, removal takes
255 Note: Do not assign this directly, use markForDeactivation() instead.
257 bool m_pending_deactivation = false;
260 - Whether this object is to be removed when nobody knows about
262 - Removal is delayed to preserve the id for the time during which
263 it could be confused to some other object by some client.
264 - This is usually set to true by the step() method when the object wants
265 to be deleted but can be set by anything else too.
266 Note: Do not assign this directly, use markForRemoval() instead.
268 bool m_pending_removal = false;
271 Queue of messages to be sent to the client
273 std::queue<ActiveObjectMessage> m_messages_out;