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 "irrlichttypes.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;
47 class ServerActiveObject : public ActiveObject
51 NOTE: m_env can be NULL, but step() isn't called if it is.
52 Prototypes are used that way.
54 ServerActiveObject(ServerEnvironment *env, v3f pos);
55 virtual ~ServerActiveObject();
57 virtual void addedToEnvironment(u16 id);
59 // Create a certain type of ServerActiveObject
60 static ServerActiveObject* create(u8 type,
61 ServerEnvironment *env, u16 id, v3f pos,
62 const std::string &data);
65 Some simple getters/setters
67 v3f getBasePosition(){ return m_base_position; }
68 void setBasePosition(v3f pos){ m_base_position = pos; }
69 ServerEnvironment* getEnv(){ return m_env; }
72 Some more dynamic interface
74 virtual void setPos(v3f pos)
75 { setBasePosition(pos); }
76 // continuous: if true, object does not stop immediately at pos
77 virtual void moveTo(v3f pos, bool continuous)
78 { setBasePosition(pos); }
79 // If object has moved less than this and data has not changed,
80 // saving to disk may be omitted
81 virtual float getMinimumSavedMovement()
86 Messages added to messages are sent to client over network.
89 True at around 5-10 times a second, same for all objects.
90 This is used to let objects send most of the data at the
91 same time so that the data can be combined in a single
94 virtual void step(float dtime, bool send_recommended){}
97 The return value of this is passed to the client-side object
100 virtual std::string getClientInitializationData(){return "";}
103 The return value of this is passed to the server-side object
104 when it is created (converted from static to active - actually
105 the data is the static form)
107 virtual std::string getStaticData(){return "";}
110 Item that the player gets when this object is picked up.
111 If NULL, object cannot be picked up.
113 virtual InventoryItem* createPickedUpItem(){return NULL;}
116 If the object doesn't return an item, this will be called.
117 Return value is tool wear.
119 virtual u16 punch(const std::string &toolname, v3f dir,
120 const std::string &playername)
125 virtual void rightClick(Player *player){}
127 virtual bool isPeaceful(){return true;}
130 Number of players which know about this object. Object won't be
131 deleted until this is 0 to keep the id preserved for the right
134 u16 m_known_by_count;
137 - Whether this object is to be removed when nobody knows about
139 - Removal is delayed to preserve the id for the time during which
140 it could be confused to some other object by some client.
141 - This is set to true by the step() method when the object wants
143 - This can be set to true by anything else too.
148 This is set to true when a block should be removed from the active
149 object list but couldn't be removed because the id has to be
150 reserved for some client.
152 The environment checks this periodically. If this is true and also
153 m_known_by_count is true,
155 bool m_pending_deactivation;
158 Whether the object's static data has been stored to a block
160 bool m_static_exists;
162 The block from which the object was loaded from, and in which
163 a copy of the static data resides.
165 v3s16 m_static_block;
168 Queue of messages to be sent to the client
170 Queue<ActiveObjectMessage> m_messages_out;
173 // Used for creating objects based on type
174 typedef ServerActiveObject* (*Factory)
175 (ServerEnvironment *env, v3f pos,
176 const std::string &data);
177 static void registerType(u16 type, Factory f);
179 ServerEnvironment *m_env;
183 // Used for creating objects based on type
184 static core::map<u16, Factory> m_types;