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 // Create a certain type of ServerActiveObject
74 static ServerActiveObject* create(ActiveObjectType type,
75 ServerEnvironment *env, u16 id, v3f pos,
76 const std::string &data);
79 Some simple getters/setters
81 v3f getBasePosition() const { return m_base_position; }
82 void setBasePosition(v3f pos){ m_base_position = pos; }
83 ServerEnvironment* getEnv(){ return m_env; }
86 Some more dynamic interface
89 virtual void setPos(const v3f &pos)
90 { setBasePosition(pos); }
91 // continuous: if true, object does not stop immediately at pos
92 virtual void moveTo(v3f pos, bool continuous)
93 { setBasePosition(pos); }
94 // If object has moved less than this and data has not changed,
95 // saving to disk may be omitted
96 virtual float getMinimumSavedMovement();
98 virtual std::string getDescription(){return "SAO";}
102 Messages added to messages are sent to client over network.
105 True at around 5-10 times a second, same for all objects.
106 This is used to let objects send most of the data at the
107 same time so that the data can be combined in a single
110 virtual void step(float dtime, bool send_recommended){}
113 The return value of this is passed to the client-side object
116 virtual std::string getClientInitializationData(u16 protocol_version){return "";}
119 The return value of this is passed to the server-side object
120 when it is created (converted from static to active - actually
121 the data is the static form)
123 virtual void getStaticData(std::string *result) const
125 assert(isStaticAllowed());
129 Return false in here to never save and instead remove object
130 on unload. getStaticData() will not be called in that case.
132 virtual bool isStaticAllowed() const
136 virtual u16 punch(v3f dir,
137 const ToolCapabilities *toolcap = nullptr,
138 ServerActiveObject *puncher = nullptr,
139 float time_from_last_punch = 1000000.0f)
141 virtual void rightClick(ServerActiveObject *clicker)
143 virtual void setHP(s32 hp, const PlayerHPChangeReason &reason)
145 virtual u16 getHP() const
148 virtual void setArmorGroups(const ItemGroupList &armor_groups)
150 virtual const ItemGroupList &getArmorGroups() const
151 { static ItemGroupList rv; return rv; }
152 virtual void setPhysicsOverride(float physics_override_speed, float physics_override_jump, float physics_override_gravity)
154 virtual void setAnimation(v2f frames, float frame_speed, float frame_blend, bool frame_loop)
156 virtual void getAnimation(v2f *frames, float *frame_speed, float *frame_blend, bool *frame_loop)
158 virtual void setAnimationSpeed(float frame_speed)
160 virtual void setBonePosition(const std::string &bone, v3f position, v3f rotation)
162 virtual void getBonePosition(const std::string &bone, v3f *position, v3f *lotation)
164 virtual const std::unordered_set<int> &getAttachmentChildIds() const
165 { static std::unordered_set<int> rv; return rv; }
166 virtual ServerActiveObject *getParent() const { return nullptr; }
167 virtual ObjectProperties* accessObjectProperties()
169 virtual void notifyObjectPropertiesModified()
172 // Inventory and wielded item
173 virtual Inventory *getInventory() const
175 virtual InventoryLocation getInventoryLocation() const
176 { return InventoryLocation(); }
177 virtual void setInventoryModified()
179 virtual std::string getWieldList() const
181 virtual u16 getWieldIndex() const
183 virtual ItemStack getWieldedItem(ItemStack *selected,
184 ItemStack *hand = nullptr) const;
185 virtual bool setWieldedItem(const ItemStack &item);
186 inline void attachParticleSpawner(u32 id)
188 m_attached_particle_spawners.insert(id);
190 inline void detachParticleSpawner(u32 id)
192 m_attached_particle_spawners.erase(id);
197 Number of players which know about this object. Object won't be
198 deleted until this is 0 to keep the id preserved for the right
201 u16 m_known_by_count = 0;
204 - Whether this object is to be removed when nobody knows about
206 - Removal is delayed to preserve the id for the time during which
207 it could be confused to some other object by some client.
208 - This is usually set to true by the step() method when the object wants
209 to be deleted but can be set by anything else too.
211 bool m_pending_removal = false;
214 Same purpose as m_pending_removal but for deactivation.
215 deactvation = save static data in block, remove active object
217 If this is set alongside with m_pending_removal, removal takes
220 bool m_pending_deactivation = false;
223 A getter that unifies the above to answer the question:
224 "Can the environment still interact with this object?"
226 inline bool isGone() const
227 { return m_pending_removal || m_pending_deactivation; }
230 Whether the object's static data has been stored to a block
232 bool m_static_exists = false;
234 The block from which the object was loaded from, and in which
235 a copy of the static data resides.
237 v3s16 m_static_block = v3s16(1337,1337,1337);
240 Queue of messages to be sent to the client
242 std::queue<ActiveObjectMessage> m_messages_out;
245 virtual void onAttach(int parent_id) {}
246 virtual void onDetach(int parent_id) {}
248 // Used for creating objects based on type
249 typedef ServerActiveObject* (*Factory)
250 (ServerEnvironment *env, v3f pos,
251 const std::string &data);
252 static void registerType(u16 type, Factory f);
254 ServerEnvironment *m_env;
256 std::unordered_set<u32> m_attached_particle_spawners;
259 // Used for creating objects based on type
260 static std::map<u16, Factory> m_types;