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 General Public License as published by
7 the Free Software Foundation; either version 2 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 General Public License for more details.
15 You should have received a copy of the GNU 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 SERVEROBJECT_HEADER
21 #define SERVEROBJECT_HEADER
23 #include "common_irrlicht.h"
24 #include "activeobject.h"
32 * Server environment adds an active object, which gets the id 1
33 * The active object list is scanned for each client once in a while,
34 and it finds out what objects have been added that are not known
35 by the client yet. This scan is initiated by the Server class and
36 the result ends up directly to the server.
37 * A network packet is created with the info and sent to the client.
38 * Environment converts objects to static data and static data to
39 objects, based on how close players are to them.
43 class ServerEnvironment;
46 class ServerActiveObject : public ActiveObject
50 NOTE: m_env can be NULL, but step() isn't called if it is.
51 Prototypes are used that way.
53 ServerActiveObject(ServerEnvironment *env, u16 id, v3f pos);
54 virtual ~ServerActiveObject();
56 // Create a certain type of ServerActiveObject
57 static ServerActiveObject* create(u8 type,
58 ServerEnvironment *env, u16 id, v3f pos,
59 const std::string &data);
62 Some simple getters/setters
65 {return m_base_position;}
66 void setBasePosition(v3f pos)
67 {m_base_position = pos;}
68 ServerEnvironment* getEnv()
73 Messages added to messages are sent to client over network.
76 True at around 5-10 times a second, same for all objects.
77 This is used to let objects send most of the data at the
78 same time so that the data can be combined in a single
81 virtual void step(float dtime, Queue<ActiveObjectMessage> &messages,
82 bool send_recommended){}
85 The return value of this is passed to the client-side object
88 virtual std::string getClientInitializationData(){return "";}
91 The return value of this is passed to the server-side object
92 when it is created (converted from static to active - actually
93 the data is the static form)
95 virtual std::string getStaticData(){return "";}
98 Item that the player gets when this object is picked up.
99 If NULL, object cannot be picked up.
101 virtual InventoryItem* createPickedUpItem(){return NULL;}
104 If the object doesn't return an item, this will be called.
105 Return value is tool wear.
107 virtual u16 punch(const std::string &toolname){return 0;}
110 Number of players which know about this object. Object won't be
111 deleted until this is 0 to keep the id preserved for the right
114 u16 m_known_by_count;
117 - Whether this object is to be removed when nobody knows about
119 - Removal is delayed to preserve the id for the time during which
120 it could be confused to some other object by some client.
121 - This is set to true by the step() method when the object wants
123 - This can be set to true by anything else too.
128 This is set to true when a block should be removed from the active
129 object list but couldn't be removed because the id has to be
130 reserved for some client.
132 The environment checks this periodically. If this is true and also
133 m_known_by_count is true,
135 bool m_pending_deactivation;
138 Whether the object's static data has been stored to a block
140 bool m_static_exists;
142 The block from which the object was loaded from, and in which
143 a copy of the static data resides.
145 v3s16 m_static_block;
148 // Used for creating objects based on type
149 typedef ServerActiveObject* (*Factory)
150 (ServerEnvironment *env, u16 id, v3f pos,
151 const std::string &data);
152 static void registerType(u16 type, Factory f);
154 ServerEnvironment *m_env;
158 // Used for creating objects based on type
159 static core::map<u16, Factory> m_types;
162 class TestSAO : public ServerActiveObject
165 TestSAO(ServerEnvironment *env, u16 id, v3f pos);
167 {return ACTIVEOBJECT_TYPE_TEST;}
168 static ServerActiveObject* create(ServerEnvironment *env, u16 id, v3f pos,
169 const std::string &data);
170 void step(float dtime, Queue<ActiveObjectMessage> &messages,
171 bool send_recommended);
177 class ItemSAO : public ServerActiveObject
180 ItemSAO(ServerEnvironment *env, u16 id, v3f pos,
181 const std::string inventorystring);
183 {return ACTIVEOBJECT_TYPE_ITEM;}
184 static ServerActiveObject* create(ServerEnvironment *env, u16 id, v3f pos,
185 const std::string &data);
186 void step(float dtime, Queue<ActiveObjectMessage> &messages,
187 bool send_recommended);
188 std::string getClientInitializationData();
189 std::string getStaticData();
190 InventoryItem* createInventoryItem();
191 InventoryItem* createPickedUpItem(){return createInventoryItem();}
193 std::string m_inventorystring;
195 v3f m_last_sent_position;
196 IntervalLimiter m_move_interval;
199 class RatSAO : public ServerActiveObject
202 RatSAO(ServerEnvironment *env, u16 id, v3f pos);
204 {return ACTIVEOBJECT_TYPE_RAT;}
205 static ServerActiveObject* create(ServerEnvironment *env, u16 id, v3f pos,
206 const std::string &data);
207 void step(float dtime, Queue<ActiveObjectMessage> &messages,
208 bool send_recommended);
209 std::string getClientInitializationData();
210 std::string getStaticData();
211 InventoryItem* createPickedUpItem();
214 IntervalLimiter m_inactive_interval;
217 v3f m_last_sent_position;
222 bool m_touching_ground;
225 class Oerkki1SAO : public ServerActiveObject
228 Oerkki1SAO(ServerEnvironment *env, u16 id, v3f pos);
230 {return ACTIVEOBJECT_TYPE_OERKKI1;}
231 static ServerActiveObject* create(ServerEnvironment *env, u16 id, v3f pos,
232 const std::string &data);
233 void step(float dtime, Queue<ActiveObjectMessage> &messages,
234 bool send_recommended);
235 std::string getClientInitializationData();
236 std::string getStaticData();
237 InventoryItem* createPickedUpItem(){return NULL;}
238 u16 punch(const std::string &toolname);
241 IntervalLimiter m_inactive_interval;
244 v3f m_last_sent_position;
249 bool m_touching_ground;